Skip to content

AnalyticsConfigurationType

Used by
Source code in docs_src/capo_cognito_identity_provider/types/analytics_configuration_type.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class AnalyticsConfigurationType(TypedDict, closed=True):
    application_id: NotRequired[
        "capo_cognito_identity_provider.types.hex_string_type.HexStringType"
    ]
    """<p>Your Amazon Pinpoint project ID.</p>"""
    application_arn: NotRequired[
        "capo_cognito_identity_provider.types.arn_type.ArnType"
    ]
    """<p>The Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to your user pool app client. Amazon Cognito publishes events to the Amazon Pinpoint project that <code>ApplicationArn</code> declares. You can also configure your application to pass an endpoint ID in the <code>AnalyticsMetadata</code> parameter of sign-in operations. The endpoint ID is information about the destination for push notifications</p>"""
    role_arn: NotRequired["capo_cognito_identity_provider.types.arn_type.ArnType"]
    """<p>The ARN of an Identity and Access Management role that has the permissions required for Amazon Cognito to publish events to Amazon Pinpoint analytics.</p>"""
    external_id: NotRequired[
        "capo_cognito_identity_provider.types.string_type.StringType"
    ]
    """<p>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html">external ID</a> of the role that Amazon Cognito assumes to send analytics data to Amazon Pinpoint.</p>"""
    user_data_shared: "capo_cognito_identity_provider.types.boolean_type.BooleanType"
    """<p>If <code>UserDataShared</code> is <code>true</code>, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.</p>"""

application_arn instance-attribute 

application_arn: NotRequired[ArnType]

The Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to your user pool app client. Amazon Cognito publishes events to the Amazon Pinpoint project that ApplicationArn declares. You can also configure your application to pass an endpoint ID in the AnalyticsMetadata parameter of sign-in operations. The endpoint ID is information about the destination for push notifications

application_id instance-attribute 

application_id: NotRequired[HexStringType]

Your Amazon Pinpoint project ID.

external_id instance-attribute 

external_id: NotRequired[StringType]

The external ID of the role that Amazon Cognito assumes to send analytics data to Amazon Pinpoint.

role_arn instance-attribute 

role_arn: NotRequired[ArnType]

The ARN of an Identity and Access Management role that has the permissions required for Amazon Cognito to publish events to Amazon Pinpoint analytics.

user_data_shared instance-attribute 

user_data_shared: BooleanType

If UserDataShared is true, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.