CreateDataProtectionSettings
Creates a data protection settings resource that can be associated with a web portal.
Request Syntax
POST /dataProtectionSettings HTTP/1.1
Content-type: application/json
{
"additionalEncryptionContext": {
"string" : "string"
},
"clientToken": "string",
"customerManagedKey": "string",
"description": "string",
"displayName": "string",
"inlineRedactionConfiguration": {
"globalConfidenceLevel": number,
"globalEnforcedUrls": [ "string" ],
"globalExemptUrls": [ "string" ],
"inlineRedactionPatterns": [
{
"builtInPatternId": "string",
"confidenceLevel": number,
"customPattern": {
"keywordRegex": "string",
"patternDescription": "string",
"patternName": "string",
"patternRegex": "string"
},
"enforcedUrls": [ "string" ],
"exemptUrls": [ "string" ],
"redactionPlaceHolder": {
"redactionPlaceHolderText": "string",
"redactionPlaceHolderType": "string"
}
}
]
},
"tags": [
{
"Key": "string",
"Value": "string"
}
]
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- additionalEncryptionContext
-
Additional encryption context of the data protection settings.
Type: String to string map
Key Length Constraints: Minimum length of 0. Maximum length of 131072.
Key Pattern:
^[\s\S]*$Value Length Constraints: Minimum length of 0. Maximum length of 131072.
Value Pattern:
^[\s\S]*$Required: No
- clientToken
-
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.
If you do not specify a client token, one is automatically generated by the AWS SDK.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Required: No
- customerManagedKey
-
The custom managed key of the data protection settings.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$Required: No
- description
-
The description of the data protection settings.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^[ _\-\d\w]+$Required: No
- displayName
-
The display name of the data protection settings.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[ _\-\d\w]+$Required: No
- inlineRedactionConfiguration
-
The inline redaction configuration of the data protection settings that will be applied to all sessions.
Type: InlineRedactionConfiguration object
Required: No
-
The tags to add to the data protection settings resource. A tag is a key-value pair.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"dataProtectionSettingsArn": "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.
- dataProtectionSettingsArn
-
The ARN of the data protection settings resource.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Access is denied.
HTTP Status Code: 403
- ConflictException
-
There is a conflict.
HTTP Status Code: 409
- InternalServerException
-
There is an internal server error.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource cannot be found.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
The service quota has been exceeded.
HTTP Status Code: 402
- ThrottlingException
-
There is a throttling error.
HTTP Status Code: 429
- ValidationException
-
There is a validation error.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
