AWS CLI Command Reference

[ aws . network-security-manager ]

list-aggregate-resource-synchronization-statuses

Description

Lists the aggregated synchronization statuses of resources across the deployments in your administrator account. You can filter the results by synchronization status and page through them.

See also: AWS API Documentation

list-aggregate-resource-synchronization-statuses is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: resourceSynchronizationStatuses

Synopsis

  list-aggregate-resource-synchronization-statuses
[--synchronization-status <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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

--synchronization-status (string)

Filters the results by synchronization status, such as IN_SYNC or OUT_OF_SYNC .

Possible values:

  • IN_SYNC
  • OUT_OF_SYNC
  • NOT_APPLICABLE

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

  • min: 1
  • max: 100

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

nextToken -> (string)

The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.

Constraints:

  • min: 1
  • max: 4096
  • pattern: [0-9A-Za-z:/+=_-]+

resourceSynchronizationStatuses -> (list)

The list of resource synchronization statuses.

Constraints:

  • min: 0
  • max: 100

(structure)

The synchronization status of a resource covered by a deployment.

synchronizationStatus -> (string) [required]

The synchronization status of the resource, such as IN_SYNC or OUT_OF_SYNC .

Possible values:

  • IN_SYNC
  • OUT_OF_SYNC
  • NOT_APPLICABLE

accountId -> (string) [required]

The AWS account ID that owns the resource.

Constraints:

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

resourceArn -> (string) [required]

The ARN of the resource whose synchronization status is reported.

Constraints:

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

deploymentArn -> (string)

The ARN of the deployment that the synchronization status is associated with. This is absent for aggregate (cross-deployment) statuses.

Constraints:

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

resourceType -> (string)

The type of the resource, in AWS CloudFormation format.

Possible values:

  • AWS::ApiGateway::Stage
  • AWS::CloudFront::Distribution
  • AWS::EC2::EIP
  • AWS::ElasticLoadBalancingV2::LoadBalancer::application
  • AWS::ElasticLoadBalancing::LoadBalancer
  • AWS::WAFv2::WebACL
  • AWS::Shield::Protection
  • AWS::ShieldRegional::Protection

updatedAt -> (timestamp) [required]

The time when the resource was last updated.

outOfSyncReasons -> (tagged union structure)

The reasons the resource is out of sync, keyed by firewall type. This is null when the resource is in sync.

Note

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

reasons -> (map)

The out-of-sync reasons, keyed by firewall type.

Constraints:

  • min: 0
  • max: 10

key -> (string)

Possible values:

  • WAF
  • SHIELD_ADVANCED

value -> (tagged union structure)

Describes why a firewall is out of sync. Exactly one of missingFirewall or invalidFirewall is set.

Note

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

missingFirewall -> (string)

Indicates that an expected firewall is missing. The value describes the missing firewall.

invalidFirewall -> (structure)

Details about a firewall whose configuration does not match the intended configuration.

incorrectSingleValueConfigurations -> (list)

Single-value configuration settings whose values do not match the expected values.

Constraints:

  • min: 0
  • max: 100

(structure)

Describes a single configuration value that does not match the intended configuration.

configurationName -> (string)

The name of the configuration setting that is in conflict.

expectedValue -> (string)

The configuration value that AWS Network Security Manager expected.

actualValue -> (string)

The configuration value that was found on the resource.

missingAppendableConfigurationValues -> (list)

Appendable configuration values that are expected but missing.

Constraints:

  • min: 0
  • max: 100

(structure)

Describes a single configuration value that does not match the intended configuration.

configurationName -> (string)

The name of the configuration setting that is in conflict.

expectedValue -> (string)

The configuration value that AWS Network Security Manager expected.

actualValue -> (string)

The configuration value that was found on the resource.

unexpectedAppendableConfigurationValues -> (list)

Appendable configuration values that are present but not expected.

Constraints:

  • min: 0
  • max: 100

(structure)

Describes a single configuration value that does not match the intended configuration.

configurationName -> (string)

The name of the configuration setting that is in conflict.

expectedValue -> (string)

The configuration value that AWS Network Security Manager expected.

actualValue -> (string)

The configuration value that was found on the resource.

incorrectAppendableConfigurationOrder -> (list)

Appendable configuration values that are present but in the wrong order.

Constraints:

  • min: 0
  • max: 100

(structure)

Describes a single configuration value that does not match the intended configuration.

configurationName -> (string)

The name of the configuration setting that is in conflict.

expectedValue -> (string)

The configuration value that AWS Network Security Manager expected.

actualValue -> (string)

The configuration value that was found on the resource.

missingMergeableConfigurationValues -> (list)

Mergeable configuration values that are expected but missing.

Constraints:

  • min: 0
  • max: 100

(structure)

Describes a single configuration value that does not match the intended configuration.

configurationName -> (string)

The name of the configuration setting that is in conflict.

expectedValue -> (string)

The configuration value that AWS Network Security Manager expected.

actualValue -> (string)

The configuration value that was found on the resource.

unexpectedMergeableConfigurationValues -> (list)

Mergeable configuration values that are present but not expected.

Constraints:

  • min: 0
  • max: 100

(structure)

Describes a single configuration value that does not match the intended configuration.

configurationName -> (string)

The name of the configuration setting that is in conflict.

expectedValue -> (string)

The configuration value that AWS Network Security Manager expected.

actualValue -> (string)

The configuration value that was found on the resource.

notVisible -> (structure)

Indicates that the details are not visible because of cross-account restrictions.

reason -> (string) [required]

The reason the details are not visible.

remediationIssues -> (tagged union structure)

Details about remediation issues, keyed by firewall type. This is null when there are no remediation issues.

Note

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

issues -> (map)

The remediation issues, keyed by firewall type.

Constraints:

  • min: 0
  • max: 10

key -> (string)

Possible values:

  • WAF
  • SHIELD_ADVANCED

value -> (structure)

Details about a remediation issue for a firewall type.

issueType -> (string)

The type of remediation issue.

message -> (string)

A human-readable description of the remediation issue.

correctiveAction -> (string)

A recommended action for resolving the remediation issue.

notVisible -> (structure)

Indicates that the details are not visible because of cross-account restrictions.

reason -> (string) [required]

The reason the details are not visible.

evaluatedAt -> (timestamp)

The time when the synchronization status was last evaluated.
© Copyright 2026, Amazon Web Services. Created using Sphinx.