Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateDlpSetting

Creates a data loss prevention (DLP) setting configuration for an AWS account. A DLP setting defines the DLP provider, the enforcement behavior, and the Quick capabilities that the setting applies to.

Request Syntax


POST /accounts/AwsAccountId/data-loss-prevention/settings/DlpSettingId HTTP/1.1
Content-type: application/json

{
   "Enabled": boolean,
   "Name": "string",
   "ProviderConfig": { ... },
   "ProviderOutageAction": "string",
   "ProviderType": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID of the AWS account in which to create the DLP setting.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

DlpSettingId

A unique identifier for the DLP setting.

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

Pattern: [a-zA-Z0-9\-_]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

Enabled

Specifies whether DLP enforcement is active for this setting. Set to true to enable enforcement, or false to disable it at time of setting creation.

Type: Boolean

Required: Yes

Name

A human-readable display name for the DLP setting.

Type: String

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

Pattern: [A-Za-z0-9](?:[\w- &]*[A-Za-z0-9])?

Required: Yes

ProviderConfig

The provider-specific configuration for the DLP integration. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Type: ProviderConfig object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

ProviderOutageAction

The behavior to apply when the DLP provider is unreachable. Valid values are ALLOW, WARN, and BLOCK.

Type: String

Valid Values: ALLOW | WARN | BLOCK

Required: Yes

ProviderType

The type of external DLP provider to use for sensitivity label classification. Currently, the only supported value is MICROSOFT_PURVIEW.

Type: String

Valid Values: MICROSOFT_PURVIEW

Required: Yes

Tags

A list of resource tags to apply to the DLP setting. You can use tags to manage access to your AWS resources.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 200 items.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "DlpSettingId": "string",
   "RequestId": "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.

Arn

The Amazon Resource Name (ARN) of the created DLP setting.

Type: String

DlpSettingId

The ID of the created DLP setting.

Type: String

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

Pattern: [a-zA-Z0-9\-_]+

RequestId

The AWS request ID for this operation.

Type: String

Errors

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

AccessDeniedException

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.

RequestId: The AWS request ID for this request.

HTTP Status Code: 401

ConflictException

Updating or deleting a resource can cause an inconsistent state.

RequestId: The AWS request ID for this request.

HTTP Status Code: 409

InternalFailureException

An internal failure occurred.

RequestId: The AWS request ID for this request.

HTTP Status Code: 500

InvalidRequestException

You don't have this feature activated for your account. To fix this issue, contact AWS support.

RequestId: The AWS request ID for this request.

HTTP Status Code: 400

LimitExceededException

A limit is exceeded.

RequestId: The AWS request ID for this request.
ResourceType: Limit exceeded.

HTTP Status Code: 409

ResourceExistsException

The resource specified already exists.

RequestId: The AWS request ID for this request.
ResourceType: The resource type for this request.

HTTP Status Code: 409

ThrottlingException

Access is throttled.

RequestId: The AWS request ID for this request.

HTTP Status Code: 429