SecurityHub / Paginator / ListConfigurationPolicyAssociations

ListConfigurationPolicyAssociations

class SecurityHub.Paginator.ListConfigurationPolicyAssociations

paginator = client.get_paginator('list_configuration_policy_associations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SecurityHub.Client.list_configuration_policy_associations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters={
        'ConfigurationPolicyId': 'string',
        'AssociationType': 'INHERITED'|'APPLIED',
        'AssociationStatus': 'PENDING'|'SUCCESS'|'FAILED'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Filters (dict) –

  Options for filtering the ListConfigurationPolicyAssociations response. You can filter by the Amazon Resource Name (ARN) or universally unique identifier (UUID) of a configuration, AssociationType, or AssociationStatus.

  • ConfigurationPolicyId (string) –

    The ARN or UUID of the configuration policy.

  • AssociationType (string) –

    Indicates whether the association between a target and a configuration was directly applied by the Security Hub delegated administrator or inherited from a parent.

  • AssociationStatus (string) –

    The current status of the association between a target and a configuration policy.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'ConfigurationPolicyAssociationSummaries': [
        {
            'ConfigurationPolicyId': 'string',
            'TargetId': 'string',
            'TargetType': 'ACCOUNT'|'ORGANIZATIONAL_UNIT'|'ROOT',
            'AssociationType': 'INHERITED'|'APPLIED',
            'UpdatedAt': datetime(2015, 1, 1),
            'AssociationStatus': 'PENDING'|'SUCCESS'|'FAILED',
            'AssociationStatusMessage': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • ConfigurationPolicyAssociationSummaries (list) –

    An object that contains the details of each configuration policy association that’s returned in a ListConfigurationPolicyAssociations request.

    • (dict) –

      An object that contains the details of a configuration policy association that’s returned in a ListConfigurationPolicyAssociations request.

      • ConfigurationPolicyId (string) –

        The universally unique identifier (UUID) of the configuration policy.

      • TargetId (string) –

        The identifier of the target account, organizational unit, or the root.

      • TargetType (string) –

        Specifies whether the target is an Amazon Web Services account, organizational unit, or the root.

      • AssociationType (string) –

        Indicates whether the association between the specified target and the configuration was directly applied by the Security Hub delegated administrator or inherited from a parent.

      • UpdatedAt (datetime) –

        The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated.

      • AssociationStatus (string) –

        The current status of the association between the specified target and the configuration.

      • AssociationStatusMessage (string) –

        The explanation for a FAILED value for AssociationStatus.