UpdateDeletionProtection
Update deletion protection to either allow or deny deletion of the final Region in a replication set.
Request Syntax
POST /updateDeletionProtection HTTP/1.1
Content-type: application/json
{
"arn": "string",
"clientToken": "string",
"deletionProtected": boolean
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- arn
-
The Amazon Resource Name (ARN) of the replication set to update.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern:
^arn:aws(-cn|-us-gov)?:[a-z0-9-]*:[a-z0-9-]*:([0-9]{12})?:.+$Required: Yes
- clientToken
-
A token that ensures that the operation is called only once with the specified details.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Required: No
- deletionProtected
-
Specifies if deletion protection is turned on or off in your account.
Type: Boolean
Required: Yes
Response Syntax
HTTP/1.1 204
Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have sufficient access to perform this operation.
HTTP Status Code: 403
- InternalServerException
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
Request references a resource which doesn't exist.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of UpdateDeletionProtection.
Sample Request
POST /updateDeletionProtection HTTP/1.1
Host: ssm-incidents.us-east-1.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.129-72.229.amzn2int.x86_64 exe/x86_64.amzn.2 prompt/off command/ssm-incidents.update-deletion-protection
X-Amz-Date: 20210811T183059Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210811/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 181
{
"arn": "arn:aws:ssm-incidents::111122223333:replication-set/40bd98f0-4110-2dee-b35e-b87006f9e172",
"deletionProtected": true,
"clientToken": "aa1b2cde-27e3-42ff-9cac-99380EXAMPLE"
}Sample Response
{}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
