Update Protect Configuration Country Rule Set

pinpointsmsvoicev2_update_protect_configuration_country_rule_set

R Documentation

Update a country rule set to ALLOW, BLOCK, MONITOR, or FILTER messages to be sent to the specified destination counties¶

Description¶

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.

Usage¶

pinpointsmsvoicev2_update_protect_configuration_country_rule_set(
  ProtectConfigurationId, NumberCapability, CountryRuleSetUpdates)

Arguments¶

ProtectConfigurationId

[required] The unique identifier for the protect configuration.

NumberCapability

[required] The number capability to apply the CountryRuleSetUpdates updates to.

CountryRuleSetUpdates

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

For example, to set the United States as allowed and Canada as blocked, the CountryRuleSetUpdates would be formatted as: ⁠"CountryRuleSetUpdates": { "US" : { "ProtectStatus": "ALLOW" } "CA" : { "ProtectStatus": "BLOCK" } }⁠

Value¶

A list with the following syntax:

list(
  ProtectConfigurationArn = "string",
  ProtectConfigurationId = "string",
  NumberCapability = "SMS"|"VOICE"|"MMS",
  CountryRuleSet = list(
    list(
      ProtectStatus = "ALLOW"|"BLOCK"|"MONITOR"|"FILTER"
    )
  )
)

Request syntax¶

svc$update_protect_configuration_country_rule_set(
  ProtectConfigurationId = "string",
  NumberCapability = "SMS"|"VOICE"|"MMS",
  CountryRuleSetUpdates = list(
    list(
      ProtectStatus = "ALLOW"|"BLOCK"|"MONITOR"|"FILTER"
    )
  )
)