UpdateProtectConfiguration
Update the setting for an existing protect configuration.
Request Syntax
{
"DeletionProtectionEnabled": boolean
,
"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.
- DeletionProtectionEnabled
-
When set to true deletion protection is enabled. By default this is set to false.
Type: Boolean
Required: No
- 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
{
"AccountDefault": boolean,
"CreatedTimestamp": number,
"DeletionProtectionEnabled": boolean,
"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.
- 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
-
The status of deletion protection for the protect configuration. 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_-]+
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: