AnalyticsConfigurationType
The Amazon Pinpoint analytics configuration necessary to collect metrics for a user pool.
Note
In Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
Contents
- ApplicationArn
-
The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
Required: No
- ApplicationId
-
The application ID for an Amazon Pinpoint application.
Type: String
Pattern:
^[0-9a-fA-F]+$
Required: No
- ExternalId
-
The external ID.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 131072.
Required: No
- RoleArn
-
The ARN of an AWS Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
Required: No
-
If
UserDataShared
istrue
, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.Type: Boolean
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: