AWS CLI Command Reference

[ aws . network-security-manager ]

create-scope-snapshot

Description

Creates a snapshot of the current published version of the specified scope.

See also: AWS API Documentation

Synopsis

  create-scope-snapshot
--scope-identifier <value>
[--client-token <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--scope-identifier (string) [required]

The identifier of the scope. This is the scope’s Amazon Resource Name (ARN).

Constraints:

  • min: 1
  • max: 1010

--client-token (string)

A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.

Constraints:

  • min: 1
  • max: 64
  • pattern: [\x21-\x7E]+

--tags (map)

The tags to add to the snapshot when it is created.

Constraints:

  • min: 0
  • max: 200

key -> (string)

Constraints:

  • min: 1
  • max: 128
  • pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

value -> (string)

Constraints:

  • min: 0
  • max: 256

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
  • yaml
  • yaml-stream
  • off

--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.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

scopeId -> (string)

The service-generated id of the scope.

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-z0-9]{1,64}

scopeArn -> (string)

The Amazon Resource Name (ARN) of the scope.

Constraints:

  • min: 20
  • max: 1010
  • pattern: arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:(.+)

scopeName -> (string)

The name of the scope.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9][a-zA-Z0-9 _.:/=+\-@]*

scopeDescription -> (string)

A description of the scope.

Constraints:

  • min: 0
  • max: 256
  • pattern: [a-zA-Z0-9 _.:/=+\-@]*

scopeConfiguration -> (structure)

The configuration that defines which accounts and resources are in scope.

accountFilter -> (tagged union structure)

The account filter that determines which accounts are in scope. When set, exactly one of includeAll , include , or exclude is set.

Organization administrators must include an account filter in every scope configuration. Single-account administrators must omit it: a scope without an account filter applies only to the administrator’s own account. The presence of an account filter is fixed when the scope is created: an update can’t add an account filter to a scope that was created without one, or remove the account filter from a scope that was created with one.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: includeAll, include, exclude.

includeAll -> (structure)

Includes all accounts. No account filtering is applied.

include -> (structure)

Includes only the specified accounts and organizational units.

accountIds -> (list)

The list of AWS account IDs.

Constraints:

  • min: 0
  • max: 1000

(string)

Constraints:

  • min: 12
  • max: 12
  • pattern: (?:[0-9]{12})

organizationalUnits -> (list)

The AWS Organizations organizational units (OUs) in the selection.

Constraints:

  • min: 0
  • max: 1000

(string)

Constraints:

  • min: 0
  • max: 68

exclude -> (structure)

Excludes the specified accounts and organizational units. All others are in scope.

accountIds -> (list)

The list of AWS account IDs.

Constraints:

  • min: 0
  • max: 1000

(string)

Constraints:

  • min: 12
  • max: 12
  • pattern: (?:[0-9]{12})

organizationalUnits -> (list)

The AWS Organizations organizational units (OUs) in the selection.

Constraints:

  • min: 0
  • max: 1000

(string)

Constraints:

  • min: 0
  • max: 68

resourceScopes -> (map) [required]

The resource-level scoping configuration, keyed by resource type, that defines which resources within the selected accounts are in scope.

Constraints:

  • min: 0
  • max: 20

key -> (string)

Possible values:

  • AWS::ApiGateway::Stage
  • AWS::CloudFront::Distribution
  • AWS::EC2::EIP
  • AWS::ElasticLoadBalancingV2::LoadBalancer::application
  • AWS::ElasticLoadBalancing::LoadBalancer

value -> (structure)

Defines which resources of a given type are in scope. Exactly one of includeAll , include , or exclude is set.

includeAll -> (boolean)

Includes all resources of the resource type.

include -> (structure)

Includes the resources that match the specified criteria or explicit ARNs.

explicitArns -> (list)

An explicit list of resource ARNs.

Constraints:

  • min: 0
  • max: 100

(string)

Constraints:

  • min: 20
  • max: 1010
  • pattern: arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:(.+)

expression -> (tagged union structure)

A logical expression that selects resources by combining criteria with AND, OR, and NOT operators.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: criteria, and, or, not.

criteria -> (tagged union structure)

A leaf condition that matches resources by tag or by resource-type-specific configuration.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: tags, albConfig.

tags -> (map)

Tag key-value pairs used to match resources.

Constraints:

  • min: 0
  • max: 100

key -> (string)

value -> (string)

albConfig -> (structure)

Filter criteria specific to Application Load Balancers.

scheme -> (string)

The scheme of the Application Load Balancer, either internet-facing or internal .

Possible values:

  • internet-facing
  • internal

ipAddressType -> (string)

The IP address type of the Application Load Balancer.

Possible values:

  • ipv4
  • dualstack
  • dualstack-without-public-ipv4

and -> (list)

A list of subexpressions that must all match.

Constraints:

  • min: 0
  • max: 20

(tagged union structure)

A logical expression that selects resources. Exactly one of criteria , and , or , or not is set.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: criteria, and, or, not.

criteria -> (tagged union structure)

A leaf condition that matches resources by tag or by resource-type-specific configuration.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: tags, albConfig.

tags -> (map)

Tag key-value pairs used to match resources.

Constraints:

  • min: 0
  • max: 100

key -> (string)

value -> (string)

albConfig -> (structure)

Filter criteria specific to Application Load Balancers.

scheme -> (string)

The scheme of the Application Load Balancer, either internet-facing or internal .

Possible values:

  • internet-facing
  • internal

ipAddressType -> (string)

The IP address type of the Application Load Balancer.

Possible values:

  • ipv4
  • dualstack
  • dualstack-without-public-ipv4

and -> (list)

A list of subexpressions that must all match.

Constraints:

  • min: 0
  • max: 20

( … recursive … )

or -> (list)

A list of subexpressions of which at least one must match.

Constraints:

  • min: 0
  • max: 20

( … recursive … )

( … recursive … )

or -> (list)

A list of subexpressions of which at least one must match.

Constraints:

  • min: 0
  • max: 20

(tagged union structure)

A logical expression that selects resources. Exactly one of criteria , and , or , or not is set.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: criteria, and, or, not.

criteria -> (tagged union structure)

A leaf condition that matches resources by tag or by resource-type-specific configuration.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: tags, albConfig.

tags -> (map)

Tag key-value pairs used to match resources.

Constraints:

  • min: 0
  • max: 100

key -> (string)

value -> (string)

albConfig -> (structure)

Filter criteria specific to Application Load Balancers.

scheme -> (string)

The scheme of the Application Load Balancer, either internet-facing or internal .

Possible values:

  • internet-facing
  • internal

ipAddressType -> (string)

The IP address type of the Application Load Balancer.

Possible values:

  • ipv4
  • dualstack
  • dualstack-without-public-ipv4

and -> (list)

A list of subexpressions that must all match.

Constraints:

  • min: 0
  • max: 20

( … recursive … )

or -> (list)

A list of subexpressions of which at least one must match.

Constraints:

  • min: 0
  • max: 20

( … recursive … )

( … recursive … )

not -> (tagged union structure)

A subexpression that must not match.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: criteria, and, or, not.

criteria -> (tagged union structure)

A leaf condition that matches resources by tag or by resource-type-specific configuration.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: tags, albConfig.

tags -> (map)

Tag key-value pairs used to match resources.

Constraints:

  • min: 0
  • max: 100

key -> (string)

value -> (string)

albConfig -> (structure)

Filter criteria specific to Application Load Balancers.

scheme -> (string)

The scheme of the Application Load Balancer, either internet-facing or internal .

Possible values:

  • internet-facing
  • internal

ipAddressType -> (string)

The IP address type of the Application Load Balancer.

Possible values:

  • ipv4
  • dualstack
  • dualstack-without-public-ipv4

and -> (list)

A list of subexpressions that must all match.

Constraints:

  • min: 0
  • max: 20

( … recursive … )

or -> (list)

A list of subexpressions of which at least one must match.

Constraints:

  • min: 0
  • max: 20

( … recursive … )

( … recursive … )

exclude -> (structure)

Excludes the resources that match the specified criteria or explicit ARNs.

explicitArns -> (list)

An explicit list of resource ARNs.

Constraints:

  • min: 0
  • max: 100

(string)

Constraints:

  • min: 20
  • max: 1010
  • pattern: arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:(.+)

expression -> (tagged union structure)

A logical expression that selects resources by combining criteria with AND, OR, and NOT operators.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: criteria, and, or, not.

criteria -> (tagged union structure)

A leaf condition that matches resources by tag or by resource-type-specific configuration.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: tags, albConfig.

tags -> (map)

Tag key-value pairs used to match resources.

Constraints:

  • min: 0
  • max: 100

key -> (string)

value -> (string)

albConfig -> (structure)

Filter criteria specific to Application Load Balancers.

scheme -> (string)

The scheme of the Application Load Balancer, either internet-facing or internal .

Possible values:

  • internet-facing
  • internal

ipAddressType -> (string)

The IP address type of the Application Load Balancer.

Possible values:

  • ipv4
  • dualstack
  • dualstack-without-public-ipv4

and -> (list)

A list of subexpressions that must all match.

Constraints:

  • min: 0
  • max: 20

(tagged union structure)

A logical expression that selects resources. Exactly one of criteria , and , or , or not is set.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: criteria, and, or, not.

criteria -> (tagged union structure)

A leaf condition that matches resources by tag or by resource-type-specific configuration.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: tags, albConfig.

tags -> (map)

Tag key-value pairs used to match resources.

Constraints:

  • min: 0
  • max: 100

key -> (string)

value -> (string)

albConfig -> (structure)

Filter criteria specific to Application Load Balancers.

scheme -> (string)

The scheme of the Application Load Balancer, either internet-facing or internal .

Possible values:

  • internet-facing
  • internal

ipAddressType -> (string)

The IP address type of the Application Load Balancer.

Possible values:

  • ipv4
  • dualstack
  • dualstack-without-public-ipv4

and -> (list)

A list of subexpressions that must all match.

Constraints:

  • min: 0
  • max: 20

( … recursive … )

or -> (list)

A list of subexpressions of which at least one must match.

Constraints:

  • min: 0
  • max: 20

( … recursive … )

( … recursive … )

or -> (list)

A list of subexpressions of which at least one must match.

Constraints:

  • min: 0
  • max: 20

(tagged union structure)

A logical expression that selects resources. Exactly one of criteria , and , or , or not is set.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: criteria, and, or, not.

criteria -> (tagged union structure)

A leaf condition that matches resources by tag or by resource-type-specific configuration.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: tags, albConfig.

tags -> (map)

Tag key-value pairs used to match resources.

Constraints:

  • min: 0
  • max: 100

key -> (string)

value -> (string)

albConfig -> (structure)

Filter criteria specific to Application Load Balancers.

scheme -> (string)

The scheme of the Application Load Balancer, either internet-facing or internal .

Possible values:

  • internet-facing
  • internal

ipAddressType -> (string)

The IP address type of the Application Load Balancer.

Possible values:

  • ipv4
  • dualstack
  • dualstack-without-public-ipv4

and -> (list)

A list of subexpressions that must all match.

Constraints:

  • min: 0
  • max: 20

( … recursive … )

or -> (list)

A list of subexpressions of which at least one must match.

Constraints:

  • min: 0
  • max: 20

( … recursive … )

( … recursive … )

not -> (tagged union structure)

A subexpression that must not match.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: criteria, and, or, not.

criteria -> (tagged union structure)

A leaf condition that matches resources by tag or by resource-type-specific configuration.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: tags, albConfig.

tags -> (map)

Tag key-value pairs used to match resources.

Constraints:

  • min: 0
  • max: 100

key -> (string)

value -> (string)

albConfig -> (structure)

Filter criteria specific to Application Load Balancers.

scheme -> (string)

The scheme of the Application Load Balancer, either internet-facing or internal .

Possible values:

  • internet-facing
  • internal

ipAddressType -> (string)

The IP address type of the Application Load Balancer.

Possible values:

  • ipv4
  • dualstack
  • dualstack-without-public-ipv4

and -> (list)

A list of subexpressions that must all match.

Constraints:

  • min: 0
  • max: 20

( … recursive … )

or -> (list)

A list of subexpressions of which at least one must match.

Constraints:

  • min: 0
  • max: 20

( … recursive … )

( … recursive … )

status -> (string)

The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).

Possible values:

  • DRAFT
  • ACTIVE
  • DISABLED

version -> (string)

The version of the resource.

Constraints:

  • min: 1
  • max: 10
  • pattern: [1-9][0-9]*

updateToken -> (string)

A token used for optimistic concurrency control. Each read and write returns an updateToken . Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.

Constraints:

  • min: 36
  • max: 36
  • pattern: ([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})

isSnapshot -> (boolean)

Specifies whether the resource is a snapshot of a published version.

hasPublishedVersion -> (boolean)

Specifies whether a published version of the resource exists.

updatedAt -> (timestamp)

The time when the snapshot was created.
© Copyright 2026, Amazon Web Services. Created using Sphinx.