openapi: 3.0.0
info:
version: '2014-06-30'
x-release: v4
title: 'Amazon Cognito Identity #X Amz Target=AWSCognitoIdentityProviderService.AddCustomAttributes #X Amz Target=AWSCognitoIdentityProviderService.AddCustomAttributes #X Amz Target=AWSCognitoIdentityProviderService.AdminRespondToAuthChallenge API'
description: <fullname>Amazon Cognito Federated Identities</fullname> <p>Amazon Cognito Federated Identities is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. It uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.</p> <p>Using Amazon Cognito Federated Identities, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon Cognito user pool, and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.</p> <p>For a description of the authentication flow from the Amazon Cognito Developer Guide see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Authentication Flow</a>.</p> <p>For more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html">Amazon Cognito Federated Identities</a>.</p>
x-logo:
url: https://twitter.com/awscloud/profile_image?size=original
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: cognito-identity
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/cognito-identity-2014-06-30.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://cognito-identity.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon Cognito Identity multi-region endpoint
- url: https://cognito-identity.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon Cognito Identity multi-region endpoint
- url: http://cognito-identity.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon Cognito Identity endpoint for China (Beijing) and China (Ningxia)
- url: https://cognito-identity.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon Cognito Identity endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=AWSCognitoIdentityProviderService.AdminRespondToAuthChallenge'
paths:
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminRespondToAuthChallenge:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: AdminRespondToAuthChallenge
description: <p>Responds to an authentication challenge, as an administrator.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note> <note> <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.</p> <p class="title"> <b>Learn more</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a> </p> </li> </ul> </note>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AdminRespondToAuthChallengeResponse'
examples:
AdminRespondToAuthChallenge200Example:
summary: Default AdminRespondToAuthChallenge 200 response
x-microcks-default: true
value:
ChallengeName: example
Session: example
ChallengeParameters: example
AuthenticationResult: example
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
AdminRespondToAuthChallenge480Example:
summary: Default AdminRespondToAuthChallenge 480 response
x-microcks-default: true
value: example
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
examples:
AdminRespondToAuthChallenge481Example:
summary: Default AdminRespondToAuthChallenge 481 response
x-microcks-default: true
value: example
'482':
description: NotAuthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/NotAuthorizedException'
examples:
AdminRespondToAuthChallenge482Example:
summary: Default AdminRespondToAuthChallenge 482 response
x-microcks-default: true
value: example
'483':
description: CodeMismatchException
content:
application/json:
schema:
$ref: '#/components/schemas/CodeMismatchException'
examples:
AdminRespondToAuthChallenge483Example:
summary: Default AdminRespondToAuthChallenge 483 response
x-microcks-default: true
value: example
'484':
description: ExpiredCodeException
content:
application/json:
schema:
$ref: '#/components/schemas/ExpiredCodeException'
examples:
AdminRespondToAuthChallenge484Example:
summary: Default AdminRespondToAuthChallenge 484 response
x-microcks-default: true
value: example
'485':
description: UnexpectedLambdaException
content:
application/json:
schema:
$ref: '#/components/schemas/UnexpectedLambdaException'
examples:
AdminRespondToAuthChallenge485Example:
summary: Default AdminRespondToAuthChallenge 485 response
x-microcks-default: true
value: example
'486':
description: InvalidPasswordException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidPasswordException'
examples:
AdminRespondToAuthChallenge486Example:
summary: Default AdminRespondToAuthChallenge 486 response
x-microcks-default: true
value: example
'487':
description: UserLambdaValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/UserLambdaValidationException'
examples:
AdminRespondToAuthChallenge487Example:
summary: Default AdminRespondToAuthChallenge 487 response
x-microcks-default: true
value: example
'488':
description: InvalidLambdaResponseException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidLambdaResponseException'
examples:
AdminRespondToAuthChallenge488Example:
summary: Default AdminRespondToAuthChallenge 488 response
x-microcks-default: true
value: example
'489':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
AdminRespondToAuthChallenge489Example:
summary: Default AdminRespondToAuthChallenge 489 response
x-microcks-default: true
value: example
'490':
description: InvalidUserPoolConfigurationException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidUserPoolConfigurationException'
examples:
AdminRespondToAuthChallenge490Example:
summary: Default AdminRespondToAuthChallenge 490 response
x-microcks-default: true
value: example
'491':
description: InternalErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalErrorException'
examples:
AdminRespondToAuthChallenge491Example:
summary: Default AdminRespondToAuthChallenge 491 response
x-microcks-default: true
value: example
'492':
description: MFAMethodNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/MFAMethodNotFoundException'
examples:
AdminRespondToAuthChallenge492Example:
summary: Default AdminRespondToAuthChallenge 492 response
x-microcks-default: true
value: example
'493':
description: InvalidSmsRoleAccessPolicyException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidSmsRoleAccessPolicyException'
examples:
AdminRespondToAuthChallenge493Example:
summary: Default AdminRespondToAuthChallenge 493 response
x-microcks-default: true
value: example
'494':
description: InvalidSmsRoleTrustRelationshipException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidSmsRoleTrustRelationshipException'
examples:
AdminRespondToAuthChallenge494Example:
summary: Default AdminRespondToAuthChallenge 494 response
x-microcks-default: true
value: example
'495':
description: AliasExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/AliasExistsException'
examples:
AdminRespondToAuthChallenge495Example:
summary: Default AdminRespondToAuthChallenge 495 response
x-microcks-default: true
value: example
'496':
description: PasswordResetRequiredException
content:
application/json:
schema:
$ref: '#/components/schemas/PasswordResetRequiredException'
examples:
AdminRespondToAuthChallenge496Example:
summary: Default AdminRespondToAuthChallenge 496 response
x-microcks-default: true
value: example
'497':
description: UserNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/UserNotFoundException'
examples:
AdminRespondToAuthChallenge497Example:
summary: Default AdminRespondToAuthChallenge 497 response
x-microcks-default: true
value: example
'498':
description: UserNotConfirmedException
content:
application/json:
schema:
$ref: '#/components/schemas/UserNotConfirmedException'
examples:
AdminRespondToAuthChallenge498Example:
summary: Default AdminRespondToAuthChallenge 498 response
x-microcks-default: true
value: example
'499':
description: SoftwareTokenMFANotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/SoftwareTokenMFANotFoundException'
examples:
AdminRespondToAuthChallenge499Example:
summary: Default AdminRespondToAuthChallenge 499 response
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AdminRespondToAuthChallengeRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSCognitoIdentityProviderService.AdminRespondToAuthChallenge
summary: Amazon Cognito Admin Respond to Auth Challenge
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=AWSCognitoIdentityProviderService.AdminRespondToAuthChallenge'
components:
schemas:
InvalidSmsRoleTrustRelationshipException: {}
ClientIdType:
type: string
pattern: '[\w+]+'
minLength: 1
maxLength: 128
format: password
ResourceNotFoundException: {}
InvalidUserPoolConfigurationException: {}
InvalidParameterException: {}
UserLambdaValidationException: {}
ChallengeNameType:
type: string
enum:
- SMS_MFA
- SOFTWARE_TOKEN_MFA
- SELECT_MFA_TYPE
- MFA_SETUP
- PASSWORD_VERIFIER
- CUSTOM_CHALLENGE
- DEVICE_SRP_AUTH
- DEVICE_PASSWORD_VERIFIER
- ADMIN_NO_SRP_AUTH
- NEW_PASSWORD_REQUIRED
NewDeviceMetadataType:
type: object
properties:
DeviceKey:
allOf:
- $ref: '#/components/schemas/DeviceKeyType'
- description: The device key.
DeviceGroupKey:
allOf:
- $ref: '#/components/schemas/StringType'
- description: The device group key.
description: The new device metadata type.
ChallengeParametersType:
type: object
additionalProperties:
$ref: '#/components/schemas/StringType'
TokenModelType:
type: string
pattern: '[A-Za-z0-9-_=.]+'
format: password
ChallengeResponsesType:
type: object
additionalProperties:
$ref: '#/components/schemas/StringType'
UserNotFoundException: {}
IntegerType:
type: integer
AdminRespondToAuthChallengeResponse:
type: object
properties:
ChallengeName:
allOf:
- $ref: '#/components/schemas/ChallengeNameType'
- description: The name of the challenge. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html">AdminInitiateAuth</a>.
Session:
allOf:
- $ref: '#/components/schemas/SessionType'
- description: The session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next <code>RespondToAuthChallenge</code> API call.
ChallengeParameters:
allOf:
- $ref: '#/components/schemas/ChallengeParametersType'
- description: The challenge parameters. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html">AdminInitiateAuth</a>.
AuthenticationResult:
allOf:
- $ref: '#/components/schemas/AuthenticationResultType'
- description: The result returned by the server in response to the authentication request.
description: Responds to the authentication challenge, as an administrator.
HttpHeader:
type: object
properties:
headerName:
allOf:
- $ref: '#/components/schemas/StringType'
- description: The header name.
headerValue:
allOf:
- $ref: '#/components/schemas/StringType'
- description: The header value.
description: The HTTP header.
StringType:
type: string
minLength: 0
maxLength: 131072
InvalidLambdaResponseException: {}
ContextDataType:
type: object
required:
- IpAddress
- ServerName
- ServerPath
- HttpHeaders
properties:
IpAddress:
allOf:
- $ref: '#/components/schemas/StringType'
- description: The source IP address of your user's device.
ServerName:
allOf:
- $ref: '#/components/schemas/StringType'
- description: Your server endpoint where this API is invoked.
ServerPath:
allOf:
- $ref: '#/components/schemas/StringType'
- description: Your server path where this API is invoked.
HttpHeaders:
allOf:
- $ref: '#/components/schemas/HttpHeaderList'
- description: HttpHeaders received on your server in same order.
EncodedData:
allOf:
- $ref: '#/components/schemas/StringType'
- description: Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint">Adding user device and session data to API requests</a>.
description: Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
SessionType:
type: string
minLength: 20
maxLength: 2048
AliasExistsException: {}
ClientMetadataType:
type: object
additionalProperties:
$ref: '#/components/schemas/StringType'
HttpHeaderList:
type: array
items:
$ref: '#/components/schemas/HttpHeader'
UnexpectedLambdaException: {}
UserPoolIdType:
type: string
pattern: '[\w-]+_[0-9a-zA-Z]+'
minLength: 1
maxLength: 55
AuthenticationResultType:
type: object
properties:
AccessToken:
allOf:
- $ref: '#/components/schemas/TokenModelType'
- description: A valid access token that Amazon Cognito issued to the user who you want to authenticate.
ExpiresIn:
allOf:
- $ref: '#/components/schemas/IntegerType'
- description: The expiration period of the authentication result in seconds.
TokenType:
allOf:
- $ref: '#/components/schemas/StringType'
- description: The token type.
RefreshToken:
allOf:
- $ref: '#/components/schemas/TokenModelType'
- description: The refresh token.
IdToken:
allOf:
- $ref: '#/components/schemas/TokenModelType'
- description: The ID token.
NewDeviceMetadata:
allOf:
- $ref: '#/components/schemas/NewDeviceMetadataType'
- description: The new device metadata from an authentication result.
description: The authentication result.
DeviceKeyType:
type: string
pattern: '[\w-]+_[0-9a-f-]+'
minLength: 1
maxLength: 55
PasswordResetRequiredException: {}
InvalidSmsRoleAccessPolicyException: {}
SoftwareTokenMFANotFoundException: {}
NotAuthorizedException: {}
InternalErrorException: {}
ExpiredCodeException: {}
UserNotConfirmedException: {}
TooManyRequestsException: {}
AdminRespondToAuthChallengeRequest:
type: object
required:
- UserPoolId
- ClientId
- ChallengeName
title: AdminRespondToAuthChallengeRequest
properties:
UserPoolId:
allOf:
- $ref: '#/components/schemas/UserPoolIdType'
- description: The ID of the Amazon Cognito user pool.
ClientId:
allOf:
- $ref: '#/components/schemas/ClientIdType'
- description: The app client ID.
ChallengeName:
allOf:
- $ref: '#/components/schemas/ChallengeNameType'
- description: The challenge name. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html">AdminInitiateAuth</a>.
ChallengeResponses:
allOf:
- $ref: '#/components/schemas/ChallengeResponsesType'
- description: '<p>The challenge responses. These are inputs corresponding to the value of <code>ChallengeName</code>, for example:</p> <ul> <li> <p> <code>SMS_MFA</code>: <code>SMS_MFA_CODE</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret).</p> </li> <li> <p> <code>PASSWORD_VERIFIER</code>: <code>PASSWORD_CLAIM_SIGNATURE</code>, <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, <code>TIMESTAMP</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret).</p> <note> <p> <code>PASSWORD_VERIFIER</code> requires <code>DEVICE_KEY</code> when signing in with a remembered device.</p> </note> </li> <li> <p> <code>ADMIN_NO_SRP_AUTH</code>: <code>PASSWORD</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret). </p> </li> <li> <p> <code>NEW_PASSWORD_REQUIRED</code>: <code>NEW_PASSWORD</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as <code>requiredAttributes</code> in the <code>AdminInitiateAuth</code> response, add a <code>userAttributes.<i>attributename</i> </code> parameter. This parameter can also set values for writable attributes that aren''t required by your user pool.</p> <note> <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can''t modify a required attribute that already has a value. In <code>AdminRespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the <code>requiredAttributes</code> parameter, then use the <code>AdminUpdateUserAttributes</code> API operation to modify the value of any additional attributes.</p> </note> </li> <li> <p> <code>MFA_SETUP</code> requires <code>USERNAME</code>, plus you must use the session value returned by <code>VerifySoftwareToken</code> in the <code>Session</code> parameter.</p> </li> </ul> <p>The value of the <code>USERNAME</code> attribute must be the user''s actual username, not an alias (such as an email address or phone number). To make this simpler, the <code>AdminInitiateAuth</code> response includes the actual username value in the <code>USERNAMEUSER_ID_FOR_SRP</code> attribute. This happens even if you specified an alias in your call to <code>AdminInitiateAuth</code>.</p> <p>For more information about <code>SECRET_HASH</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash">Computing secret hash values</a>. For information about <code>DEVICE_KEY</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>.</p>'
Session:
allOf:
- $ref: '#/components/schemas/SessionType'
- description: The session that should be passed both ways in challenge-response calls to the service. If an <code>InitiateAuth</code> or <code>RespondToAuthChallenge</code> API call determines that the caller must pass another challenge, it returns a session with other challenge parameters. This session should be passed as it is to the next <code>RespondToAuthChallenge</code> API call.
AnalyticsMetadata:
allOf:
- $ref: '#/components/schemas/AnalyticsMetadataType'
- description: The analytics metadata for collecting Amazon Pinpoint metrics for <code>AdminRespondToAuthChallenge</code> calls.
ContextData:
allOf:
- $ref: '#/components/schemas/ContextDataType'
- description: Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
ClientMetadata:
allOf:
- $ref: '#/components/schemas/ClientMetadataType'
- description: '<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers: </p> <ul> <li> <p>pre sign-up</p> </li> <li> <p>custom message</p> </li> <li> <p>post authentication</p> </li> <li> <p>user migration</p> </li> <li> <p>pre token generation</p> </li> <li> <p>define auth challenge</p> </li> <li> <p>create auth challenge</p> </li> <li> <p>verify auth challenge response</p> </li> </ul> <p>When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute that provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won''t do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn''t include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don''t use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>'
description: The request to respond to the authentication challenge, as an administrator.
InvalidPasswordException: {}
CodeMismatchException: {}
AnalyticsMetadataType:
type: object
properties:
AnalyticsEndpointId:
allOf:
- $ref: '#/components/schemas/StringType'
- description: The endpoint ID.
description: <p>An Amazon Pinpoint analytics endpoint.</p> <p>An endpoint uniquely identifies a mobile device, email address, or phone number that can receive messages from Amazon Pinpoint analytics. For more information about Amazon Web Services Regions that can contain Amazon Pinpoint resources for use with Amazon Cognito user pools, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html">Using Amazon Pinpoint analytics with Amazon Cognito user pools</a>.</p>
MFAMethodNotFoundException: {}
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
ur
# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/openapi/amazon-cognito-x-amz-target-awscognitoidentityproviderservice-adminrespondtoauthchallenge-api-openapi.yml