Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ec2 ]

create-network-insights-access-scope¶

Description¶

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 .

Synopsis¶

  create-network-insights-access-scope
[--match-paths <value>]
[--exclude-paths <value>]
[--client-token <value>]
[--tag-specifications <value>]
[--dry-run | --no-dry-run]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--match-paths (list)

The paths to match.

(structure)

Describes a path.

Source -> (structure)

The source.

PacketHeaderStatement -> (structure)

The packet header statement.

SourceAddresses -> (list)

The source addresses.

(string)

DestinationAddresses -> (list)

The destination addresses.

(string)

SourcePorts -> (list)

The source ports.

(string)

DestinationPorts -> (list)

The destination ports.

(string)

SourcePrefixLists -> (list)

The source prefix lists.

(string)

DestinationPrefixLists -> (list)

The destination prefix lists.

(string)

Protocols -> (list)

The protocols.

(string)

ResourceStatement -> (structure)

The resource statement.

Resources -> (list)

The resources.

(string)

ResourceTypes -> (list)

The resource types.

(string)

Destination -> (structure)

The destination.

PacketHeaderStatement -> (structure)

The packet header statement.

SourceAddresses -> (list)

The source addresses.

(string)

DestinationAddresses -> (list)

The destination addresses.

(string)

SourcePorts -> (list)

The source ports.

(string)

DestinationPorts -> (list)

The destination ports.

(string)

SourcePrefixLists -> (list)

The source prefix lists.

(string)

DestinationPrefixLists -> (list)

The destination prefix lists.

(string)

Protocols -> (list)

The protocols.

(string)

ResourceStatement -> (structure)

The resource statement.

Resources -> (list)

The resources.

(string)

ResourceTypes -> (list)

The resource types.

(string)

ThroughResources -> (list)

The through resources.

(structure)

Describes a through resource statement.

ResourceStatement -> (structure)

The resource statement.

Resources -> (list)

The resources.

(string)

ResourceTypes -> (list)

The resource types.

(string)

JSON Syntax:

[
  {
    "Source": {
      "PacketHeaderStatement": {
        "SourceAddresses": ["string", ...],
        "DestinationAddresses": ["string", ...],
        "SourcePorts": ["string", ...],
        "DestinationPorts": ["string", ...],
        "SourcePrefixLists": ["string", ...],
        "DestinationPrefixLists": ["string", ...],
        "Protocols": ["tcp"|"udp", ...]
      },
      "ResourceStatement": {
        "Resources": ["string", ...],
        "ResourceTypes": ["string", ...]
      }
    },
    "Destination": {
      "PacketHeaderStatement": {
        "SourceAddresses": ["string", ...],
        "DestinationAddresses": ["string", ...],
        "SourcePorts": ["string", ...],
        "DestinationPorts": ["string", ...],
        "SourcePrefixLists": ["string", ...],
        "DestinationPrefixLists": ["string", ...],
        "Protocols": ["tcp"|"udp", ...]
      },
      "ResourceStatement": {
        "Resources": ["string", ...],
        "ResourceTypes": ["string", ...]
      }
    },
    "ThroughResources": [
      {
        "ResourceStatement": {
          "Resources": ["string", ...],
          "ResourceTypes": ["string", ...]
        }
      }
      ...
    ]
  }
  ...
]

--exclude-paths (list)

The paths to exclude.

(structure)

Describes a path.

Source -> (structure)

The source.

PacketHeaderStatement -> (structure)

The packet header statement.

SourceAddresses -> (list)

The source addresses.

(string)

DestinationAddresses -> (list)

The destination addresses.

(string)

SourcePorts -> (list)

The source ports.

(string)

DestinationPorts -> (list)

The destination ports.

(string)

SourcePrefixLists -> (list)

The source prefix lists.

(string)

DestinationPrefixLists -> (list)

The destination prefix lists.

(string)

Protocols -> (list)

The protocols.

(string)

ResourceStatement -> (structure)

The resource statement.

Resources -> (list)

The resources.

(string)

ResourceTypes -> (list)

The resource types.

(string)

Destination -> (structure)

The destination.

PacketHeaderStatement -> (structure)

The packet header statement.

SourceAddresses -> (list)

The source addresses.

(string)

DestinationAddresses -> (list)

The destination addresses.

(string)

SourcePorts -> (list)

The source ports.

(string)

DestinationPorts -> (list)

The destination ports.

(string)

SourcePrefixLists -> (list)

The source prefix lists.

(string)

DestinationPrefixLists -> (list)

The destination prefix lists.

(string)

Protocols -> (list)

The protocols.

(string)

ResourceStatement -> (structure)

The resource statement.

Resources -> (list)

The resources.

(string)

ResourceTypes -> (list)

The resource types.

(string)

ThroughResources -> (list)

The through resources.

(structure)

Describes a through resource statement.

ResourceStatement -> (structure)

The resource statement.

Resources -> (list)

The resources.

(string)

ResourceTypes -> (list)

The resource types.

(string)

JSON Syntax:

[
  {
    "Source": {
      "PacketHeaderStatement": {
        "SourceAddresses": ["string", ...],
        "DestinationAddresses": ["string", ...],
        "SourcePorts": ["string", ...],
        "DestinationPorts": ["string", ...],
        "SourcePrefixLists": ["string", ...],
        "DestinationPrefixLists": ["string", ...],
        "Protocols": ["tcp"|"udp", ...]
      },
      "ResourceStatement": {
        "Resources": ["string", ...],
        "ResourceTypes": ["string", ...]
      }
    },
    "Destination": {
      "PacketHeaderStatement": {
        "SourceAddresses": ["string", ...],
        "DestinationAddresses": ["string", ...],
        "SourcePorts": ["string", ...],
        "DestinationPorts": ["string", ...],
        "SourcePrefixLists": ["string", ...],
        "DestinationPrefixLists": ["string", ...],
        "Protocols": ["tcp"|"udp", ...]
      },
      "ResourceStatement": {
        "Resources": ["string", ...],
        "ResourceTypes": ["string", ...]
      }
    },
    "ThroughResources": [
      {
        "ResourceStatement": {
          "Resources": ["string", ...],
          "ResourceTypes": ["string", ...]
        }
      }
      ...
    ]
  }
  ...
]

--client-token (string)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency .

--tag-specifications (list)

The tags to apply.

(structure)

The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.

Note
The Valid Values lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.

ResourceType -> (string)

The type of resource to tag on creation.

Tags -> (list)

The tags to apply to the resource.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Shorthand Syntax:

ResourceType=string,Tags=[{Key=string,Value=string},{Key=string,Value=string}] ...

JSON Syntax:

[
  {
    "ResourceType": "capacity-reservation"|"client-vpn-endpoint"|"customer-gateway"|"carrier-gateway"|"coip-pool"|"dedicated-host"|"dhcp-options"|"egress-only-internet-gateway"|"elastic-ip"|"elastic-gpu"|"export-image-task"|"export-instance-task"|"fleet"|"fpga-image"|"host-reservation"|"image"|"import-image-task"|"import-snapshot-task"|"instance"|"instance-event-window"|"internet-gateway"|"ipam"|"ipam-pool"|"ipam-scope"|"ipv4pool-ec2"|"ipv6pool-ec2"|"key-pair"|"launch-template"|"local-gateway"|"local-gateway-route-table"|"local-gateway-virtual-interface"|"local-gateway-virtual-interface-group"|"local-gateway-route-table-vpc-association"|"local-gateway-route-table-virtual-interface-group-association"|"natgateway"|"network-acl"|"network-interface"|"network-insights-analysis"|"network-insights-path"|"network-insights-access-scope"|"network-insights-access-scope-analysis"|"placement-group"|"prefix-list"|"replace-root-volume-task"|"reserved-instances"|"route-table"|"security-group"|"security-group-rule"|"snapshot"|"spot-fleet-request"|"spot-instances-request"|"subnet"|"subnet-cidr-reservation"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-connect-peer"|"transit-gateway-multicast-domain"|"transit-gateway-policy-table"|"transit-gateway-route-table"|"transit-gateway-route-table-announcement"|"volume"|"vpc"|"vpc-endpoint"|"vpc-endpoint-connection"|"vpc-endpoint-service"|"vpc-endpoint-service-permission"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log"|"capacity-reservation-fleet"|"traffic-mirror-filter-rule"|"vpc-endpoint-connection-device-type"|"verified-access-instance"|"verified-access-group"|"verified-access-endpoint"|"verified-access-policy"|"verified-access-trust-provider"|"vpn-connection-device-type"|"vpc-block-public-access-exclusion"|"ipam-resource-discovery"|"ipam-resource-discovery-association"|"instance-connect-endpoint"|"ipam-external-resource-verification-token",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ]
  }
  ...
]

--dry-run | --no-dry-run (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 .

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To create a Network Access Scope

The following create-network-insights-access-scope example creates a Network Access Scope.

aws ec2 create-network-insights-access-scope \
    --cli-input-json file://access-scope-file.json

Contents of access-scope-file.json:

{
    "MatchPaths": [
        {
            "Source": {
                "ResourceStatement": {
                    "Resources": [
                        "vpc-abcd12e3"
                    ]
                }
            }
         }
    ],
    "ExcludePaths": [
        {
            "Source": {
                "ResourceStatement": {
                    "ResourceTypes": [
                        "AWS::EC2::InternetGateway"
                    ]
                }
            }
        }
    ]
}

Output:

{
    "NetworkInsightsAccessScope": {
        "NetworkInsightsAccessScopeId": "nis-123456789abc01234",
        "NetworkInsightsAccessScopeArn": "arn:aws:ec2:us-east-1:123456789012:network-insights-access-scope/nis-123456789abc01234",
        "CreatedDate": "2022-01-25T19:20:28.796000+00:00",
        "UpdatedDate": "2022-01-25T19:20:28.797000+00:00"
    },
    "NetworkInsightsAccessScopeContent": {
        "NetworkInsightsAccessScopeId": "nis-123456789abc01234",
        "MatchPaths": [
            {
                "Source": {
                    "ResourceStatement": {
                        "Resources": [
                            "vpc-abcd12e3"
                        ]
                    }
                }
            }
        ],
        "ExcludePaths": [
            {
                "Source": {
                    "ResourceStatement": {
                        "ResourceTypes": [
                            "AWS::EC2::InternetGateway"
                        ]
                    }
                }
            }
        ]
    }
}

For more information, see Getting started with Network Access Analyzer using the AWS CLI in the Network Access Analyzer Guide.

Output¶

NetworkInsightsAccessScope -> (structure)

The Network Access Scope.

NetworkInsightsAccessScopeId -> (string)

The ID of the Network Access Scope.

NetworkInsightsAccessScopeArn -> (string)

The Amazon Resource Name (ARN) of the Network Access Scope.

CreatedDate -> (timestamp)

The creation date.

UpdatedDate -> (timestamp)

The last updated date.

Tags -> (list)

The tags.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

NetworkInsightsAccessScopeContent -> (structure)

The Network Access Scope content.

NetworkInsightsAccessScopeId -> (string)

The ID of the Network Access Scope.

MatchPaths -> (list)

The paths to match.

(structure)

Describes a path.

Source -> (structure)

The source.

PacketHeaderStatement -> (structure)

The packet header statement.

SourceAddresses -> (list)

The source addresses.

(string)

DestinationAddresses -> (list)

The destination addresses.

(string)

SourcePorts -> (list)

The source ports.

(string)

DestinationPorts -> (list)

The destination ports.

(string)

SourcePrefixLists -> (list)

The source prefix lists.

(string)

DestinationPrefixLists -> (list)

The destination prefix lists.

(string)

Protocols -> (list)

The protocols.

(string)

ResourceStatement -> (structure)

The resource statement.

Resources -> (list)

The resources.

(string)

ResourceTypes -> (list)

The resource types.

(string)

Destination -> (structure)

The destination.

PacketHeaderStatement -> (structure)

The packet header statement.

SourceAddresses -> (list)

The source addresses.

(string)

DestinationAddresses -> (list)

The destination addresses.

(string)

SourcePorts -> (list)

The source ports.

(string)

DestinationPorts -> (list)

The destination ports.

(string)

SourcePrefixLists -> (list)

The source prefix lists.

(string)

DestinationPrefixLists -> (list)

The destination prefix lists.

(string)

Protocols -> (list)

The protocols.

(string)

ResourceStatement -> (structure)

The resource statement.

Resources -> (list)

The resources.

(string)

ResourceTypes -> (list)

The resource types.

(string)

ThroughResources -> (list)

The through resources.

(structure)

Describes a through resource statement.

ResourceStatement -> (structure)

The resource statement.

Resources -> (list)

The resources.

(string)

ResourceTypes -> (list)

The resource types.

(string)

ExcludePaths -> (list)

The paths to exclude.

(structure)

Describes a path.

Source -> (structure)

The source.

PacketHeaderStatement -> (structure)

The packet header statement.

SourceAddresses -> (list)

The source addresses.

(string)

DestinationAddresses -> (list)

The destination addresses.

(string)

SourcePorts -> (list)

The source ports.

(string)

DestinationPorts -> (list)

The destination ports.

(string)

SourcePrefixLists -> (list)

The source prefix lists.

(string)

DestinationPrefixLists -> (list)

The destination prefix lists.

(string)

Protocols -> (list)

The protocols.

(string)

ResourceStatement -> (structure)

The resource statement.

Resources -> (list)

The resources.

(string)

ResourceTypes -> (list)

The resource types.

(string)

Destination -> (structure)

The destination.

PacketHeaderStatement -> (structure)

The packet header statement.

SourceAddresses -> (list)

The source addresses.

(string)

DestinationAddresses -> (list)

The destination addresses.

(string)

SourcePorts -> (list)

The source ports.

(string)

DestinationPorts -> (list)

The destination ports.

(string)

SourcePrefixLists -> (list)

The source prefix lists.

(string)

DestinationPrefixLists -> (list)

The destination prefix lists.

(string)

Protocols -> (list)

The protocols.

(string)

ResourceStatement -> (structure)

The resource statement.

Resources -> (list)

The resources.

(string)

ResourceTypes -> (list)

The resource types.

(string)

ThroughResources -> (list)

The through resources.

(structure)

Describes a through resource statement.

ResourceStatement -> (structure)

The resource statement.

Resources -> (list)

The resources.

(string)

ResourceTypes -> (list)

The resource types.

(string)

Table Of Contents

Feedback

User Guide

Note:

create-network-insights-access-scope¶

Description¶

Synopsis¶

Options¶

Note

Global Options¶

Examples¶

Note

Output¶