PinpointSMSVoiceV2 / Client / put_protect_configuration_rule_set_number_override

put_protect_configuration_rule_set_number_override#

PinpointSMSVoiceV2.Client.put_protect_configuration_rule_set_number_override(**kwargs)#

Create or update a RuleSetNumberOverride and associate it with a protect configuration.

See also: AWS API Documentation

Request Syntax

response = client.put_protect_configuration_rule_set_number_override(
    ClientToken='string',
    ProtectConfigurationId='string',
    DestinationPhoneNumber='string',
    Action='ALLOW'|'BLOCK',
    ExpirationTimestamp=datetime(2015, 1, 1)
)
Parameters:

  • ClientToken (string) –

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, a randomly generated token is used for the request to ensure idempotency.

    This field is autopopulated if not provided.

  • ProtectConfigurationId (string) –

    [REQUIRED]

    The unique identifier for the protect configuration.

  • DestinationPhoneNumber (string) –

    [REQUIRED]

    The destination phone number in E.164 format.

  • Action (string) –

    [REQUIRED]

    The action for the rule to either block or allow messages to the destination phone number.

  • ExpirationTimestamp (datetime) – The time the rule will expire at. If ExpirationTimestamp is not set then the rule does not expire.

Return type:

dict

Returns:

Response Syntax

{
    'ProtectConfigurationArn': 'string',
    'ProtectConfigurationId': 'string',
    '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.

    • 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 take.

    • 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.

Exceptions