NewDeviceMetadataType - Amazon Cognito User Pools
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

NewDeviceMetadataType

Information that your user pool responds with in AuthenticationResultwhen you configure it to remember devices and a user signs in with an unrecognized device. Amazon Cognito presents a new device key that you can use to set up device authentication in a "Remember me on this device" authentication model.

This data type is a response parameter of authentication operations like InitiateAuth, AdminInitiateAuth, RespondToAuthChallenge, and AdminRespondToAuthChallenge.

Contents

DeviceGroupKey

The device group key, an identifier used in generating the DEVICE_PASSWORD_VERIFIER for device SRP authentication.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 131072.

Required: No

DeviceKey

The device key, an identifier used in generating the DEVICE_PASSWORD_VERIFIER for device SRP authentication.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 55.

Pattern: [\w-]+_[0-9a-f-]+

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: