PinpointSMSVoiceV2 / Paginator / ListProtectConfigurationRuleSetNumberOverrides

ListProtectConfigurationRuleSetNumberOverrides

class PinpointSMSVoiceV2.Paginator.ListProtectConfigurationRuleSetNumberOverrides

paginator = client.get_paginator('list_protect_configuration_rule_set_number_overrides')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ProtectConfigurationId='string',
    Filters=[
        {
            'Name': 'iso-country-code'|'destination-phone-number-begins-with'|'action'|'expires-before'|'expires-after'|'created-before'|'created-after',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ProtectConfigurationId (string) –

  [REQUIRED]

  The unique identifier for the protect configuration.

• Filters (list) –

  An array of ProtectConfigurationRuleSetNumberOverrideFilterItem objects to filter the results.

  • (dict) –

    The information for a protect configuration rule set number override that meets a specified criteria.

    • Name (string) – [REQUIRED]

      The name of the attribute to filter on.

    • Values (list) – [REQUIRED]

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

{
    'ProtectConfigurationArn': 'string',
    'ProtectConfigurationId': 'string',
    'RuleSetNumberOverrides': [
        {
            'DestinationPhoneNumber': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'Action': 'ALLOW'|'BLOCK',
            'IsoCountryCode': 'string',
            'ExpirationTimestamp': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • ProtectConfigurationArn (string) –

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

  • ProtectConfigurationId (string) –

    The unique identifier for the protect configuration.

  • RuleSetNumberOverrides (list) –

    An array of RuleSetNumberOverrides objects.

    • (dict) –

      Provides details on a RuleSetNumberOverride.

      • DestinationPhoneNumber (string) –

        The destination phone number in E.164 format.

      • CreatedTimestamp (datetime) –

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

      • Action (string) –

        The action for the rule to perform of either blocking or allowing messages to the destination phone number.

      • IsoCountryCode (string) –

        The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

      • ExpirationTimestamp (datetime) –

        The time the rule will expire at. If ExpirationTimestamp is not set then the rule will not expire.