AWS CLI Command Reference

[ aws . network-security-manager ]

get-deploymentÂķ

DescriptionÂķ

Retrieves the details of the specified deployment, including coverage information and any warnings.

See also: AWS API Documentation

SynopsisÂķ

  get-deployment
--deployment-identifier <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Âķ

--deployment-identifier (string) [required]

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

Constraints:

  • min: 1
  • max: 1010

--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Âķ

deploymentId -> (string)

The service-generated id of the deployment.

Constraints:

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

deploymentArn -> (string)

The Amazon Resource Name (ARN) of the deployment.

Constraints:

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

deploymentName -> (string)

The name of the deployment.

Constraints:

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

deploymentDescription -> (string)

A description of the deployment.

Constraints:

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

status -> (string)

The current status of the resource: DRAFT (unpublished, editable), ACTIVE (published, in use), or DISABLED (deactivated; changes cannot be published until the resource is re-enabled).

Possible values:

  • DRAFT
  • ACTIVE
  • DISABLED

deploymentConfiguration -> (structure)

The configuration settings for the deployment.

enableCrossAccountVisibility -> (boolean) [required]

Specifies whether aggregate synchronization status details for the resources covered by this deployment are visible across accounts. Default: false .

associatedPolicyList -> (list)

The policies associated with the deployment.

Constraints:

  • min: 1
  • max: 2

(structure)

An association between a deployment and a policy, as returned in outputs. The corresponding request structure is PolicyReference .

policyArn -> (string) [required]

The ARN of the associated policy, including its version qualifier when a specific published version is pinned (for example, ...:policy:abc123:3 ).

Constraints:

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

associatedScopeList -> (list)

The scope associated with the deployment. A deployment has exactly one scope.

Constraints:

  • min: 1
  • max: 1

(structure)

An association between a deployment and a scope, as returned in outputs. The corresponding request structure is ScopeReference .

scopeArn -> (string) [required]

The ARN of the associated scope.

Constraints:

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

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 resource was last updated.

deploymentCoverage -> (list)

The coverage information for the deployment. For each firewall type, it shows which policies have that firewall type and which in-scope resource types the firewall type protects.

Constraints:

  • min: 0
  • max: 10

(structure)

Coverage information for one firewall type within a deployment. It lists the deployment’s policies that have this firewall type. It also lists the resource types in the deployment’s scope that the firewall type protects.

firewallType -> (string) [required]

The firewall type that the policies in this entry share.

Possible values:

  • WAF
  • SHIELD_ADVANCED

policyArns -> (list) [required]

The Amazon Resource Names (ARNs) of the deployment’s policies that have this firewall type.

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}:(.+)

inScopeResourceTypes -> (list) [required]

The resource types in the deployment’s scope that this firewall type protects. This list is empty if the scope does not select any resource types that the firewall type protects.

Constraints:

  • min: 0
  • max: 50

(string)

Possible values:

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

warnings -> (list)

Warnings about potential issues, such as a policy that has no applicable resources in the deployment’s scope.

Constraints:

  • min: 0
  • max: 100

(structure)

A warning about a potential issue with a deployment.

code -> (string) [required]

A code that identifies the type of warning.

policyArn -> (string) [required]

The ARN of the policy that the warning relates to.

Constraints:

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

message -> (string) [required]

A human-readable description of the warning.
© Copyright 2026, Amazon Web Services. Created using Sphinx.