Class: Aws::CognitoIdentityProvider::Types::AnalyticsMetadataType

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::AnalyticsMetadataType

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

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 Amazon Web Services 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].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html [3]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html [4]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RespondToAuthChallenge.html [5]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminRespondToAuthChallenge.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #analytics_endpoint_id ⇒ String

  The endpoint ID.

Instance Attribute Details

#analytics_endpoint_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2475

class AnalyticsMetadataType < Struct.new(
  :analytics_endpoint_id)
  SENSITIVE = []
  include Aws::Structure
end