PinpointSMSVoiceV2 / Client / update_protect_configuration_country_rule_set
update_protect_configuration_country_rule_set#
- PinpointSMSVoiceV2.Client.update_protect_configuration_country_rule_set(**kwargs)#
Update a country rule set to
ALLOW
orBLOCK
messages to be sent to the specified destination counties. You can update one or multiple countries at a time. The updates are only applied to the specified NumberCapability type.See also: AWS API Documentation
Request Syntax
response = client.update_protect_configuration_country_rule_set( ProtectConfigurationId='string', NumberCapability='SMS'|'VOICE'|'MMS', CountryRuleSetUpdates={ 'string': { 'ProtectStatus': 'ALLOW'|'BLOCK' } } )
- Parameters:
ProtectConfigurationId (string) –
[REQUIRED]
The unique identifier for the protect configuration.
NumberCapability (string) –
[REQUIRED]
The number capability to apply the CountryRuleSetUpdates updates to.
CountryRuleSetUpdates (dict) –
[REQUIRED]
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 AWS End User Messaging SMS User Guide.
(string) –
(dict) –
The types of statuses that can be used.
ProtectStatus (string) – [REQUIRED]
The types of protection that can be used.
- 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 number capability that was updated
CountryRuleSet (dict) –
An array of ProtectConfigurationCountryRuleSetInformation containing the rules for the NumberCapability.
(string) –
(dict) –
The types of statuses that can be used.
ProtectStatus (string) –
The types of protection that can be used.
Exceptions