SecurityHub / Paginator / ListConfigurationPolicies

ListConfigurationPolicies#

class SecurityHub.Paginator.ListConfigurationPolicies#
paginator = client.get_paginator('list_configuration_policies')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

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

{
    'ConfigurationPolicySummaries': [
        {
            'Arn': 'string',
            'Id': 'string',
            'Name': 'string',
            'Description': 'string',
            'UpdatedAt': datetime(2015, 1, 1),
            'ServiceEnabled': True|False
        },
    ],

}

Response Structure

  • (dict) –

    • ConfigurationPolicySummaries (list) –

      Provides metadata for each of your configuration policies.

      • (dict) –

        An object that contains the details of an Security Hub configuration policy that’s returned in a ListConfigurationPolicies request.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the configuration policy.

        • Id (string) –

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

        • Name (string) –

          The name of the configuration policy. Alphanumeric characters and the following ASCII characters are permitted: -, ., !, *, /.

        • Description (string) –

          The description of the configuration policy.

        • UpdatedAt (datetime) –

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

        • ServiceEnabled (boolean) –

          Indicates whether the service that the configuration policy applies to is enabled in the policy.