CreateProtectConfiguration
Create a new protect configuration. By default all country rule sets for each capability are set to ALLOW. Update the country rule sets using UpdateProtectConfigurationCountryRuleSet. A protect configurations name is stored as a Tag with the key set to Name and value as the name of the protect configuration.
Request Syntax
{
"ClientToken": "string",
"DeletionProtectionEnabled": boolean,
"Tags": [
{
"Key": "string",
"Value": "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.
- ClientToken
-
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[!-~]+Required: No
- DeletionProtectionEnabled
-
When set to true deletion protection is enabled. By default this is set to false.
Type: Boolean
Required: No
- Tags
-
An array of key and value pair tags that are associated with the resource.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
Response Syntax
{
"AccountDefault": boolean,
"CreatedTimestamp": number,
"DeletionProtectionEnabled": boolean,
"ProtectConfigurationArn": "string",
"ProtectConfigurationId": "string",
"Tags": [
{
"Key": "string",
"Value": "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.
- AccountDefault
-
This is true if the protect configuration is set as your account default protect configuration.
Type: Boolean
- CreatedTimestamp
-
The time when the protect configuration was created, in UNIX epoch time
format. Type: Timestamp
- DeletionProtectionEnabled
-
When set to true deletion protection is enabled. By default this is set to false.
Type: Boolean
- 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_-]+ - Tags
-
An array of key and value pair tags that are associated with the resource.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
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
- ServiceQuotaExceededException
-
The request would cause a service quota to be exceeded.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
