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

ListDlpSettings

Lists all DLP settings in an Amazon account.

Request Syntax


GET /accounts/AwsAccountId/data-loss-prevention/settings?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID of the Amazon account that contains the DLP settings that you want to list.

Length Constraints: Fixed length of 12.

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

Required: Yes

MaxResults

The maximum number of results to return per request.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

The token for the next set of results, or null if there are no more results.

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "DlpSettingSummaries": [ 
      { 
         "Arn": "string",
         "CreatedAt": number,
         "DlpSettingId": "string",
         "Name": "string",
         "ProviderType": "string",
         "Status": "string",
         "UpdatedAt": number
      }
   ],
   "NextToken": "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.

DlpSettingSummaries

A list of DlpSettingSummary objects for the DLP settings in the account. The list is empty if no DLP settings have been configured.

Type: Array of DlpSettingSummary objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

NextToken

The token for the next set of results, or null if there are no more results.

Type: String

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

RequestId

The Amazon 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 Amazon request ID for this request.

HTTP Status Code: 401

InternalFailureException

An internal failure occurred.

RequestId: The Amazon 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 Amazon support.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 400

ThrottlingException

Access is throttled.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 429