Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . workspaces-web ]

update-data-protection-settings

Description

Updates data protection settings.

See also: AWS API Documentation

Synopsis

  update-data-protection-settings
[--client-token <value>]
--data-protection-settings-arn <value>
[--description <value>]
[--display-name <value>]
[--inline-redaction-configuration <value>]
[--cli-input-json <value>]
[--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>]

Options

--client-token (string)

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 return the result from the original successful request.

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

--data-protection-settings-arn (string)

The ARN of the data protection settings.

--description (string)

The description of the data protection settings.

--display-name (string)

The display name of the data protection settings.

--inline-redaction-configuration (structure)

The inline redaction configuration of the data protection settings that will be applied to all sessions.

globalConfidenceLevel -> (integer)

The global confidence level for the inline redaction configuration. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This is applied to patterns that do not have a pattern-level confidence level. Defaults to confidence level 2.

globalEnforcedUrls -> (list)

The global enforced URL configuration for the inline redaction configuration. This is applied to patterns that do not have a pattern-level enforced URL list.

(string)

globalExemptUrls -> (list)

The global exempt URL configuration for the inline redaction configuration. This is applied to patterns that do not have a pattern-level exempt URL list.

(string)

inlineRedactionPatterns -> (list)

The inline redaction patterns to be enabled for the inline redaction configuration.

(structure)

The set of patterns that determine the data types redacted in session.

builtInPatternId -> (string)

The built-in pattern from the list of preconfigured patterns. Either a customPattern or builtInPatternId is required.

confidenceLevel -> (integer)

The confidence level for inline redaction pattern. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This overrides the global confidence level.

customPattern -> (structure)

>The configuration for a custom pattern. Either a customPattern or builtInPatternId is required.

keywordRegex -> (string)

The keyword regex for the customer pattern. After there is a match to the pattern regex, the keyword regex is used to search within the proximity of the match. If there is a keyword match, then the match is confirmed. If no keyword regex is provided, the pattern regex match will automatically be confirmed. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example, “/ab+c/gi”

patternDescription -> (string)

The pattern description for the customer pattern.

patternName -> (string)

The pattern name for the custom pattern.

patternRegex -> (string)

The pattern regex for the customer pattern. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example: “/ab+c/gi”.

enforcedUrls -> (list)

The enforced URL configuration for the inline redaction pattern. This will override the global enforced URL configuration.

(string)

exemptUrls -> (list)

The exempt URL configuration for the inline redaction pattern. This will override the global exempt URL configuration for the inline redaction pattern.

(string)

redactionPlaceHolder -> (structure)

The redaction placeholder that will replace the redacted text in session for the inline redaction pattern.

redactionPlaceHolderText -> (string)

The redaction placeholder text that will replace the redacted text in session for the custom text redaction placeholder type.

redactionPlaceHolderType -> (string)

The redaction placeholder type that will replace the redacted text in session.

JSON Syntax:

{
  "globalConfidenceLevel": integer,
  "globalEnforcedUrls": ["string", ...],
  "globalExemptUrls": ["string", ...],
  "inlineRedactionPatterns": [
    {
      "builtInPatternId": "string",
      "confidenceLevel": integer,
      "customPattern": {
        "keywordRegex": "string",
        "patternDescription": "string",
        "patternName": "string",
        "patternRegex": "string"
      },
      "enforcedUrls": ["string", ...],
      "exemptUrls": ["string", ...],
      "redactionPlaceHolder": {
        "redactionPlaceHolderText": "string",
        "redactionPlaceHolderType": "CustomText"
      }
    }
    ...
  ]
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

--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.

Output

dataProtectionSettings -> (structure)

The data protection settings.

additionalEncryptionContext -> (map)

The additional encryption context of the data protection settings.

key -> (string)

value -> (string)

associatedPortalArns -> (list)

A list of web portal ARNs that this data protection settings resource is associated with.

(string)

creationDate -> (timestamp)

The creation date timestamp of the data protection settings.

customerManagedKey -> (string)

The customer managed key used to encrypt sensitive information in the data protection settings.

dataProtectionSettingsArn -> (string)

The ARN of the data protection settings resource.

description -> (string)

The description of the data protection settings.

displayName -> (string)

The display name of the data protection settings.

inlineRedactionConfiguration -> (structure)

The inline redaction configuration for the data protection settings.

globalConfidenceLevel -> (integer)

The global confidence level for the inline redaction configuration. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This is applied to patterns that do not have a pattern-level confidence level. Defaults to confidence level 2.

globalEnforcedUrls -> (list)

The global enforced URL configuration for the inline redaction configuration. This is applied to patterns that do not have a pattern-level enforced URL list.

(string)

globalExemptUrls -> (list)

The global exempt URL configuration for the inline redaction configuration. This is applied to patterns that do not have a pattern-level exempt URL list.

(string)

inlineRedactionPatterns -> (list)

The inline redaction patterns to be enabled for the inline redaction configuration.

(structure)

The set of patterns that determine the data types redacted in session.

builtInPatternId -> (string)

The built-in pattern from the list of preconfigured patterns. Either a customPattern or builtInPatternId is required.

confidenceLevel -> (integer)

The confidence level for inline redaction pattern. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This overrides the global confidence level.

customPattern -> (structure)

>The configuration for a custom pattern. Either a customPattern or builtInPatternId is required.

keywordRegex -> (string)

The keyword regex for the customer pattern. After there is a match to the pattern regex, the keyword regex is used to search within the proximity of the match. If there is a keyword match, then the match is confirmed. If no keyword regex is provided, the pattern regex match will automatically be confirmed. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example, “/ab+c/gi”

patternDescription -> (string)

The pattern description for the customer pattern.

patternName -> (string)

The pattern name for the custom pattern.

patternRegex -> (string)

The pattern regex for the customer pattern. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example: “/ab+c/gi”.

enforcedUrls -> (list)

The enforced URL configuration for the inline redaction pattern. This will override the global enforced URL configuration.

(string)

exemptUrls -> (list)

The exempt URL configuration for the inline redaction pattern. This will override the global exempt URL configuration for the inline redaction pattern.

(string)

redactionPlaceHolder -> (structure)

The redaction placeholder that will replace the redacted text in session for the inline redaction pattern.

redactionPlaceHolderText -> (string)

The redaction placeholder text that will replace the redacted text in session for the custom text redaction placeholder type.

redactionPlaceHolderType -> (string)

The redaction placeholder type that will replace the redacted text in session.