The Amazon Pinpoint analytics configuration necessary to collect metrics for a user pool.
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.
AnalyticsConfigurationType is a JSON Structure definition published by Amazon Cognito, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-structure/user-pools-analytics-configuration-type-structure.json",
"name": "AnalyticsConfigurationType",
"description": "<p>The Amazon Pinpoint analytics configuration necessary to collect metrics for a user pool.</p> <note> <p>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.</p> </note>",
"type": "object",
"properties": {
"ApplicationId": {
"allOf": [
{
"$ref": "#/components/schemas/HexStringType"
},
{
"description": "The application ID for an Amazon Pinpoint application."
}
]
},
"ApplicationArn": {
"allOf": [
{
"$ref": "#/components/schemas/ArnType"
},
{
"description": "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."
}
]
},
"RoleArn": {
"allOf": [
{
"$ref": "#/components/schemas/ArnType"
},
{
"description": "The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics."
}
]
},
"ExternalId": {
"allOf": [
{
"$ref": "#/components/schemas/StringType"
},
{
"description": "The external ID."
}
]
},
"UserDataShared": {
"allOf": [
{
"$ref": "#/components/schemas/BooleanType"
},
{
"description": "If <code>UserDataShared</code> is <code>true</code>, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics."
}
]
}
}
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.