Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateProtectConfigurationCountryRuleSet

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

Request Syntax


{
   "CountryRuleSetUpdates": { 
      "string" : { 
         "ProtectStatus": "string"
      }
   },
   "NumberCapability": "string",
   "ProtectConfigurationId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CountryRuleSetUpdates

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" } }

Type: String to ProtectConfigurationCountryRuleSetInformation object map

Map Entries: Maximum number of 300 items.

Key Length Constraints: Fixed length of 2.

Key Pattern: [A-Z]{2}

Required: Yes

NumberCapability

The number capability to apply the CountryRuleSetUpdates updates to.

Type: String

Valid Values: SMS | VOICE | MMS

Required: Yes

ProtectConfigurationId

The unique identifier for the protect configuration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [A-Za-z0-9_:/-]+

Required: Yes

Response Syntax


{
   "CountryRuleSet": { 
      "string" : { 
         "ProtectStatus": "string"
      }
   },
   "NumberCapability": "string",
   "ProtectConfigurationArn": "string",
   "ProtectConfigurationId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CountryRuleSet

An array of ProtectConfigurationCountryRuleSetInformation containing the rules for the NumberCapability.

Type: String to ProtectConfigurationCountryRuleSetInformation object map

Map Entries: Maximum number of 300 items.

Key Length Constraints: Fixed length of 2.

Key Pattern: [A-Z]{2}

NumberCapability

The number capability that was updated

Type: String

Valid Values: SMS | VOICE | MMS

ProtectConfigurationArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: arn:\S+

ProtectConfigurationId

The unique identifier for the protect configuration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9_-]+

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The request was denied because you don't have sufficient permissions to access the resource.

HTTP Status Code: 400

InternalServerException

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

HTTP Status Code: 500

ResourceNotFoundException

A requested resource couldn't be found.

HTTP Status Code: 400

ThrottlingException

An error that occurred because too many requests were sent during a certain amount of time.

HTTP Status Code: 400

ValidationException

A validation exception for a field.

HTTP Status Code: 400