PinpointSMSVoiceV2 / Client / list_protect_configuration_rule_set_number_overrides

list_protect_configuration_rule_set_number_overrides#

PinpointSMSVoiceV2.Client.list_protect_configuration_rule_set_number_overrides(**kwargs)#

Retrieve all of the protect configuration rule set number overrides that match the filters.

See also: AWS API Documentation

Request Syntax

response = client.list_protect_configuration_rule_set_number_overrides(
    ProtectConfigurationId='string',
    Filters=[
        {
            'Name': 'iso-country-code'|'destination-phone-number-begins-with'|'action'|'expires-before'|'expires-after'|'created-before'|'created-after',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)
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) –

  • NextToken (string) – The token to be used for the next set of paginated results. You don’t need to supply a value for this field in the initial request.

  • MaxResults (integer) – The maximum number of results to return per each request.

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)
        },
    ],
    'NextToken': 'string'
}

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.

    • NextToken (string) –

      The token to be used for the next set of paginated results. You don’t need to supply a value for this field in the initial request.

Exceptions