AWS cli documentation change
Summary
Updated ClientMetadata documentation to clarify Lambda trigger interactions and payload structure. Added --cli-error-format parameter and CLI version update.
Security assessment
The changes clarify how ClientMetadata is passed to Lambda triggers during authentication workflows. While this improves documentation accuracy around security-related custom workflows, there is no explicit mention of addressing a vulnerability. The updates help developers properly implement security features but don't fix a disclosed security issue.
Diff
diff --git a/cli/latest/reference/cognito-idp/admin-initiate-auth.md b/cli/latest/reference/cognito-idp/admin-initiate-auth.md index 09f16c4b3..ab633fd6d 100644 --- a//cli/latest/reference/cognito-idp/admin-initiate-auth.md +++ b//cli/latest/reference/cognito-idp/admin-initiate-auth.md @@ -15 +15 @@ - * [AWS CLI 2.33.29 Command Reference](../../index.html) » + * [AWS CLI 2.34.0 Command Reference](../../index.html) » @@ -112,0 +113 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/cognit + [--cli-error-format <value>] @@ -252 +253 @@ JSON Syntax: -> A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers. +> A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning Lambda functions to user pool triggers. @@ -254 +255,5 @@ JSON Syntax: -> You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers: +> When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute that provides the data that you assigned to the ClientMetadata parameter in your request. In your function code, you can process the `clientMetadata` value to enhance your workflow for your specific needs. +> +> To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see [Connecting API actions to Lambda triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-working-with-lambda-triggers.html#lambda-triggers-by-event) in the _Amazon Cognito Developer Guide_ . +> +> The `ClientMetadata` value is passed as input to the functions for only the following triggers: @@ -262,3 +267 @@ JSON Syntax: -> When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a `validationData` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminInitiateAuth request. In your function code in Lambda, you can process the `validationData` value to enhance your workflow for your specific needs. -> -> When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn’t provide the ClientMetadata value as input: +> This request also invokes the functions for the following triggers, but doesn’t pass `ClientMetadata` : @@ -275,2 +277,0 @@ JSON Syntax: -> -> For more information, see [Using Lambda triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) in the _Amazon Cognito Developer Guide_ . @@ -493,0 +495 @@ The formatting style for command output. + * off @@ -559,0 +562,13 @@ 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 + + + @@ -804 +819 @@ AvailableChallenges -> (list) - * [AWS CLI 2.33.29 Command Reference](../../index.html) » + * [AWS CLI 2.34.0 Command Reference](../../index.html) »