PinpointSMSVoiceV2 / Paginator / DescribeProtectConfigurations

DescribeProtectConfigurations

class PinpointSMSVoiceV2.Paginator.DescribeProtectConfigurations

paginator = client.get_paginator('describe_protect_configurations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from PinpointSMSVoiceV2.Client.describe_protect_configurations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ProtectConfigurationIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'account-default'|'deletion-protection-enabled',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ProtectConfigurationIds (list) –

  An array of protect configuration identifiers to search for.

  • (string) –

• Filters (list) –

  An array of ProtectConfigurationFilter objects to filter the results.

  • (dict) –

    The filter definition for filtering protect configurations that meet a specified criteria.

    • Name (string) – [REQUIRED]

      The name of the attribute to filter on.

    • Values (list) – [REQUIRED]

      An array of values to filter for.

      • (string) –

• 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

{
    'ProtectConfigurations': [
        {
            'ProtectConfigurationArn': 'string',
            'ProtectConfigurationId': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'AccountDefault': True|False,
            'DeletionProtectionEnabled': True|False
        },
    ],

}

Response Structure

• (dict) –

  • ProtectConfigurations (list) –

    An array of ProtectConfigurationInformation objects that contain the details for the request.

    • (dict) –

      Provides information on the specified protect configuration.

      • ProtectConfigurationArn (string) –

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

      • ProtectConfigurationId (string) –

        The unique identifier for the protect configuration.

      • CreatedTimestamp (datetime) –

        The time when the protect configuration was created, in UNIX epoch time format.

      • AccountDefault (boolean) –

        This is true if the protect configuration is set as your account default protect configuration.

      • DeletionProtectionEnabled (boolean) –

        The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.