AnalyticsConfigurationType
The Amazon Pinpoint analytics configuration for collecting metrics for a user pool.
In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will 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 for Pinpoint integration with the chosen User Pool Client. Amazon Cognito publishes events to the pinpoint project declared by the app ARN.
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
Required: No
- RoleArn
-
The ARN of an IAM 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
- UserDataShared
-
If
UserDataShared
istrue
, Amazon Cognito will include user data in the events 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: