Class: AWS.CognitoIdentityServiceProvider

var params = {
  GroupName: 'STRING_VALUE', /* required */
  UserPoolId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE' /* required */
};
cognitoidentityserviceprovider.adminAddUserToGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UserPoolId — (String)

    The user pool ID for the user pool.

  • Username — (String)

    The username for the user.

  • GroupName — (String)

    The group name.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  UserPoolId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE', /* required */
  ClientMetadata: {
    '<StringType>': 'STRING_VALUE',
    /* '<StringType>': ... */
  }
};
cognitoidentityserviceprovider.adminConfirmSignUp(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UserPoolId — (String)

    The user pool ID for which you want to confirm user registration.

  • Username — (String)

    The user name for which you want to confirm user registration.

  • ClientMetadata — (map<String>)

    A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

    If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in Lambda, you can process the ClientMetadata value to enhance your workflow for your specific needs.

    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

    Note: When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

    • 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.
    • Validate the ClientMetadata value.
    • Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  UserPoolId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE', /* required */
  ClientMetadata: {
    '<StringType>': 'STRING_VALUE',
    /* '<StringType>': ... */
  },
  DesiredDeliveryMediums: [
    SMS | EMAIL,
    /* more items */
  ],
  ForceAliasCreation: true || false,
  MessageAction: RESEND | SUPPRESS,
  TemporaryPassword: 'STRING_VALUE',
  UserAttributes: [
    {
      Name: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  ValidationData: [
    {
      Name: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
cognitoidentityserviceprovider.adminCreateUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UserPoolId — (String)

    The user pool ID for the user pool where the user will be created.

  • Username — (String)

    The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username can't be changed.

  • UserAttributes — (Array<map>)

    An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (when creating a user pool or in the Attributes tab of the console) either you should supply (in your call to AdminCreateUser) or the user should supply (when they sign up in response to your welcome message).

    For custom attributes, you must prepend the custom: prefix to the attribute name.

    To send a message inviting the user to sign up, you must specify the user's email address or phone number. You can do this in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.

    In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. You can also do this by calling AdminUpdateUserAttributes.

    • email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter.

    • phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums parameter.

    • Name — required — (String)

      The name of the attribute.

    • Value — (String)

      The value of the attribute.

  • ValidationData — (Array<map>)

    The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.

    To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.

    The user's validation data isn't persisted.

    • Name — required — (String)

      The name of the attribute.

    • Value — (String)

      The value of the attribute.

  • TemporaryPassword — (String)

    The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.

    The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page, along with a new password to be used in all future sign-ins.

    This parameter isn't required. If you don't specify a value, Amazon Cognito generates one for you.

    The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter.

  • ForceAliasCreation — (Boolean)

    This parameter is used only if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.

    If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.

    If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.

  • MessageAction — (String)

    Set to RESEND to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to SUPPRESS to suppress sending the message. You can specify only one value.

    Possible values include:
    • "RESEND"
    • "SUPPRESS"
  • DesiredDeliveryMediums — (Array<String>)

    Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the phone number will be used. The default value is "SMS". You can specify more than one value.

  • ClientMetadata — (map<String>)

    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. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

    Note: When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

    • 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.
    • Validate the ClientMetadata value.
    • Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • User — (map)

      The newly created user.

      • Username — (String)

        The user name of the user you want to describe.

      • Attributes — (Array<map>)

        A container with information about the user type attributes.

        • Name — required — (String)

          The name of the attribute.

        • Value — (String)

          The value of the attribute.

      • UserCreateDate — (Date)

        The creation date of the user.

      • UserLastModifiedDate — (Date)

        The last modified date of the user.

      • Enabled — (Boolean)

        Specifies whether the user is enabled.

      • UserStatus — (String)

        The user status. This can be one of the following:

        • UNCONFIRMED - User has been created but not confirmed.

        • CONFIRMED - User has been confirmed.

        • EXTERNAL_PROVIDER - User signed in with a third-party IdP.

        • ARCHIVED - User is no longer active.

        • UNKNOWN - User status isn't known.

        • RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.

        • FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.

        Possible values include:
        • "UNCONFIRMED"
        • "CONFIRMED"
        • "ARCHIVED"
        • "COMPROMISED"
        • "UNKNOWN"
        • "RESET_REQUIRED"
        • "FORCE_CHANGE_PASSWORD"
      • MFAOptions — (Array<map>)

        The MFA options for the user.

        • DeliveryMedium — (String)

          The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

          Possible values include:
          • "SMS"
          • "EMAIL"
        • AttributeName — (String)

          The attribute name of the MFA option type. The only valid value is phone_number.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  UserPoolId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE' /* required */
};
cognitoidentityserviceprovider.adminDeleteUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UserPoolId — (String)

    The user pool ID for the user pool where you want to delete the user.

  • Username — (String)

    The user name of the user you want to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  UserAttributeNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  UserPoolId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE' /* required */
};
cognitoidentityserviceprovider.adminDeleteUserAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UserPoolId — (String)

    The user pool ID for the user pool where you want to delete user attributes.

  • Username — (String)

    The user name of the user from which you would like to delete attributes.

  • UserAttributeNames — (Array<String>)

    An array of strings representing the user attribute names you want to delete.

    For custom attributes, you must prepend the custom: prefix to the attribute name.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  User: { /* required */
    ProviderAttributeName: 'STRING_VALUE',
    ProviderAttributeValue: 'STRING_VALUE',
    ProviderName: 'STRING_VALUE'
  },
  UserPoolId: 'STRING_VALUE' /* required */
};
cognitoidentityserviceprovider.adminDisableProviderForUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UserPoolId — (String)

    The user pool ID for the user pool.

  • User — (map)

    The user to be disabled.

    • ProviderName — (String)

      The name of the provider, such as Facebook, Google, or Login with Amazon.

    • ProviderAttributeName — (String)

      The name of the provider attribute to link to, such as NameID.

    • ProviderAttributeValue — (String)

      The value of the provider attribute to link to, such as xxxxx_account.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  UserPoolId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE' /* required */
};
cognitoidentityserviceprovider.adminDisableUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UserPoolId — (String)

    The user pool ID for the user pool where you want to disable the user.

  • Username — (String)

    The user name of the user you want to disable.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  UserPoolId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE' /* required */
};
cognitoidentityserviceprovider.adminEnableUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UserPoolId — (String)

    The user pool ID for the user pool where you want to enable the user.

  • Username — (String)

    The user name of the user you want to enable.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DeviceKey: 'STRING_VALUE', /* required */
  UserPoolId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE' /* required */
};
cognitoidentityserviceprovider.adminForgetDevice(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UserPoolId — (String)

    The user pool ID.

  • Username — (String)

    The user name.

  • DeviceKey — (String)

    The device key.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DeviceKey: 'STRING_VALUE', /* required */
  UserPoolId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE' /* required */
};
cognitoidentityserviceprovider.adminGetDevice(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DeviceKey — (String)

    The device key.

  • UserPoolId — (String)

    The user pool ID.

  • Username — (String)

    The user name.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Device — (map)

      The device.

      • DeviceKey — (String)

        The device key.

      • DeviceAttributes — (Array<map>)

        The device attributes.

        • Name — required — (String)

          The name of the attribute.

        • Value — (String)

          The value of the attribute.

      • DeviceCreateDate — (Date)

        The creation date of the device.

      • DeviceLastModifiedDate — (Date)

        The last modified date of the device.

      • DeviceLastAuthenticatedDate — (Date)

        The date when the device was last authenticated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  UserPoolId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE' /* required */
};
cognitoidentityserviceprovider.adminGetUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UserPoolId — (String)

    The user pool ID for the user pool where you want to get information about the user.

  • Username — (String)

    The user name of the user you want to retrieve.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Username — (String)

      The user name of the user about whom you're receiving information.

    • UserAttributes — (Array<map>)

      An array of name-value pairs representing user attributes.

      • Name — required — (String)

        The name of the attribute.

      • Value — (String)

        The value of the attribute.

    • UserCreateDate — (Date)

      The date the user was created.

    • UserLastModifiedDate — (Date)

      The date the user was last modified.

    • Enabled — (Boolean)

      Indicates that the status is enabled.

    • UserStatus — (String)

      The user status. Can be one of the following:

      • UNCONFIRMED - User has been created but not confirmed.

      • CONFIRMED - User has been confirmed.

      • ARCHIVED - User is no longer active.

      • UNKNOWN - User status isn't known.

      • RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.

      • FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.

      Possible values include:
      • "UNCONFIRMED"
      • "CONFIRMED"
      • "ARCHIVED"
      • "COMPROMISED"
      • "UNKNOWN"
      • "RESET_REQUIRED"
      • "FORCE_CHANGE_PASSWORD"
    • MFAOptions — (Array<map>)

      This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

      • DeliveryMedium — (String)

        The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

        Possible values include:
        • "SMS"
        • "EMAIL"
      • AttributeName — (String)

        The attribute name of the MFA option type. The only valid value is phone_number.

    • PreferredMfaSetting — (String)

      The user's preferred MFA setting.

    • UserMFASettingList — (Array<String>)

      The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AuthFlow: USER_SRP_AUTH | REFRESH_TOKEN_AUTH | REFRESH_TOKEN | CUSTOM_AUTH | ADMIN_NO_SRP_AUTH | USER_PASSWORD_AUTH | ADMIN_USER_PASSWORD_AUTH, /* required */
  ClientId: 'STRING_VALUE', /* required */
  UserPoolId: 'STRING_VALUE', /* required */
  AnalyticsMetadata: {
    AnalyticsEndpointId: 'STRING_VALUE'
  },
  AuthParameters: {
    '<StringType>': 'STRING_VALUE',
    /* '<StringType>': ... */
  },
  ClientMetadata: {
    '<StringType>': 'STRING_VALUE',
    /* '<StringType>': ... */
  },
  ContextData: {
    HttpHeaders: [ /* required */
      {
        headerName: 'STRING_VALUE',
        headerValue: 'STRING_VALUE'
      },
      /* more items */
    ],
    IpAddress: 'STRING_VALUE', /* required */
    ServerName: 'STRING_VALUE', /* required */
    ServerPath: 'STRING_VALUE', /* required */
    EncodedData: 'STRING_VALUE'
  }
};
cognitoidentityserviceprovider.adminInitiateAuth(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UserPoolId — (String)

    The ID of the Amazon Cognito user pool.

  • ClientId — (String)

    The app client ID.

  • AuthFlow — (String)

    The authentication flow for this call to run. The API action will depend on this value. For example:

    • REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.

    • USER_SRP_AUTH will take in USERNAME and SRP_A and return the Secure Remote Password (SRP) protocol variables to be used for next challenge execution.

    • ADMIN_USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens.

    Valid values include:

    • USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.

    • REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.

    • CUSTOM_AUTH: Custom authentication flow.

    • ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.

    • ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow, Amazon Cognito receives the password in the request instead of using the SRP process to verify passwords.

    Possible values include:
    • "USER_SRP_AUTH"
    • "REFRESH_TOKEN_AUTH"
    • "REFRESH_TOKEN"
    • "CUSTOM_AUTH"
    • "ADMIN_NO_SRP_AUTH"
    • "USER_PASSWORD_AUTH"
    • "ADMIN_USER_PASSWORD_AUTH"
  • AuthParameters — (map<String>)

    The authentication parameters. These are inputs corresponding to the AuthFlow that you're invoking. The required values depend on the value of AuthFlow:

    • For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.

    • For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.

    • For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), PASSWORD (required), DEVICE_KEY.

    • For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).

  • ClientMetadata — (map<String>)

    A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.

    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:

    • Pre signup

    • Pre authentication

    • User migration

    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:

    • Post authentication

    • Custom message

    • Pre token generation

    • Create auth challenge

    • Define auth challenge

    • Verify auth challenge

    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

    Note: When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

    • 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.
    • Validate the ClientMetadata value.
    • Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
  • AnalyticsMetadata — (map)

    The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.

    • AnalyticsEndpointId — (String)

      The endpoint ID.

  • ContextData — (map)

    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.

    • IpAddress — required — (String)

      The source IP address of your user's device.

    • ServerName — required — (String)

      Your server endpoint where this API is invoked.

    • ServerPath — required — (String)

      Your server path where this API is invoked.

    • HttpHeaders — required — (Array<map>)

      HttpHeaders received on your server in same order.

      • headerName — (String)

        The header name.

      • headerValue — (String)

        The header value.

    • EncodedData — (String)

      Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ChallengeName — (String)

      The name of the challenge that you're responding to with this call. This is returned in the AdminInitiateAuth response if you must pass another challenge.

      • MFA_SETUP: If MFA is required, users who don't have at least one of the MFA methods set up are presented with an MFA_SETUP challenge. The user must set up at least one MFA type to continue to authenticate.

      • SELECT_MFA_TYPE: Selects the MFA type. Valid MFA options are SMS_MFA for text SMS MFA, and SOFTWARE_TOKEN_MFA for time-based one-time password (TOTP) software token MFA.

      • SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.

      • PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations.

      • CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.

      • DEVICE_SRP_AUTH: If device tracking was activated in your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.

      • DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only.

      • ADMIN_NO_SRP_AUTH: This is returned if you must authenticate with USERNAME and PASSWORD directly. An app client must be enabled to use this flow.

      • NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login. Respond to this challenge with NEW_PASSWORD and any required attributes that Amazon Cognito returned in the requiredAttributes parameter. You can also set values for attributes that aren't required by your user pool and that your app client can write. For more information, see AdminRespondToAuthChallenge.

        Note: In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API operation to modify the value of any additional attributes.

      • MFA_SETUP: For users who are required to set up an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters MFA_CAN_SETUP value.

        To set up software token MFA, use the session returned here from InitiateAuth as an input to AssociateSoftwareToken, and use the session returned by VerifySoftwareToken as an input to RespondToAuthChallenge with challenge name MFA_SETUP to complete sign-in. To set up SMS MFA, users will need help from an administrator to add a phone number to their account and then call InitiateAuth again to restart sign-in.

      Possible values include:
      • "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"
    • Session — (String)

      The session that should be passed both ways in challenge-response calls to the service. If AdminInitiateAuth or AdminRespondToAuthChallenge API call determines that 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 AdminRespondToAuthChallenge API call.

    • ChallengeParameters — (map<String>)

      The challenge parameters. These are returned to you in the AdminInitiateAuth response if you must pass another challenge. The responses in this parameter should be used to compute inputs to the next call (AdminRespondToAuthChallenge).

      All challenges require USERNAME and SECRET_HASH (if applicable).

      The value of the USER_ID_FOR_SRP attribute is the user's actual username, not an alias (such as email address or phone number), even if you specified an alias in your call to AdminInitiateAuth. This happens because, in the AdminRespondToAuthChallenge API ChallengeResponses, the USERNAME attribute can't be an alias.

    • AuthenticationResult — (map)

      The result of the authentication response. This is only returned if the caller doesn't need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session are returned.

      • AccessToken — (String)

        A valid access token that Amazon Cognito issued to the user who you want to authenticate.

      • ExpiresIn — (Integer)

        The expiration period of the authentication result in seconds.

      • TokenType — (String)

        The token type.

      • RefreshToken — (String)

        The refresh token.

      • IdToken — (String)

        The ID token.

      • NewDeviceMetadata — (map)

        The new device metadata from an authentication result.

        • DeviceKey — (String)

          The device key.

        • DeviceGroupKey — (String)

          The device group key.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DestinationUser: { /* required */
    ProviderAttributeName: 'STRING_VALUE',
    ProviderAttributeValue: 'STRING_VALUE',
    ProviderName: 'STRING_VALUE'
  },
  SourceUser: { /* required */
    ProviderAttributeName: 'STRING_VALUE',
    ProviderAttributeValue: 'STRING_VALUE',
    ProviderName: 'STRING_VALUE'
  },
  UserPoolId: 'STRING_VALUE' /* required */
};
cognitoidentityserviceprovider.adminLinkProviderForUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UserPoolId — (String)

    The user pool ID for the user pool.

  • DestinationUser — (map)

    The existing user in the user pool that you want to assign to the external IdP user account. This user can be a native (Username + Password) Amazon Cognito user pools user or a federated user (for example, a SAML or Facebook user). If the user doesn't exist, Amazon Cognito generates an exception. Amazon Cognito returns this user when the new user (with the linked IdP attribute) signs in.

    For a native username + password user, the ProviderAttributeValue for the DestinationUser should be the username in the user pool. For a federated user, it should be the provider-specific user_id.

    The ProviderAttributeName of the DestinationUser is ignored.

    The ProviderName should be set to Cognito for users in Cognito user pools.

    All attributes in the DestinationUser profile must be mutable. If you have assigned the user any immutable custom attributes, the operation won't succeed.

    • ProviderName — (String)

      The name of the provider, such as Facebook, Google, or Login with Amazon.

    • ProviderAttributeName — (String)

      The name of the provider attribute to link to, such as NameID.

    • ProviderAttributeValue — (String)

      The value of the provider attribute to link to, such as xxxxx_account.

  • SourceUser — (map)

    An external IdP account for a user who doesn't exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user.

    If the SourceUser is using a federated social IdP, such as Facebook, Google, or Login with Amazon, you must set the ProviderAttributeName to Cognito_Subject. For social IdPs, the ProviderName will be Facebook, Google, or LoginWithAmazon, and Amazon Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for id, sub, and user_id, respectively. The ProviderAttributeValue for the user must be the same value as the id, sub, or user_id value found in the social IdP token.

    For SAML, the ProviderAttributeName can be any value that matches a claim in the SAML assertion. If you want to link SAML users based on the subject of the SAML assertion, you should map the subject to a claim through the SAML IdP and submit that claim name as the ProviderAttributeName. If you set ProviderAttributeName to Cognito_Subject, Amazon Cognito will automatically parse the default unique identifier found in the subject from the SAML token.

    • ProviderName — (String)

      The name of the provider, such as Facebook, Google, or Login with Amazon.

    • ProviderAttributeName — (String)

      The name of the provider attribute to link to, such as NameID.

    • ProviderAttributeValue — (String)

      The value of the provider attribute to link to, such as xxxxx_account.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  UserPoolId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  PaginationToken: 'STRING_VALUE'
};
cognitoidentityserviceprovider.adminListDevices(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UserPoolId — (String)

    The user pool ID.

  • Username — (String)

    The user name.

  • Limit — (Integer)

    The limit of the devices request.

  • PaginationToken — (String)

    The pagination token.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Devices — (Array<map>)

      The devices in the list of devices response.

      • DeviceKey — (String)

        The device key.

      • DeviceAttributes — (Array<map>)

        The device attributes.

        • Name — required — (String)

          The name of the attribute.

        • Value — (String)

          The value of the attribute.

      • DeviceCreateDate — (Date)

        The creation date of the device.

      • DeviceLastModifiedDate — (Date)

        The last modified date of the device.

      • DeviceLastAuthenticatedDate — (Date)

        The date when the device was last authenticated.

    • PaginationToken — (String)

      The pagination token.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  UserPoolId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
cognitoidentityserviceprovider.adminListGroupsForUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Username — (String)

    The username for the user.

  • UserPoolId — (String)

    The user pool ID for the user pool.

  • Limit — (Integer)

    The limit of the request to list groups.

  • NextToken — (String)

    An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Groups — (Array<map>)

      The groups that the user belongs to.

      • GroupName — (String)

        The name of the group.

      • UserPoolId — (String)

        The user pool ID for the user pool.

      • Description — (String)

        A string containing the description of the group.

      • RoleArn — (String)

        The role Amazon Resource Name (ARN) for the group.

      • Precedence — (Integer)

        A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher ornull Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.

        Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.

        The default Precedence value is null.

      • LastModifiedDate — (Date)

        The date the group was last modified.

      • CreationDate — (Date)

        The date the group was created.

    • NextToken — (String)

      An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  UserPoolId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
cognitoidentityserviceprovider.adminListUserAuthEvents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UserPoolId — (String)

    The user pool ID.

  • Username — (String)

    The user pool username or an alias.

  • MaxResults — (Integer)

    The maximum number of authentication events to return. Returns 60 events if you set MaxResults to 0, or if you don't include a MaxResults parameter.

  • NextToken — (String)

    A pagination token.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AuthEvents — (Array<map>)

      The response object. It includes the EventID, EventType, CreationDate, EventRisk, and EventResponse.

      • EventId — (String)

        The event ID.

      • EventType — (String)

        The event type.

        Possible values include:
        • "SignIn"
        • "SignUp"
        • "ForgotPassword"
        • "PasswordChange"
        • "ResendCode"
      • CreationDate — (Date)

        The creation date

      • EventResponse — (String)

        The event response.

        Possible values include:
        • "Pass"
        • "Fail"
        • "InProgress"
      • EventRisk — (map)

        The event risk.

        • RiskDecision — (String)

          The risk decision.

          Possible values include:
          • "NoRisk"
          • "AccountTakeover"
          • "Block"
        • RiskLevel — (String)

          The risk level.

          Possible values include:
          • "Low"
          • "Medium"
          • "High"
        • CompromisedCredentialsDetected — (Boolean)

          Indicates whether compromised credentials were detected during an authentication event.

      • ChallengeResponses — (Array<map>)

        The challenge responses.

        • ChallengeName — (String)

          The challenge name.

          Possible values include:
          • "Password"
          • "Mfa"
        • ChallengeResponse — (String)

          The challenge response.

          Possible values include:
          • "Success"
          • "Failure"
      • EventContextData — (map)

        The user context data captured at the time of an event request. This value provides additional information about the client from which event the request is received.

        • IpAddress — (String)

          The source IP address of your user's device.

        • DeviceName — (String)

          The user's device name.

        • Timezone — (String)

          The user's time zone.

        • City — (String)

          The user's city.

        • Country — (String)

          The user's country.

      • EventFeedback — (map)

        A flag specifying the user feedback captured at the time of an event request is good or bad.

        • FeedbackValue — required — (String)

          The event feedback value.

          Possible values include:
          • "Valid"
          • "Invalid"
        • Provider — required — (String)

          The provider.

        • FeedbackDate — (Date)

          The event feedback date.

    • NextToken — (String)

      A pagination token.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GroupName: 'STRING_VALUE', /* required */
  UserPoolId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE' /* required */
};
cognitoidentityserviceprovider.adminRemoveUserFromGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UserPoolId — (String)

    The user pool ID for the user pool.

  • Username — (String)

    The username for the user.

  • GroupName — (String)

    The group name.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  UserPoolId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE', /* required */
  ClientMetadata: {
    '<StringType>': 'STRING_VALUE',
    /* '<StringType>': ... */
  }
};
cognitoidentityserviceprovider.adminResetUserPassword(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UserPoolId — (String)

    The user pool ID for the user pool where you want to reset the user's password.

  • Username — (String)

    The user name of the user whose password you want to reset.

  • ClientMetadata — (map<String>)

    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. When you use the AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

    Note: When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

    • 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.
    • Validate the ClientMetadata value.
    • Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ChallengeName: 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, /* required */
  ClientId: 'STRING_VALUE', /* required */
  UserPoolId: 'STRING_VALUE', /* required */
  AnalyticsMetadata: {
    AnalyticsEndpointId: 'STRING_VALUE'
  },
  ChallengeResponses: {
    '<StringType>': 'STRING_VALUE',
    /* '<StringType>': ... */
  },
  ClientMetadata: {
    '<StringType>': 'STRING_VALUE',
    /* '<StringType>': ... */
  },
  ContextData: {
    HttpHeaders: [ /* required */
      {
        headerName: 'STRING_VALUE',
        headerValue: 'STRING_VALUE'
      },
      /* more items */
    ],
    IpAddress: 'STRING_VALUE', /* required */
    ServerName: 'STRING_VALUE', /* required */
    ServerPath: 'STRING_VALUE', /* required */
    EncodedData: 'STRING_VALUE'
  },
  Session: 'STRING_VALUE'
};
cognitoidentityserviceprovider.adminRespondToAuthChallenge(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UserPoolId — (String)

    The ID of the Amazon Cognito user pool.

  • ClientId — (String)

    The app client ID.

  • ChallengeName — (String)

    The challenge name. For more information, see AdminInitiateAuth.

    Possible values include:
    • "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"
  • ChallengeResponses — (map<String>)

    The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

    • SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured with client secret).

    • PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client secret).

      Note: PASSWORD_VERIFIER requires DEVICE_KEY when signing in with a remembered device.

    • ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).

    • NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the AdminInitiateAuth response, add a userAttributes.attributename parameter. This parameter can also set values for writable attributes that aren't required by your user pool.

      Note: In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API operation to modify the value of any additional attributes.

    • MFA_SETUP requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter.

    The value of the USERNAME attribute must be the user's actual username, not an alias (such as an email address or phone number). To make this simpler, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute. This happens even if you specified an alias in your call to AdminInitiateAuth.

  • Session — (String)

    The session that should be passed both ways in challenge-response calls to the service. If an InitiateAuth or RespondToAuthChallenge 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 RespondToAuthChallenge API call.

  • AnalyticsMetadata — (map)

    The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge calls.

    • AnalyticsEndpointId — (String)

      The endpoint ID.

  • ContextData — (map)

    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.

    • IpAddress — required — (String)

      The source IP address of your user's device.

    • ServerName — required — (String)

      Your server endpoint where this API is invoked.

    • ServerPath — required — (String)

      Your server path where this API is invoked.

    • HttpHeaders — required — (Array<map>)

      HttpHeaders received on your server in same order.

      • headerName — (String)

        The header name.

      • headerValue — (String)

        The header value.

    • EncodedData — (String)

      Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.

  • ClientMetadata — (map<String>)

    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. When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers:

    • pre sign-up

    • custom message

    • post authentication

    • user migration

    • pre token generation

    • define auth challenge

    • create auth challenge

    • verify auth challenge response

    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 AdminRespondToAuthChallenge request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

    Note: When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

    • 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.
    • Validate the ClientMetadata value.
    • Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ChallengeName — (String)

      The name of the challenge. For more information, see AdminInitiateAuth.

      Possible values include:
      • "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"
    • Session — (String)

      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 RespondToAuthChallenge API call.

    • ChallengeParameters — (map<String>)

      The challenge parameters. For more information, see AdminInitiateAuth.

    • AuthenticationResult — (map)

      The result returned by the server in response to the authentication request.

      • AccessToken — (String)

        A valid access token that Amazon Cognito issued to the user who you want to authenticate.

      • ExpiresIn — (Integer)

        The expiration period of the authentication result in seconds.

      • TokenType — (String)

        The token type.

      • RefreshToken — (String)

        The refresh token.

      • IdToken — (String)

        The ID token.

      • NewDeviceMetadata — (map)

        The new device metadata from an authentication result.

        • DeviceKey — (String)

          The device key.

        • DeviceGroupKey — (String)

          The device group key.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  UserPoolId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE', /* required */
  SMSMfaSettings: {
    Enabled: true || false,
    PreferredMfa: true || false
  },
  SoftwareTokenMfaSettings: {
    Enabled: true || false,
    PreferredMfa: true || false
  }
};
cognitoidentityserviceprovider.adminSetUserMFAPreference(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • SMSMfaSettings — (map)

    The SMS text message MFA settings.

    • Enabled — (Boolean)

      Specifies whether SMS text message MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted.

    • PreferredMfa — (Boolean)

      Specifies whether SMS is the preferred MFA method.

  • SoftwareTokenMfaSettings — (map)

    The time-based one-time password software token MFA settings.

    • Enabled — (Boolean)

      Specifies whether software token MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted.

    • PreferredMfa — (Boolean)

      Specifies whether software token MFA is the preferred MFA method.

  • Username — (String)

    The user pool username or alias.

  • UserPoolId — (String)

    The user pool ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Password: 'STRING_VALUE', /* required */
  UserPoolId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE', /* required */
  Permanent: true || false
};
cognitoidentityserviceprovider.adminSetUserPassword(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UserPoolId — (String)

    The user pool ID for the user pool where you want to set the user's password.

  • Username — (String)

    The user name of the user whose password you want to set.

  • Password — (String)

    The password for the user.

  • Permanent — (Boolean)

    True if the password is permanent, False if it is temporary.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MFAOptions: [ /* required */
    {
      AttributeName: 'STRING_VALUE',
      DeliveryMedium: SMS | EMAIL
    },
    /* more items */
  ],
  UserPoolId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE' /* required */
};
cognitoidentityserviceprovider.adminSetUserSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UserPoolId — (String)

    The ID of the user pool that contains the user whose options you're setting.

  • Username — (String)

    The user name of the user whose options you're setting.

  • MFAOptions — (Array<map>)

    You can use this parameter only to set an SMS configuration that uses SMS for delivery.

    • DeliveryMedium — (String)

      The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

      Possible values include:
      • "SMS"
      • "EMAIL"
    • AttributeName — (String)

      The attribute name of the MFA option type. The only valid value is phone_number.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  EventId: 'STRING_VALUE', /* required */
  FeedbackValue: Valid | Invalid, /* required */
  UserPoolId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE' /* required */
};
cognitoidentityserviceprovider.adminUpdateAuthEventFeedback(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UserPoolId — (String)

    The user pool ID.

  • Username — (String)

    The user pool username.

  • EventId — (String)

    The authentication event ID.

  • FeedbackValue — (String)

    The authentication event feedback value.

    Possible values include:
    • "Valid"
    • "Invalid"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DeviceKey: 'STRING_VALUE', /* required */
  UserPoolId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE', /* required */
  DeviceRememberedStatus: remembered | not_remembered
};
cognitoidentityserviceprovider.adminUpdateDeviceStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UserPoolId — (String)

    The user pool ID.

  • Username — (String)

    The user name.

  • DeviceKey — (String)

    The device key.

  • DeviceRememberedStatus — (String)

    The status indicating whether a device has been remembered or not.

    Possible values include:
    • "remembered"
    • "not_remembered"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  UserAttributes: [ /* required */
    {
      Name: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  UserPoolId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE', /* required */
  ClientMetadata: {
    '<StringType>': 'STRING_VALUE',
    /* '<StringType>': ... */
  }
};
cognitoidentityserviceprovider.adminUpdateUserAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UserPoolId — (String)

    The user pool ID for the user pool where you want to update user attributes.

  • Username — (String)

    The user name of the user for whom you want to update user attributes.

  • UserAttributes — (Array<map>)

    An array of name-value pairs representing user attributes.

    For custom attributes, you must prepend the custom: prefix to the attribute name.

    If your user pool requires verification before Amazon Cognito updates an attribute value that you specify in this request, Amazon Cognito doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.

    To update the value of an attribute that requires verification in the same API request, include the email_verified or phone_number_verified attribute, with a value of true. If you set the email_verified or phone_number_verified value for an email or phone_number attribute that requires verification to true, Amazon Cognito doesn’t send a verification message to your user.

    • Name — required — (String)

      The name of the attribute.

    • Value — (String)

      The value of the attribute.

  • ClientMetadata — (map<String>)

    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. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

    Note: When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

    • 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.
    • Validate the ClientMetadata value.
    • Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  UserPoolId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE' /* required */
};
cognitoidentityserviceprovider.adminUserGlobalSignOut(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UserPoolId — (String)

    The user pool ID.

  • Username — (String)

    The user name.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccessToken: 'STRING_VALUE',
  Session: 'STRING_VALUE'
};
cognitoidentityserviceprovider.associateSoftwareToken(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccessToken — (String)

    A valid access token that Amazon Cognito issued to the user whose software token you want to generate.

  • Session — (String)

    The session that should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • SecretCode — (String)

      A unique generated shared secret code that is used in the TOTP algorithm to generate a one-time code.

    • Session — (String)

      The session that should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccessToken: 'STRING_VALUE', /* required */
  PreviousPassword: 'STRING_VALUE', /* required */
  ProposedPassword: 'STRING_VALUE' /* required */
};
cognitoidentityserviceprovider.changePassword(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • PreviousPassword — (String)

    The old password.

  • ProposedPassword — (String)

    The new password.

  • AccessToken — (String)

    A valid access token that Amazon Cognito issued to the user whose password you want to change.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccessToken: 'STRING_VALUE', /* required */
  DeviceKey: 'STRING_VALUE', /* required */
  DeviceName: 'STRING_VALUE',
  DeviceSecretVerifierConfig: {
    PasswordVerifier: 'STRING_VALUE',
    Salt: 'STRING_VALUE'
  }
};
cognitoidentityserviceprovider.confirmDevice(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccessToken — (String)

    A valid access token that Amazon Cognito issued to the user whose device you want to confirm.

  • DeviceKey — (String)

    The device key.

  • DeviceSecretVerifierConfig — (map)

    The configuration of the device secret verifier.

    • PasswordVerifier — (String)

      The password verifier.

    • Salt — (String)

      The salt

  • DeviceName — (String)

    The device name.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • UserConfirmationNecessary — (Boolean)

      Indicates whether the user confirmation must confirm the device response.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ClientId: 'STRING_VALUE', /* required */
  ConfirmationCode: 'STRING_VALUE', /* required */
  Password: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE', /* required */
  AnalyticsMetadata: {
    AnalyticsEndpointId: 'STRING_VALUE'
  },
  ClientMetadata: {
    '<StringType>': 'STRING_VALUE',
    /* '<StringType>': ... */
  },
  SecretHash: 'STRING_VALUE',
  UserContextData: {
    EncodedData: 'STRING_VALUE',
    IpAddress: 'STRING_VALUE'
  }
};
cognitoidentityserviceprovider.confirmForgotPassword(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ClientId — (String)

    The app client ID of the app associated with the user pool.

  • SecretHash — (String)

    A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

  • Username — (String)

    The user name of the user for whom you want to enter a code to retrieve a forgotten password.

  • ConfirmationCode — (String)

    The confirmation code from your user's request to reset their password. For more information, see ForgotPassword.

  • Password — (String)

    The new password that your user wants to set.

  • AnalyticsMetadata — (map)

    The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.

    • AnalyticsEndpointId — (String)

      The endpoint ID.

  • UserContextData — (map)

    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.

    • IpAddress — (String)

      The source IP address of your user's device.

    • EncodedData — (String)

      Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.

  • ClientMetadata — (map<String>)

    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. When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

    Note: When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

    • 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.
    • Validate the ClientMetadata value.
    • Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ClientId: 'STRING_VALUE', /* required */
  ConfirmationCode: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE', /* required */
  AnalyticsMetadata: {
    AnalyticsEndpointId: 'STRING_VALUE'
  },
  ClientMetadata: {
    '<StringType>': 'STRING_VALUE',
    /* '<StringType>': ... */
  },
  ForceAliasCreation: true || false,
  SecretHash: 'STRING_VALUE',
  UserContextData: {
    EncodedData: 'STRING_VALUE',
    IpAddress: 'STRING_VALUE'
  }
};
cognitoidentityserviceprovider.confirmSignUp(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ClientId — (String)

    The ID of the app client associated with the user pool.

  • SecretHash — (String)

    A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

  • Username — (String)

    The user name of the user whose registration you want to confirm.

  • ConfirmationCode — (String)

    The confirmation code sent by a user's request to confirm registration.

  • ForceAliasCreation — (Boolean)

    Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.

  • AnalyticsMetadata — (map)

    The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.

    • AnalyticsEndpointId — (String)

      The endpoint ID.

  • UserContextData — (map)

    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.

    • IpAddress — (String)

      The source IP address of your user's device.

    • EncodedData — (String)

      Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.

  • ClientMetadata — (map<String>)

    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. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

    Note: When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

    • 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.
    • Validate the ClientMetadata value.
    • Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GroupName: 'STRING_VALUE', /* required */
  UserPoolId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Precedence: 'NUMBER_VALUE',
  RoleArn: 'STRING_VALUE'
};
cognitoidentityserviceprovider.createGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • GroupName — (String)

    The name of the group. Must be unique.

  • UserPoolId — (String)

    The user pool ID for the user pool.

  • Description — (String)

    A string containing the description of the group.

  • RoleArn — (String)

    The role Amazon Resource Name (ARN) for the group.

  • Precedence — (Integer)

    A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.

    Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.

    The default Precedence value is null. The maximum Precedence value is 231-1.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Group — (map)

      The group object for the group.

      • GroupName — (String)

        The name of the group.

      • UserPoolId — (String)

        The user pool ID for the user pool.

      • Description — (String)

        A string containing the description of the group.

      • RoleArn — (String)

        The role Amazon Resource Name (ARN) for the group.

      • Precedence — (Integer)

        A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher ornull Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.

        Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.

        The default Precedence value is null.

      • LastModifiedDate — (Date)

        The date the group was last modified.

      • CreationDate — (Date)

        The date the group was created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ProviderDetails: { /* required */
    '<StringType>': 'STRING_VALUE',
    /* '<StringType>': ... */
  },
  ProviderName: 'STRING_VALUE', /* required */
  ProviderType: SAML | Facebook | Google | LoginWithAmazon | SignInWithApple | OIDC, /* required */
  UserPoolId: 'STRING_VALUE', /* required */
  AttributeMapping: {
    '<AttributeMappingKeyType>': 'STRING_VALUE',
    /* '<AttributeMappingKeyType>': ... */
  },
  IdpIdentifiers: [
    'STRING_VALUE',
    /* more items */
  ]
};
cognitoidentityserviceprovider.createIdentityProvider(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UserPoolId — (String)

    The user pool ID.

  • ProviderName — (String)

    The IdP name.

  • ProviderType — (String)

    The IdP type.

    Possible values include:
    • "SAML"
    • "Facebook"
    • "Google"
    • "LoginWithAmazon"
    • "SignInWithApple"
    • "OIDC"
  • ProviderDetails — (map<String>)

    The IdP details. The following list describes the provider detail keys for each IdP type.

    • For Google and Login with Amazon:

      • client_id

      • client_secret

      • authorize_scopes

    • For Facebook:

      • client_id

      • client_secret

      • authorize_scopes

      • api_version

    • For Sign in with Apple:

      • client_id

      • team_id

      • key_id

      • private_key

      • authorize_scopes

    • For OpenID Connect (OIDC) providers:

      • client_id

      • client_secret

      • attributes_request_method

      • oidc_issuer

      • authorize_scopes

      • The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL.

        • authorize_url

        • token_url

        • attributes_url

        • jwks_uri

      • Amazon Cognito sets the value of the following keys automatically. They are read-only.

        • attributes_url_add_attributes

    • For SAML providers:

      • MetadataFile or MetadataURL

      • IDPSignout optional

  • AttributeMapping — (map<String>)

    A mapping of IdP attributes to standard and custom user pool attributes.

  • IdpIdentifiers — (Array<String>)

    A list of IdP identifiers.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • IdentityProvider — (map)

      The newly created IdP object.

      • UserPoolId — (String)

        The user pool ID.

      • ProviderName — (String)

        The IdP name.

      • ProviderType — (String)

        The IdP type.

        Possible values include:
        • "SAML"
        • "Facebook"
        • "Google"
        • "LoginWithAmazon"
        • "SignInWithApple"
        • "OIDC"
      • ProviderDetails — (map<String>)

        The IdP details. The following list describes the provider detail keys for each IdP type.

        • For Google and Login with Amazon:

          • client_id

          • client_secret

          • authorize_scopes

        • For Facebook:

          • client_id

          • client_secret

          • authorize_scopes

          • api_version

        • For Sign in with Apple:

          • client_id

          • team_id

          • key_id

          • private_key

            You can submit a private_key when you add or update an IdP. Describe operations don't return the private key.

          • authorize_scopes

        • For OIDC providers:

          • client_id

          • client_secret

          • attributes_request_method

          • oidc_issuer

          • authorize_scopes

          • The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL.

            • authorize_url

            • token_url

            • attributes_url

            • jwks_uri

          • Amazon Cognito sets the value of the following keys automatically. They are read-only.

            • attributes_url_add_attributes

        • For SAML providers:

          • MetadataFile or MetadataURL

          • IDPSignout optional

      • AttributeMapping — (map<String>)

        A mapping of IdP attributes to standard and custom user pool attributes.

      • IdpIdentifiers — (Array<String>)

        A list of IdP identifiers.

      • LastModifiedDate — (Date)

        The date the IdP was last modified.

      • CreationDate — (Date)

        The date the IdP was created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Identifier: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  UserPoolId: 'STRING_VALUE', /* required */
  Scopes: [
    {
      ScopeDescription: 'STRING_VALUE', /* required */
      ScopeName: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
cognitoidentityserviceprovider.createResourceServer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UserPoolId — (String)

    The user pool ID for the user pool.

  • Identifier — (String)

    A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located, such as https://my-weather-api.example.com.

  • Name — (String)

    A friendly name for the resource server.

  • Scopes — (Array<map>)

    A list of scopes. Each scope is a key-value map with the keys name and description.

    • ScopeName — required — (String)

      The name of the scope.

    • ScopeDescription — required — (String)

      A description of the scope.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ResourceServer — (map)

      The newly created resource server.

      • UserPoolId — (String)

        The user pool ID for the user pool that hosts the resource server.

      • Identifier — (String)

        The identifier for the resource server.

      • Name — (String)

        The name of the resource server.

      • Scopes — (Array<map>)

        A list of scopes that are defined for the resource server.

        • ScopeName — required — (String)

          The name of the scope.

        • ScopeDescription — required — (String)

          A description of the scope.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  CloudWatchLogsRoleArn: 'STRING_VALUE', /* required */
  JobName: 'STRING_VALUE', /* required */
  UserPoolId: 'STRING_VALUE' /* required */
};
cognitoidentityserviceprovider.createUserImportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • JobName — (String)

    The job name for the user import job.

  • UserPoolId — (String)

    The user pool ID for the user pool that the users are being imported into.

  • CloudWatchLogsRoleArn — (String)

    The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • UserImportJob — (map)

      The job object that represents the user import job.

      • JobName — (String)

        The job name for the user import job.

      • JobId — (String)

        The job ID for the user import job.

      • UserPoolId — (String)

        The user pool ID for the user pool that the users are being imported into.

      • PreSignedUrl — (String)

        The pre-signed URL to be used to upload the .csv file.

      • CreationDate — (Date)

        The date the user import job was created.

      • StartDate — (Date)

        The date when the user import job was started.

      • CompletionDate — (Date)

        The date when the user import job was completed.

      • Status — (String)

        The status of the user import job. One of the following:

        • Created - The job was created but not started.

        • Pending - A transition state. You have started the job, but it has not begun importing users yet.

        • InProgress - The job has started, and users are being imported.

        • Stopping - You have stopped the job, but the job has not stopped importing users yet.

        • Stopped - You have stopped the job, and the job has stopped importing users.

        • Succeeded - The job has completed successfully.

        • Failed - The job has stopped due to an error.

        • Expired - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job can't be started.

        Possible values include:
        • "Created"
        • "Pending"
        • "InProgress"
        • "Stopping"
        • "Expired"
        • "Stopped"
        • "Failed"
        • "Succeeded"
      • CloudWatchLogsRoleArn — (String)

        The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging role for the user import job. For more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer Guide.

      • ImportedUsers — (Integer)

        The number of users that were successfully imported.

      • SkippedUsers — (Integer)

        The number of users that were skipped.

      • FailedUsers — (Integer)

        The number of users that couldn't be imported.

      • CompletionMessage — (String)

        The message returned when the user import job is completed.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  PoolName: 'STRING_VALUE', /* required */
  AccountRecoverySetting: {
    RecoveryMechanisms: [
      {
        Name: verified_email | verified_phone_number | admin_only, /* required */
        Priority: 'NUMBER_VALUE' /* required */
      },
      /* more items */
    ]
  },
  AdminCreateUserConfig: {
    AllowAdminCreateUserOnly: true || false,
    InviteMessageTemplate: {
      EmailMessage: 'STRING_VALUE',
      EmailSubject: 'STRING_VALUE',
      SMSMessage: 'STRING_VALUE'
    },
    UnusedAccountValidityDays: 'NUMBER_VALUE'
  },
  AliasAttributes: [
    phone_number | email | preferred_username,
    /* more items */
  ],
  AutoVerifiedAttributes: [
    phone_number | email,
    /* more items */
  ],
  DeletionProtection: ACTIVE | INACTIVE,
  DeviceConfiguration: {
    ChallengeRequiredOnNewDevice: true || false,
    DeviceOnlyRememberedOnUserPrompt: true || false
  },
  EmailConfiguration: {
    ConfigurationSet: 'STRING_VALUE',
    EmailSendingAccount: COGNITO_DEFAULT | DEVELOPER,
    From: 'STRING_VALUE',
    ReplyToEmailAddress: 'STRING_VALUE',
    SourceArn: 'STRING_VALUE'
  },
  EmailVerificationMessage: 'STRING_VALUE',
  EmailVerificationSubject: 'STRING_VALUE',
  LambdaConfig: {
    CreateAuthChallenge: 'STRING_VALUE',
    CustomEmailSender: {
      LambdaArn: 'STRING_VALUE', /* required */
      LambdaVersion: V1_0 /* required */
    },
    CustomMessage: 'STRING_VALUE',
    CustomSMSSender: {
      LambdaArn: 'STRING_VALUE', /* required */
      LambdaVersion: V1_0 /* required */
    },
    DefineAuthChallenge: 'STRING_VALUE',
    KMSKeyID: 'STRING_VALUE',
    PostAuthentication: 'STRING_VALUE',
    PostConfirmation: 'STRING_VALUE',
    PreAuthentication: 'STRING_VALUE',
    PreSignUp: 'STRING_VALUE',
    PreTokenGeneration: 'STRING_VALUE',
    UserMigration: 'STRING_VALUE',
    VerifyAuthChallengeResponse: 'STRING_VALUE'
  },
  MfaConfiguration: OFF | ON | OPTIONAL,
  Policies: {
    PasswordPolicy: {
      MinimumLength: 'NUMBER_VALUE',
      RequireLowercase: true || false,
      RequireNumbers: true || false,
      RequireSymbols: true || false,
      RequireUppercase: true || false,
      TemporaryPasswordValidityDays: 'NUMBER_VALUE'
    }
  },
  Schema: [
    {
      AttributeDataType: String | Number | DateTime | Boolean,
      DeveloperOnlyAttribute: true || false,
      Mutable: true || false,
      Name: 'STRING_VALUE',
      NumberAttributeConstraints: {
        MaxValue: 'STRING_VALUE',
        MinValue: 'STRING_VALUE'
      },
      Required: true || false,
      StringAttributeConstraints: {
        MaxLength: 'STRING_VALUE',
        MinLength: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  SmsAuthenticationMessage: 'STRING_VALUE',
  SmsConfiguration: {
    SnsCallerArn: 'STRING_VALUE', /* required */
    ExternalId: 'STRING_VALUE',
    SnsRegion: 'STRING_VALUE'
  },
  SmsVerificationMessage: 'STRING_VALUE',
  UserAttributeUpdateSettings: {
    AttributesRequireVerificationBeforeUpdate: [
      phone_number | email,
      /* more items */
    ]
  },
  UserPoolAddOns: {
    AdvancedSecurityMode: OFF | AUDIT | ENFORCED /* required */
  },
  UserPoolTags: {
    '<TagKeysType>': 'STRING_VALUE',
    /* '<TagKeysType>': ... */
  },
  UsernameAttributes: [
    phone_number | email,
    /* more items */
  ],
  UsernameConfiguration: {
    CaseSensitive: true || false /* required */
  },
  VerificationMessageTemplate: {
    DefaultEmailOption: CONFIRM_WITH_LINK | CONFIRM_WITH_CODE,
    EmailMessage: 'STRING_VALUE',
    EmailMessageByLink: 'STRING_VALUE',
    EmailSubject: 'STRING_VALUE',
    EmailSubjectByLink: 'STRING_VALUE',
    SmsMessage: 'STRING_VALUE'
  }
};
cognitoidentityserviceprovider.createUserPool(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • PoolName — (String)

    A string used to name the user pool.

  • Policies — (map)

    The policies associated with the new user pool.

    • PasswordPolicy — (map)

      The password policy.

      • MinimumLength — (Integer)

        The minimum length of the password in the policy that you have set. This value can't be less than 6.

      • RequireUppercase — (Boolean)

        In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password.

      • RequireLowercase — (Boolean)

        In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password.

      • RequireNumbers — (Boolean)

        In the password policy that you have set, refers to whether you have required users to use at least one number in their password.

      • RequireSymbols — (Boolean)

        In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.

      • TemporaryPasswordValidityDays — (Integer)

        The number of days a temporary password is valid in the password policy. If the user doesn't sign in during this time, an administrator must reset their password.

        Note: When you set TemporaryPasswordValidityDays for a user pool, you can no longer set a value for the legacy UnusedAccountValidityDays parameter in that user pool.
  • DeletionProtection — (String)

    When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

    When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

    Possible values include:
    • "ACTIVE"
    • "INACTIVE"
  • LambdaConfig — (map)

    The Lambda trigger configuration information for the new user pool.

    Note: In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.

    For more information on using the Lambda API to add permission, see AddPermission . For adding permission using the CLI, see add-permission .

    • PreSignUp — (String)

      A pre-registration Lambda trigger.

    • CustomMessage — (String)

      A custom Message Lambda trigger.

    • PostConfirmation — (String)

      A post-confirmation Lambda trigger.

    • PreAuthentication — (String)

      A pre-authentication Lambda trigger.

    • PostAuthentication — (String)

      A post-authentication Lambda trigger.

    • DefineAuthChallenge — (String)

      Defines the authentication challenge.

    • CreateAuthChallenge — (String)

      Creates an authentication challenge.

    • VerifyAuthChallengeResponse — (String)

      Verifies the authentication challenge response.

    • PreTokenGeneration — (String)

      A Lambda trigger that is invoked before token generation.

    • UserMigration — (String)

      The user migration Lambda config type.

    • CustomSMSSender — (map)

      A custom SMS sender Lambda trigger.

      • LambdaVersion — required — (String)

        Signature of the "request" attribute in the "event" information that Amazon Cognito passes to your custom SMS Lambda function. The only supported value is V1_0.

        Possible values include:
        • "V1_0"
      • LambdaArn — required — (String)

        The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send SMS notifications to users.

    • CustomEmailSender — (map)

      A custom email sender Lambda trigger.

      • LambdaVersion — required — (String)

        Signature of the "request" attribute in the "event" information Amazon Cognito passes to your custom email Lambda function. The only supported value is V1_0.

        Possible values include:
        • "V1_0"
      • LambdaArn — required — (String)

        The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send email notifications to users.

    • KMSKeyID — (String)

      The Amazon Resource Name (ARN) of an KMS key. Amazon Cognito uses the key to encrypt codes and temporary passwords sent to CustomEmailSender and CustomSMSSender.

  • AutoVerifiedAttributes — (Array<String>)

    The attributes to be auto-verified. Possible values: email, phone_number.

  • AliasAttributes — (Array<String>)

    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

  • UsernameAttributes — (Array<String>)

    Specifies whether a user can use an email address or phone number as a username when they sign up.

  • SmsVerificationMessage — (String)

    This parameter is no longer used. See VerificationMessageTemplateType.

  • EmailVerificationMessage — (String)

    This parameter is no longer used. See VerificationMessageTemplateType.

  • EmailVerificationSubject — (String)

    This parameter is no longer used. See VerificationMessageTemplateType.

  • VerificationMessageTemplate — (map)

    The template for the verification message that the user sees when the app requests permission to access the user's information.

    • SmsMessage — (String)

      The template for SMS messages that Amazon Cognito sends to your users.

    • EmailMessage — (String)

      The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

    • EmailSubject — (String)

      The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

    • EmailMessageByLink — (String)

      The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

    • EmailSubjectByLink — (String)

      The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

    • DefaultEmailOption — (String)

      The default email option.

      Possible values include:
      • "CONFIRM_WITH_LINK"
      • "CONFIRM_WITH_CODE"
  • SmsAuthenticationMessage — (String)

    A string representing the SMS authentication message.

  • MfaConfiguration — (String)

    Specifies MFA configuration details.

    Possible values include:
    • "OFF"
    • "ON"
    • "OPTIONAL"
  • UserAttributeUpdateSettings — (map)

    The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

    • AttributesRequireVerificationBeforeUpdate — (Array<String>)

      Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.

      You can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the UpdateUserAttributes or AdminUpdateUserAttributes API and set email_verified or phone_number_verified to true.

      When AttributesRequireVerificationBeforeUpdate is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where AttributesRequireVerificationBeforeUpdate is false, API operations that change attribute values can immediately update a user’s email or phone_number attribute.

  • DeviceConfiguration — (map)

    The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

    Note: When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.
    • ChallengeRequiredOnNewDevice — (Boolean)

      When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).

      Note: Whether or not ChallengeRequiredOnNewDevice is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA.
    • DeviceOnlyRememberedOnUserPrompt — (Boolean)

      When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ConfirmDevice API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an UpdateDeviceStatus API request.

      When DeviceOnlyRememberedOnUserPrompt is false, Amazon Cognito immediately remembers devices that you register in a ConfirmDevice API request.

  • EmailConfiguration — (map)

    The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.

    • SourceArn — (String)

      The ARN of a verified email address in Amazon SES. Amazon Cognito uses this email address in one of the following ways, depending on the value that you specify for the EmailSendingAccount parameter:

      • If you specify COGNITO_DEFAULT, Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account.

      • If you specify DEVELOPER, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.

      The Region value of the SourceArn parameter must indicate a supported Amazon Web Services Region of your user pool. Typically, the Region in the SourceArn and the user pool Region are the same. For more information, see Amazon SES email configuration regions in the Amazon Cognito Developer Guide.

    • ReplyToEmailAddress — (String)

      The destination to which the receiver of the email should reply.

    • EmailSendingAccount — (String)

      Specifies whether Amazon Cognito uses its built-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following values:

      COGNITO_DEFAULT

      When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.

      To look up the email delivery limit for the default option, see Limits in the Amazon Cognito Developer Guide.

      The default FROM address is no-reply@verificationemail.com. To customize the FROM address, provide the Amazon Resource Name (ARN) of an Amazon SES verified email address for the SourceArn parameter.

      DEVELOPER

      When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account.

      If you use this option, provide the ARN of an Amazon SES verified email address for the SourceArn parameter.

      Before Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito creates a service-linked role, which is a type of role in your Amazon Web Services account. This role contains the permissions that allow you to access Amazon SES and send email messages from your email address. For more information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito in the Amazon Cognito Developer Guide.

      Possible values include:
      • "COGNITO_DEFAULT"
      • "DEVELOPER"
    • From — (String)

      Either the sender’s email address or the sender’s name with their email address. For example, testuser@example.com or Test User <testuser@example.com>. This address appears before the body of the email.

    • ConfigurationSet — (String)

      The set of configuration rules that can be applied to emails sent using Amazon Simple Email Service. A configuration set is applied to an email by including a reference to the configuration set in the headers of the email. Once applied, all of the rules in that configuration set are applied to the email. Configuration sets can be used to apply the following types of rules to emails:

      Event publishing

      Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other Amazon Web Services services such as and Amazon CloudWatch

      IP pool management

      When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.

  • SmsConfiguration — (map)

    The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

    • SnsCallerArn — required — (String)

      The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your Amazon Web Services account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a spending limit.

    • ExternalId — (String)

      The external ID provides additional security for your IAM role. You can use an ExternalId with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the ExternalID. If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required permissions and a trust policy that demonstrates use of the ExternalId.

      For more information about the ExternalId of a role, see How to use an external ID when granting access to your Amazon Web Services resources to a third party

    • SnsRegion — (String)

      The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported Legacy Amazon SNS alternate Region.

      Amazon Cognito resources in the Asia Pacific (Seoul) Amazon Web Services Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see SMS message settings for Amazon Cognito user pools.

  • UserPoolTags — (map<String>)

    The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

  • AdminCreateUserConfig — (map)

    The configuration for AdminCreateUser requests.

    • AllowAdminCreateUserOnly — (Boolean)

      Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.

    • UnusedAccountValidityDays — (Integer)

      The user account expiration limit, in days, after which a new account that hasn't signed in is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. The default value for this parameter is 7.

      Note: If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be used, and UnusedAccountValidityDays will be no longer be an available parameter for that user pool.
    • InviteMessageTemplate — (map)

      The message template to be used for the welcome message to new users.

      See also Customizing User Invitation Messages.

      • SMSMessage — (String)

        The message template for SMS messages.

      • EmailMessage — (String)

        The message template for email messages. EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.

      • EmailSubject — (String)

        The subject line for email messages. EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.

  • Schema — (Array<map>)

    An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

    • Name — (String)

      A schema attribute of the name type.

    • AttributeDataType — (String)

      The attribute data type.

      Possible values include:
      • "String"
      • "Number"
      • "DateTime"
      • "Boolean"
    • DeveloperOnlyAttribute — (Boolean)
      Note: You should use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using DeveloperOnlyAttribute.

      Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users won't be able to modify this attribute using their access token. For example, DeveloperOnlyAttribute can be modified using AdminUpdateUserAttributes but can't be updated using UpdateUserAttributes.

    • Mutable — (Boolean)

      Specifies whether the value of the attribute can be changed.

      For any user pool attribute that is mapped to an IdP attribute, you must set this parameter to true. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.

    • Required — (Boolean)

      Specifies whether a user pool attribute is required. If the attribute is required and the user doesn't provide a value, registration or sign-in will fail.

    • NumberAttributeConstraints — (map)

      Specifies the constraints for an attribute of the number type.

      • MinValue — (String)

        The minimum value of an attribute that is of the number data type.

      • MaxValue — (String)

        The maximum value of an attribute that is of the number data type.

    • StringAttributeConstraints — (map)

      Specifies the constraints for an attribute of the string type.

      • MinLength — (String)

        The minimum length.

      • MaxLength — (String)

        The maximum length.

  • UserPoolAddOns — (map)

    Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

    • AdvancedSecurityMode — required — (String)

      The advanced security mode.

      Possible values include:
      • "OFF"
      • "AUDIT"
      • "ENFORCED"
  • UsernameConfiguration — (map)

    Case sensitivity on the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.

    • CaseSensitive — required — (Boolean)

      Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs.

      Valid values include:

      True

      Enables case sensitivity for all username input. When this option is set to True, users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value.

      False

      Enables case insensitivity for all username input. For example, when this option is set to False, users can sign in using either "username" or "Username". This option also enables both preferred_username and email alias to be case insensitive, in addition to the username attribute.

  • AccountRecoverySetting — (map)

    The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

    • RecoveryMechanisms — (Array<map>)

      The list of RecoveryOptionTypes.

      • Priority — required — (Integer)

        A positive integer specifying priority of a method with 1 being the highest priority.

      • Name — required — (String)

        The recovery method for a user.

        Possible values include:
        • "verified_email"
        • "verified_phone_number"
        • "admin_only"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • UserPool — (map)

      A container for the user pool details.

      • Id — (String)

        The ID of the user pool.

      • Name — (String)

        The name of the user pool.

      • Policies — (map)

        The policies associated with the user pool.

        • PasswordPolicy — (map)

          The password policy.

          • MinimumLength — (Integer)

            The minimum length of the password in the policy that you have set. This value can't be less than 6.

          • RequireUppercase — (Boolean)

            In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password.

          • RequireLowercase — (Boolean)

            In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password.

          • RequireNumbers — (Boolean)

            In the password policy that you have set, refers to whether you have required users to use at least one number in their password.

          • RequireSymbols — (Boolean)

            In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.

          • TemporaryPasswordValidityDays — (Integer)

            The number of days a temporary password is valid in the password policy. If the user doesn't sign in during this time, an administrator must reset their password.

            Note: When you set TemporaryPasswordValidityDays for a user pool, you can no longer set a value for the legacy UnusedAccountValidityDays parameter in that user pool.
      • DeletionProtection — (String)

        When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

        When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
      • LambdaConfig — (map)

        The Lambda triggers associated with the user pool.

        • PreSignUp — (String)

          A pre-registration Lambda trigger.

        • CustomMessage — (String)

          A custom Message Lambda trigger.

        • PostConfirmation — (String)

          A post-confirmation Lambda trigger.

        • PreAuthentication — (String)

          A pre-authentication Lambda trigger.

        • PostAuthentication — (String)

          A post-authentication Lambda trigger.

        • DefineAuthChallenge — (String)

          Defines the authentication challenge.

        • CreateAuthChallenge — (String)

          Creates an authentication challenge.

        • VerifyAuthChallengeResponse — (String)

          Verifies the authentication challenge response.

        • PreTokenGeneration — (String)

          A Lambda trigger that is invoked before token generation.

        • UserMigration — (String)

          The user migration Lambda config type.

        • CustomSMSSender — (map)

          A custom SMS sender Lambda trigger.

          • LambdaVersion — required — (String)

            Signature of the "request" attribute in the "event" information that Amazon Cognito passes to your custom SMS Lambda function. The only supported value is V1_0.

            Possible values include:
            • "V1_0"
          • LambdaArn — required — (String)

            The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send SMS notifications to users.

        • CustomEmailSender — (map)

          A custom email sender Lambda trigger.

          • LambdaVersion — required — (String)

            Signature of the "request" attribute in the "event" information Amazon Cognito passes to your custom email Lambda function. The only supported value is V1_0.

            Possible values include:
            • "V1_0"
          • LambdaArn — required — (String)

            The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send email notifications to users.

        • KMSKeyID — (String)

          The Amazon Resource Name (ARN) of an KMS key. Amazon Cognito uses the key to encrypt codes and temporary passwords sent to CustomEmailSender and CustomSMSSender.

      • Status — (String)

        The status of a user pool.

        Possible values include:
        • "Enabled"
        • "Disabled"
      • LastModifiedDate — (Date)

        The date the user pool was last modified.

      • CreationDate — (Date)

        The date the user pool was created.

      • SchemaAttributes — (Array<map>)

        A container with the schema attributes of a user pool.

        • Name — (String)

          A schema attribute of the name type.

        • AttributeDataType — (String)

          The attribute data type.

          Possible values include:
          • "String"
          • "Number"
          • "DateTime"
          • "Boolean"
        • DeveloperOnlyAttribute — (Boolean)
          Note: You should use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using DeveloperOnlyAttribute.

          Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users won't be able to modify this attribute using their access token. For example, DeveloperOnlyAttribute can be modified using AdminUpdateUserAttributes but can't be updated using UpdateUserAttributes.

        • Mutable — (Boolean)

          Specifies whether the value of the attribute can be changed.

          For any user pool attribute that is mapped to an IdP attribute, you must set this parameter to true. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.

        • Required — (Boolean)

          Specifies whether a user pool attribute is required. If the attribute is required and the user doesn't provide a value, registration or sign-in will fail.

        • NumberAttributeConstraints — (map)

          Specifies the constraints for an attribute of the number type.

          • MinValue — (String)

            The minimum value of an attribute that is of the number data type.

          • MaxValue — (String)

            The maximum value of an attribute that is of the number data type.

        • StringAttributeConstraints — (map)

          Specifies the constraints for an attribute of the string type.

          • MinLength — (String)

            The minimum length.

          • MaxLength — (String)

            The maximum length.

      • AutoVerifiedAttributes — (Array<String>)

        The attributes that are auto-verified in a user pool.

      • AliasAttributes — (Array<String>)

        The attributes that are aliased in a user pool.

      • UsernameAttributes — (Array<String>)

        Specifies whether a user can use an email address or phone number as a username when they sign up.

      • SmsVerificationMessage — (String)

        This parameter is no longer used. See VerificationMessageTemplateType.

      • EmailVerificationMessage — (String)

        This parameter is no longer used. See VerificationMessageTemplateType.

      • EmailVerificationSubject — (String)

        This parameter is no longer used. See VerificationMessageTemplateType.

      • VerificationMessageTemplate — (map)

        The template for verification messages.

        • SmsMessage — (String)

          The template for SMS messages that Amazon Cognito sends to your users.

        • EmailMessage — (String)

          The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

        • EmailSubject — (String)

          The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

        • EmailMessageByLink — (String)

          The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

        • EmailSubjectByLink — (String)

          The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

        • DefaultEmailOption — (String)

          The default email option.

          Possible values include:
          • "CONFIRM_WITH_LINK"
          • "CONFIRM_WITH_CODE"
      • SmsAuthenticationMessage — (String)

        The contents of the SMS authentication message.

      • UserAttributeUpdateSettings — (map)

        The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

        • AttributesRequireVerificationBeforeUpdate — (Array<String>)

          Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.

          You can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the UpdateUserAttributes or AdminUpdateUserAttributes API and set email_verified or phone_number_verified to true.

          When AttributesRequireVerificationBeforeUpdate is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where AttributesRequireVerificationBeforeUpdate is false, API operations that change attribute values can immediately update a user’s email or phone_number attribute.

      • MfaConfiguration — (String)

        Can be one of the following values:

        • OFF - MFA tokens aren't required and can't be specified during user registration.

        • ON - MFA tokens are required for all user registrations. You can only specify required when you're initially creating a user pool.

        • OPTIONAL - Users have the option when registering to create an MFA token.

        Possible values include:
        • "OFF"
        • "ON"
        • "OPTIONAL"
      • DeviceConfiguration — (map)

        The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

        Note: When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.
        • ChallengeRequiredOnNewDevice — (Boolean)

          When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).

          Note: Whether or not ChallengeRequiredOnNewDevice is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA.
        • DeviceOnlyRememberedOnUserPrompt — (Boolean)

          When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ConfirmDevice API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an UpdateDeviceStatus API request.

          When DeviceOnlyRememberedOnUserPrompt is false, Amazon Cognito immediately remembers devices that you register in a ConfirmDevice API request.

      • EstimatedNumberOfUsers — (Integer)

        A number estimating the size of the user pool.

      • EmailConfiguration — (map)

        The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages tfrom your user pool.

        • SourceArn — (String)

          The ARN of a verified email address in Amazon SES. Amazon Cognito uses this email address in one of the following ways, depending on the value that you specify for the EmailSendingAccount parameter:

          • If you specify COGNITO_DEFAULT, Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account.

          • If you specify DEVELOPER, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.

          The Region value of the SourceArn parameter must indicate a supported Amazon Web Services Region of your user pool. Typically, the Region in the SourceArn and the user pool Region are the same. For more information, see Amazon SES email configuration regions in the Amazon Cognito Developer Guide.

        • ReplyToEmailAddress — (String)

          The destination to which the receiver of the email should reply.

        • EmailSendingAccount — (String)

          Specifies whether Amazon Cognito uses its built-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following values:

          COGNITO_DEFAULT

          When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.

          To look up the email delivery limit for the default option, see Limits in the Amazon Cognito Developer Guide.

          The default FROM address is no-reply@verificationemail.com. To customize the FROM address, provide the Amazon Resource Name (ARN) of an Amazon SES verified email address for the SourceArn parameter.

          DEVELOPER

          When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account.

          If you use this option, provide the ARN of an Amazon SES verified email address for the SourceArn parameter.

          Before Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito creates a service-linked role, which is a type of role in your Amazon Web Services account. This role contains the permissions that allow you to access Amazon SES and send email messages from your email address. For more information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito in the Amazon Cognito Developer Guide.

          Possible values include:
          • "COGNITO_DEFAULT"
          • "DEVELOPER"
        • From — (String)

          Either the sender’s email address or the sender’s name with their email address. For example, testuser@example.com or Test User <testuser@example.com>. This address appears before the body of the email.

        • ConfigurationSet — (String)

          The set of configuration rules that can be applied to emails sent using Amazon Simple Email Service. A configuration set is applied to an email by including a reference to the configuration set in the headers of the email. Once applied, all of the rules in that configuration set are applied to the email. Configuration sets can be used to apply the following types of rules to emails:

          Event publishing

          Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other Amazon Web Services services such as and Amazon CloudWatch

          IP pool management

          When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.

      • SmsConfiguration — (map)

        The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

        • SnsCallerArn — required — (String)

          The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your Amazon Web Services account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a spending limit.

        • ExternalId — (String)

          The external ID provides additional security for your IAM role. You can use an ExternalId with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the ExternalID. If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required permissions and a trust policy that demonstrates use of the ExternalId.

          For more information about the ExternalId of a role, see How to use an external ID when granting access to your Amazon Web Services resources to a third party

        • SnsRegion — (String)

          The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported Legacy Amazon SNS alternate Region.

          Amazon Cognito resources in the Asia Pacific (Seoul) Amazon Web Services Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see SMS message settings for Amazon Cognito user pools.

      • UserPoolTags — (map<String>)

        The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

      • SmsConfigurationFailure — (String)

        The reason why the SMS configuration can't send the messages to your users.

        This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.

        InvalidSmsRoleAccessPolicyException

        The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see SmsConfigurationType.

        SNSSandbox

        The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the IAM user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.

      • EmailConfigurationFailure — (String)

        Deprecated. Review error codes from API requests with EventSource:cognito-idp.amazonaws.com in CloudTrail for information about problems with user pool email configuration.

      • Domain — (String)

        The domain prefix, if the user pool has a domain associated with it.

      • CustomDomain — (String)

        A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. An example of a custom domain name might be auth.example.com.

        For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.

      • AdminCreateUserConfig — (map)

        The configuration for AdminCreateUser requests.

        • AllowAdminCreateUserOnly — (Boolean)

          Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.

        • UnusedAccountValidityDays — (Integer)

          The user account expiration limit, in days, after which a new account that hasn't signed in is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. The default value for this parameter is 7.

          Note: If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be used, and UnusedAccountValidityDays will be no longer be an available parameter for that user pool.
        • InviteMessageTemplate — (map)

          The message template to be used for the welcome message to new users.

          See also Customizing User Invitation Messages.

          • SMSMessage — (String)

            The message template for SMS messages.

          • EmailMessage — (String)

            The message template for email messages. EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.

          • EmailSubject — (String)

            The subject line for email messages. EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.

      • UserPoolAddOns — (map)

        The user pool add-ons.

        • AdvancedSecurityMode — required — (String)

          The advanced security mode.

          Possible values include:
          • "OFF"
          • "AUDIT"
          • "ENFORCED"
      • UsernameConfiguration — (map)

        Case sensitivity of the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.

        • CaseSensitive — required — (Boolean)

          Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs.

          Valid values include:

          True

          Enables case sensitivity for all username input. When this option is set to True, users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value.

          False

          Enables case insensitivity for all username input. For example, when this option is set to False, users can sign in using either "username" or "Username". This option also enables both preferred_username and email alias to be case insensitive, in addition to the username attribute.

      • Arn — (String)

        The Amazon Resource Name (ARN) for the user pool.

      • AccountRecoverySetting — (map)

        The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

        • RecoveryMechanisms — (Array<map>)

          The list of RecoveryOptionTypes.

          • Priority — required — (Integer)

            A positive integer specifying priority of a method with 1 being the highest priority.

          • Name — required — (String)

            The recovery method for a user.

            Possible values include:
            • "verified_email"
            • "verified_phone_number"
            • "admin_only"