NetworkSecurityManagerCustomerAPI / Client / list_aggregate_resource_synchronization_statuses

list_aggregate_resource_synchronization_statuses¶

NetworkSecurityManagerCustomerAPI.Client.list_aggregate_resource_synchronization_statuses(**kwargs)¶

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.

Request Syntax

response = client.list_aggregate_resource_synchronization_statuses(
    synchronizationStatus='IN_SYNC'|'OUT_OF_SYNC'|'NOT_APPLICABLE',
    maxResults=123,
    nextToken='string'
)

Parameters:

synchronizationStatus (string) – Filters the results by synchronization status, such as IN_SYNC or OUT_OF_SYNC.
maxResults (integer) – The maximum number of results to return in a single call. Valid range: 1-100. To retrieve the remaining results, use the returned nextToken value in a subsequent call.
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.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'resourceSynchronizationStatuses': [
        {
            'synchronizationStatus': 'IN_SYNC'|'OUT_OF_SYNC'|'NOT_APPLICABLE',
            'accountId': 'string',
            'resourceArn': 'string',
            'deploymentArn': 'string',
            'resourceType': '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': datetime(2015, 1, 1),
            'outOfSyncReasons': {
                'reasons': {
                    'string': {
                        'missingFirewall': 'string',
                        'invalidFirewall': {
                            'incorrectSingleValueConfigurations': [
                                {
                                    'configurationName': 'string',
                                    'expectedValue': 'string',
                                    'actualValue': 'string'
                                },
                            ],
                            'missingAppendableConfigurationValues': [
                                {
                                    'configurationName': 'string',
                                    'expectedValue': 'string',
                                    'actualValue': 'string'
                                },
                            ],
                            'unexpectedAppendableConfigurationValues': [
                                {
                                    'configurationName': 'string',
                                    'expectedValue': 'string',
                                    'actualValue': 'string'
                                },
                            ],
                            'incorrectAppendableConfigurationOrder': [
                                {
                                    'configurationName': 'string',
                                    'expectedValue': 'string',
                                    'actualValue': 'string'
                                },
                            ],
                            'missingMergeableConfigurationValues': [
                                {
                                    'configurationName': 'string',
                                    'expectedValue': 'string',
                                    'actualValue': 'string'
                                },
                            ],
                            'unexpectedMergeableConfigurationValues': [
                                {
                                    'configurationName': 'string',
                                    'expectedValue': 'string',
                                    'actualValue': 'string'
                                },
                            ]
                        }
                    }
                },
                'notVisible': {
                    'reason': 'string'
                }
            },
            'remediationIssues': {
                'issues': {
                    'string': {
                        'issueType': 'string',
                        'message': 'string',
                        'correctiveAction': 'string'
                    }
                },
                'notVisible': {
                    'reason': 'string'
                }
            },
            'evaluatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

(dict) –
- 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.
- resourceSynchronizationStatuses (list) –
  
  The list of resource synchronization statuses.
  - (dict) –
    
    The synchronization status of a resource covered by a deployment.
    - synchronizationStatus (string) –
      
      The synchronization status of the resource, such as IN_SYNC or OUT_OF_SYNC.
    - accountId (string) –
      
      The AWS account ID that owns the resource.
    - resourceArn (string) –
      
      The ARN of the resource whose synchronization status is reported.
    - deploymentArn (string) –
      
      The ARN of the deployment that the synchronization status is associated with. This is absent for aggregate (cross-deployment) statuses.
    - resourceType (string) –
      
      The type of the resource, in AWS CloudFormation format.
    - updatedAt (datetime) –
      
      The time when the resource was last updated.
    - outOfSyncReasons (dict) –
      
      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 will be set: reasons, notVisible. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - reasons (dict) –
        
        The out-of-sync reasons, keyed by firewall type.
        
        (string) –
        
        (dict) –
        
        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 will be set: missingFirewall, invalidFirewall. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        missingFirewall (string) –
        
        Indicates that an expected firewall is missing. The value describes the missing firewall.
        
        invalidFirewall (dict) –
        
        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.
        
        (dict) –
        
        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.
        
        (dict) –
        
        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.
        
        (dict) –
        
        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.
        
        (dict) –
        
        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.
        
        (dict) –
        
        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.
        
        (dict) –
        
        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 (dict) –
        
        Indicates that the details are not visible because of cross-account restrictions.
        
        reason (string) –
        
        The reason the details are not visible.
    - remediationIssues (dict) –
      
      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 will be set: issues, notVisible. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - issues (dict) –
        
        The remediation issues, keyed by firewall type.
        
        (string) –
        
        (dict) –
        
        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 (dict) –
        
        Indicates that the details are not visible because of cross-account restrictions.
        
        reason (string) –
        
        The reason the details are not visible.
    - evaluatedAt (datetime) –
      
      The time when the synchronization status was last evaluated.

Exceptions

NetworkSecurityManagerCustomerAPI.Client.exceptions.ValidationException
NetworkSecurityManagerCustomerAPI.Client.exceptions.InternalServerException
NetworkSecurityManagerCustomerAPI.Client.exceptions.AccessDeniedException
NetworkSecurityManagerCustomerAPI.Client.exceptions.ThrottlingException