protect_configuration_country_rule_sets

Creates, updates, deletes, gets or lists a protect_configuration_country_rule_sets resource.

Overview

Name	protect_configuration_country_rule_sets
Type	Resource
Id	aws.pinpoint_sms_voice_v2.protect_configuration_country_rule_sets

Fields

The following fields are returned by SELECT queries:

get_protect_configuration_country_rule_set

Name	Datatype	Description
country_rule_set	object	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 End User Messaging SMS User Guide.
number_capability	string	The capability type associated with the returned ProtectConfigurationCountryRuleSetInformation objects. (SMS, VOICE, MMS, RCS)
protect_configuration_arn	string	The Amazon Resource Name (ARN) of the protect configuration. (pattern: <code>arn:\S+</code>)
protect_configuration_id	string	The unique identifier for the protect configuration. (pattern: <code>[A-Za-z0-9_-]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_protect_configuration_country_rule_set	select	region		Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.
update_protect_configuration_country_rule_set	update	region, ProtectConfigurationId, NumberCapability, CountryRuleSetUpdates		Update a country rule set to ALLOW, BLOCK, MONITOR, or FILTER 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_protect_configuration_country_rule_set

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

SELECT
country_rule_set,
number_capability,
protect_configuration_arn,
protect_configuration_id
FROM aws.pinpoint_sms_voice_v2.protect_configuration_country_rule_sets
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_protect_configuration_country_rule_set

Update a country rule set to ALLOW, BLOCK, MONITOR, or FILTER 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.

UPDATE aws.pinpoint_sms_voice_v2.protect_configuration_country_rule_sets
SET 
ProtectConfigurationId = '{{ ProtectConfigurationId }}',
NumberCapability = '{{ NumberCapability }}',
CountryRuleSetUpdates = '{{ CountryRuleSetUpdates }}'
WHERE 
region = '{{ region }}' --required
AND ProtectConfigurationId = '{{ ProtectConfigurationId }}' --required
AND NumberCapability = '{{ NumberCapability }}' --required
AND CountryRuleSetUpdates = '{{ CountryRuleSetUpdates }}' --required
RETURNING
country_rule_set,
number_capability,
protect_configuration_arn,
protect_configuration_id;