PinpointSMSVoiceV2 / Client / get_protect_configuration_country_rule_set

get_protect_configuration_country_rule_set

PinpointSMSVoiceV2.Client.get_protect_configuration_country_rule_set(**kwargs)

Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.

See also: AWS API Documentation

Request Syntax

response = client.get_protect_configuration_country_rule_set(
    ProtectConfigurationId='string',
    NumberCapability='SMS'|'VOICE'|'MMS'
)

Parameters:

• ProtectConfigurationId (string) –

  [REQUIRED]

  The unique identifier for the protect configuration.

• NumberCapability (string) –

  [REQUIRED]

  The capability type to return the CountryRuleSet for. Valid values are SMS, VOICE, or MMS.

Return type:

dict

Returns:

Response Syntax

{
    'ProtectConfigurationArn': 'string',
    'ProtectConfigurationId': 'string',
    'NumberCapability': 'SMS'|'VOICE'|'MMS',
    'CountryRuleSet': {
        'string': {
            'ProtectStatus': 'ALLOW'|'BLOCK'
        }
    }
}

Response Structure

• (dict) –

  • ProtectConfigurationArn (string) –

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

  • ProtectConfigurationId (string) –

    The unique identifier for the protect configuration.

  • NumberCapability (string) –

    The capability type associated with the returned ProtectConfigurationCountryRuleSetInformation objects.

  • CountryRuleSet (dict) –

    A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the Amazon Pinpoint SMS user guide.

    • (string) –

      • (dict) –

        The types of statuses that can be used.

        • ProtectStatus (string) –

          The types of protection that can be used.

Exceptions

• PinpointSMSVoiceV2.Client.exceptions.ThrottlingException

• PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException

• PinpointSMSVoiceV2.Client.exceptions.ResourceNotFoundException

• PinpointSMSVoiceV2.Client.exceptions.ValidationException

• PinpointSMSVoiceV2.Client.exceptions.InternalServerException