network_insights_access_scopes

Creates, updates, deletes, gets or lists a network_insights_access_scopes resource.

Overview

Name	network_insights_access_scopes
Type	Resource
Id	aws.ec2.network_insights_access_scopes

Fields

The following fields are returned by SELECT queries:

describe_network_insights_access_scopes

Name	Datatype	Description
created_date	string	The creation date.
network_insights_access_scope_arn	string	The Amazon Resource Name (ARN) of the Network Access Scope.
network_insights_access_scope_id	string	The ID of the Network Access Scope.
tags	string	The tags.
updated_date	string	The last updated date.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_network_insights_access_scopes	select	region	NetworkInsightsAccessScopeId, Filter, MaxResults, DryRun, NextToken	Describes the specified Network Access Scopes.
create_network_insights_access_scope	insert	ClientToken, region	MatchPath, ExcludePath, TagSpecification, DryRun	Creates a Network Access Scope. Amazon Web Services Network Access Analyzer enables cloud networking and cloud operations teams to verify that their networks on Amazon Web Services conform to their network security and governance objectives. For more information, see the Amazon Web Services Network Access Analyzer Guide.
delete_network_insights_access_scope	delete	NetworkInsightsAccessScopeId, region	DryRun	Deletes the specified Network Access Scope.
delete_network_insights_access_scope_analysis	delete	NetworkInsightsAccessScopeAnalysisId, region	DryRun	Deletes the specified Network Access Scope analysis.
start_network_insights_access_scope_analysis	exec	NetworkInsightsAccessScopeId, ClientToken, region	DryRun, TagSpecification	Starts analyzing the specified Network Access Scope.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
ClientToken	string	Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
NetworkInsightsAccessScopeAnalysisId	string	The ID of the Network Access Scope analysis.
NetworkInsightsAccessScopeId	string	The ID of the Network Access Scope.
region	string	AWS region (default: us-east-1)
DryRun	boolean	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
ExcludePath	array	The paths to exclude.
Filter	array	There are no supported filters.
MatchPath	array	The paths to match.
MaxResults	integer	The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
NetworkInsightsAccessScopeId	array	The IDs of the Network Access Scopes.
NextToken	string	The token for the next page of results.
TagSpecification	array	The tags to apply.

SELECT examples

describe_network_insights_access_scopes

Describes the specified Network Access Scopes.

SELECT
created_date,
network_insights_access_scope_arn,
network_insights_access_scope_id,
tags,
updated_date
FROM aws.ec2.network_insights_access_scopes
WHERE region = '{{ region }}' -- required
AND NetworkInsightsAccessScopeId = '{{ NetworkInsightsAccessScopeId }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND DryRun = '{{ DryRun }}'
AND NextToken = '{{ NextToken }}'
;

INSERT examples

create_network_insights_access_scope

Creates a Network Access Scope. Amazon Web Services Network Access Analyzer enables cloud networking and cloud operations teams to verify that their networks on Amazon Web Services conform to their network security and governance objectives. For more information, see the Amazon Web Services Network Access Analyzer Guide.

INSERT INTO aws.ec2.network_insights_access_scopes (
ClientToken,
region,
MatchPath,
ExcludePath,
TagSpecification,
DryRun
)
SELECT 
'{{ ClientToken }}',
'{{ region }}',
'{{ MatchPath }}',
'{{ ExcludePath }}',
'{{ TagSpecification }}',
'{{ DryRun }}'
RETURNING
created_date,
network_insights_access_scope_arn,
network_insights_access_scope_id,
tags,
updated_date
;

Manifest

# Description fields are for documentation purposes
- name: network_insights_access_scopes
props:
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: Required parameter for the network_insights_access_scopes resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the network_insights_access_scopes resource.
  - name: MatchPath
    value: "{{ MatchPath }}"
    description: The paths to match.
    description: The paths to match.
  - name: ExcludePath
    value: "{{ ExcludePath }}"
    description: The paths to exclude.
    description: The paths to exclude.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags to apply.
    description: The tags to apply.
  - name: DryRun
    value: {{ DryRun }}
    description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
    description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

DELETE examples

delete_network_insights_access_scope

Deletes the specified Network Access Scope.

DELETE FROM aws.ec2.network_insights_access_scopes
WHERE NetworkInsightsAccessScopeId = '{{ NetworkInsightsAccessScopeId }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
;

delete_network_insights_access_scope_analysis

Deletes the specified Network Access Scope analysis.

DELETE FROM aws.ec2.network_insights_access_scopes
WHERE NetworkInsightsAccessScopeAnalysisId = '{{ NetworkInsightsAccessScopeAnalysisId }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
;

Lifecycle Methods

start_network_insights_access_scope_analysis

Starts analyzing the specified Network Access Scope.

EXEC aws.ec2.network_insights_access_scopes.start_network_insights_access_scope_analysis 
@NetworkInsightsAccessScopeId='{{ NetworkInsightsAccessScopeId }}' --required, 
@ClientToken='{{ ClientToken }}' --required, 
@region='{{ region }}' --required, 
@DryRun={{ DryRun }}, 
@TagSpecification='{{ TagSpecification }}'
;