Amazon Cognito Identity Provider
API Reference (API Version 2016-04-18)


The Amazon Pinpoint analytics configuration for collecting metrics for a user pool.



The application ID for an Amazon Pinpoint application.

Type: String

Pattern: ^[0-9a-fA-F]+$

Required: Yes


The external ID.

Type: String

Required: Yes


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: Yes


If UserDataShared is true, 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:

On this page: