AnalyticsMetadataType - Amazon Cognito User Pools

AnalyticsMetadataType

Information that your application adds to authentication requests. Applies an endpoint ID to the analytics data that your user pool sends to Amazon Pinpoint.

An endpoint ID uniquely identifies a mobile device, email address or phone number that can receive messages from Amazon Pinpoint analytics. For more information about AWS Regions that can contain Amazon Pinpoint resources for use with Amazon Cognito user pools, see Using Amazon Pinpoint analytics with Amazon Cognito user pools.

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

Contents

AnalyticsEndpointId

The endpoint ID. Information that you want to pass to Amazon Pinpoint about where to send notifications.

Type: String

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

Required: No

See Also

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