AWS cli documentation change
Summary
Updated CLI version reference, reordered parameters in command syntax, restructured inline redaction configuration documentation, and reorganized JSON syntax examples for data protection settings
Security assessment
Changes primarily involve documentation restructuring and parameter reordering without addressing specific vulnerabilities. However, the modifications enhance documentation of security-related data protection features like redaction patterns, confidence levels, and encryption context, which are security features.
Diff
diff --git a/cli/latest/reference/workspaces-web/update-data-protection-settings.md b/cli/latest/reference/workspaces-web/update-data-protection-settings.md index 0d733871e..e2aec736a 100644 --- a//cli/latest/reference/workspaces-web/update-data-protection-settings.md +++ b//cli/latest/reference/workspaces-web/update-data-protection-settings.md @@ -15 +15 @@ - * [AWS CLI 2.27.63 Command Reference](../../index.html) » + * [AWS CLI 2.28.0 Command Reference](../../index.html) » @@ -67 +66,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/worksp - [--client-token <value>] @@ -69,2 +67,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/worksp - [--description <value>] - [--display-name <value>] @@ -71,0 +69,3 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/worksp + [--display-name <value>] + [--description <value>] + [--client-token <value>] @@ -96,6 +95,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/worksp -`--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. - @@ -106,8 +99,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/worksp -`--description` (string) - -> The description of the data protection settings. - -`--display-name` (string) - -> The display name of the data protection settings. - @@ -118,16 +103,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/worksp -> 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) -> @@ -146,4 +115,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/worksp ->>> 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. ->>> @@ -154 +120 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/worksp ->>>> keywordRegex -> (string) +>>>> patternName -> (string) @@ -156 +122,5 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/worksp ->>>>> 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” +>>>>> 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”. @@ -162 +132 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/worksp ->>>> patternName -> (string) +>>>> keywordRegex -> (string) @@ -164 +134,5 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/worksp ->>>>> The pattern name for the custom pattern. +>>>>> 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” +>>> +>>> redactionPlaceHolder -> (structure) +>>> +>>>> The redaction placeholder that will replace the redacted text in session for the inline redaction pattern. @@ -166 +140 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/worksp ->>>> patternRegex -> (string) +>>>> redactionPlaceHolderType -> (string) @@ -168 +142,5 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/worksp ->>>>> 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”. +>>>>> The redaction placeholder type that will replace the redacted text in session. +>>>> +>>>> redactionPlaceHolderText -> (string) +>>>> +>>>>> The redaction placeholder text that will replace the redacted text in session for the custom text redaction placeholder type. @@ -182 +160 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/worksp ->>> redactionPlaceHolder -> (structure) +>>> confidenceLevel -> (integer) @@ -184,9 +162,17 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/worksp ->>>> 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. +>>>> 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. +> +> 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) +> +> 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. @@ -198,3 +183,0 @@ JSON Syntax: - "globalConfidenceLevel": integer, - "globalEnforcedUrls": ["string", ...], - "globalExemptUrls": ["string", ...], @@ -204 +186,0 @@ JSON Syntax: - "confidenceLevel": integer, @@ -206,2 +187,0 @@ JSON Syntax: - "keywordRegex": "string", - "patternDescription": "string", @@ -209 +189,7 @@ JSON Syntax: - "patternRegex": "string" + "patternRegex": "string", + "patternDescription": "string", + "keywordRegex": "string" + }, + "redactionPlaceHolder": { + "redactionPlaceHolderType": "CustomText", + "redactionPlaceHolderText": "string" @@ -213,4 +199 @@ JSON Syntax: - "redactionPlaceHolder": { - "redactionPlaceHolderText": "string", - "redactionPlaceHolderType": "CustomText" - } + "confidenceLevel": integer @@ -219 +202,4 @@ JSON Syntax: - ] + ], + "globalEnforcedUrls": ["string", ...], + "globalExemptUrls": ["string", ...], + "globalConfidenceLevel": integer @@ -222,0 +209,14 @@ JSON Syntax: +`--display-name` (string) + +> The display name of the data protection settings. + +`--description` (string) + +> The description of the data protection settings. + +`--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. + @@ -326,22 +325,0 @@ dataProtectionSettings -> (structure) -> 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. -> @@ -352,8 +329,0 @@ dataProtectionSettings -> (structure) -> description -> (string) -> ->> The description of the data protection settings. -> -> displayName -> (string) -> ->> The display name of the data protection settings. -> @@ -364,16 +333,0 @@ dataProtectionSettings -> (structure) ->> 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. ->>>