PinpointSMSVoiceV2 / Client / create_protect_configuration

create_protect_configuration#

PinpointSMSVoiceV2.Client.create_protect_configuration(**kwargs)#

Create a new protect configuration. By default all country rule sets for each capability are set to ALLOW. Update the country rule sets using UpdateProtectConfigurationCountryRuleSet. A protect configurations name is stored as a Tag with the key set to Name and value as the name of the protect configuration.

See also: AWS API Documentation

Request Syntax

response = client.create_protect_configuration(
    ClientToken='string',
    DeletionProtectionEnabled=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
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.

  • DeletionProtectionEnabled (boolean) – When set to true deletion protection is enabled. By default this is set to false.

  • Tags (list) –

    An array of key and value pair tags that are associated with the resource.

    • (dict) –

      The list of tags to be added to the specified topic.

      • Key (string) – [REQUIRED]

        The key identifier, or name, of the tag.

      • Value (string) – [REQUIRED]

        The string value associated with the key of the tag.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • 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) –

      When set to true deletion protection is enabled. By default this is set to false.

    • Tags (list) –

      An array of key and value pair tags that are associated with the resource.

      • (dict) –

        The list of tags to be added to the specified topic.

        • Key (string) –

          The key identifier, or name, of the tag.

        • Value (string) –

          The string value associated with the key of the tag.

Exceptions