AWS CLI Command Reference

[ aws . quicksight ]

create-dlp-setting

Description

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

See also: AWS API Documentation

Synopsis

  create-dlp-setting
--aws-account-id <value>
--dlp-setting-id <value>
--name <value>
--provider-type <value>
--provider-config <value>
--provider-outage-action <value>
--enabled | --no-enabled
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--aws-account-id (string) [required]

The ID of the Amazon Web Services account in which to create the DLP setting.

Constraints:

  • min: 12
  • max: 12
  • pattern: ^[0-9]{12}$

--dlp-setting-id (string) [required]

A unique identifier for the DLP setting.

Constraints:

  • min: 1
  • max: 256
  • pattern: [a-zA-Z0-9\-_]+

--name (string) [required]

A human-readable display name for the DLP setting.

Constraints:

  • min: 1
  • max: 255
  • pattern: [A-Za-z0-9](?:[\w- &]*[A-Za-z0-9])?

--provider-type (string) [required]

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

Possible values:

  • MICROSOFT_PURVIEW

--provider-config (tagged union structure) [required]

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.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: MicrosoftPurview.

MicrosoftPurview -> (structure)

The configuration for a Microsoft Purview DLP integration.

Credentials -> (structure) [required]

The credentials used to authenticate with Microsoft Purview.

SecretArn -> (string) [required]

The ARN of the Amazon Web Services Secrets Manager secret that contains the Microsoft Purview OAuth credentials. The secret includes the Azure tenant ID, client ID, and client secret or certificate.

Constraints:

  • min: 1
  • max: 2048
  • pattern: arn:aws(-[\w]+)*:secretsmanager:[a-z0-9\-]+:\d{12}:secret:.+

LabelActionMappings -> (list) [required]

The mappings from Microsoft Purview sensitivity labels to enforcement actions.

Constraints:

  • min: 0
  • max: 100

(structure)

Maps a sensitivity label from Microsoft Purview to an enforcement action.

LabelId -> (string) [required]

The identifier of the sensitivity label from the DLP provider.

Constraints:

  • min: 1
  • max: 512

LabelName -> (string) [required]

The display name of the sensitivity label from the DLP provider.

Constraints:

  • min: 1
  • max: 512

Action -> (string) [required]

The enforcement action to apply when content with this sensitivity label is detected. Valid values are ALLOW , BLOCK , and WARN .

Possible values:

  • ALLOW
  • WARN
  • BLOCK

UnmappedAction -> (string) [required]

The default action to apply to content that has no sensitivity label or whose label is not mapped. Valid values are ALLOW , BLOCK , and WARN .

Possible values:

  • ALLOW
  • WARN
  • BLOCK

JSON Syntax:

{
  "MicrosoftPurview": {
    "Credentials": {
      "SecretArn": "string"
    },
    "LabelActionMappings": [
      {
        "LabelId": "string",
        "LabelName": "string",
        "Action": "ALLOW"|"WARN"|"BLOCK"
      }
      ...
    ],
    "UnmappedAction": "ALLOW"|"WARN"|"BLOCK"
  }
}

--provider-outage-action (string) [required]

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

Possible values:

  • ALLOW
  • WARN
  • BLOCK

--enabled | --no-enabled (boolean) [required]

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.

--tags (list)

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

Constraints:

  • min: 1
  • max: 200

(structure)

The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.

Key -> (string) [required]

Tag key.

Constraints:

  • min: 1
  • max: 128

Value -> (string) [required]

Tag value.

Constraints:

  • min: 1
  • max: 256

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

Arn -> (string)

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

DlpSettingId -> (string)

The ID of the created DLP setting.

Constraints:

  • min: 1
  • max: 256
  • pattern: [a-zA-Z0-9\-_]+

RequestId -> (string)

The Amazon Web Services request ID for this operation.
© Copyright 2026, Amazon Web Services. Created using Sphinx.