Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CognitoIdentityProvider.Types.AnalyticsConfigurationType

Description

Documentation

data AnalyticsConfigurationType Source #

The Amazon Pinpoint analytics configuration necessary to collect metrics for a user pool.

In Regions where Amazon Pinpointisn'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.

See: newAnalyticsConfigurationType smart constructor.

Constructors

AnalyticsConfigurationType'

Fields

applicationArn :: Maybe Text
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.
applicationId :: Maybe Text
The application ID for an Amazon Pinpoint application.
externalId :: Maybe Text
The external ID.
roleArn :: Maybe Text
The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
userDataShared :: Maybe Bool
If UserDataShared is true, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.

Instances

Instances details

FromJSON AnalyticsConfigurationType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.AnalyticsConfigurationType Methods parseJSON :: Value -> Parser AnalyticsConfigurationType # parseJSONList :: Value -> Parser [AnalyticsConfigurationType] #
ToJSON AnalyticsConfigurationType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.AnalyticsConfigurationType Methods toJSON :: AnalyticsConfigurationType -> Value # toEncoding :: AnalyticsConfigurationType -> Encoding # toJSONList :: [AnalyticsConfigurationType] -> Value # toEncodingList :: [AnalyticsConfigurationType] -> Encoding #
Generic AnalyticsConfigurationType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.AnalyticsConfigurationType Associated Types type Rep AnalyticsConfigurationType :: Type -> Type # Methods from :: AnalyticsConfigurationType -> Rep AnalyticsConfigurationType x # to :: Rep AnalyticsConfigurationType x -> AnalyticsConfigurationType #
Read AnalyticsConfigurationType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.AnalyticsConfigurationType Methods readsPrec :: Int -> ReadS AnalyticsConfigurationType # readList :: ReadS [AnalyticsConfigurationType] # readPrec :: ReadPrec AnalyticsConfigurationType # readListPrec :: ReadPrec [AnalyticsConfigurationType] #
Show AnalyticsConfigurationType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.AnalyticsConfigurationType Methods showsPrec :: Int -> AnalyticsConfigurationType -> ShowS # show :: AnalyticsConfigurationType -> String # showList :: [AnalyticsConfigurationType] -> ShowS #
NFData AnalyticsConfigurationType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.AnalyticsConfigurationType Methods rnf :: AnalyticsConfigurationType -> () #
Eq AnalyticsConfigurationType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.AnalyticsConfigurationType Methods (==) :: AnalyticsConfigurationType -> AnalyticsConfigurationType -> Bool # (/=) :: AnalyticsConfigurationType -> AnalyticsConfigurationType -> Bool #
Hashable AnalyticsConfigurationType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.AnalyticsConfigurationType Methods hashWithSalt :: Int -> AnalyticsConfigurationType -> Int # hash :: AnalyticsConfigurationType -> Int #
type Rep AnalyticsConfigurationType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.AnalyticsConfigurationType type Rep AnalyticsConfigurationType = D1 ('MetaData "AnalyticsConfigurationType" "Amazonka.CognitoIdentityProvider.Types.AnalyticsConfigurationType" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "AnalyticsConfigurationType'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "applicationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "userDataShared") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))))

newAnalyticsConfigurationType :: AnalyticsConfigurationType Source #

Create a value of AnalyticsConfigurationType with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:applicationArn:AnalyticsConfigurationType', analyticsConfigurationType_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.

$sel:applicationId:AnalyticsConfigurationType', analyticsConfigurationType_applicationId - The application ID for an Amazon Pinpoint application.

$sel:externalId:AnalyticsConfigurationType', analyticsConfigurationType_externalId - The external ID.

$sel:roleArn:AnalyticsConfigurationType', analyticsConfigurationType_roleArn - The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.

$sel:userDataShared:AnalyticsConfigurationType', analyticsConfigurationType_userDataShared - If UserDataShared is true, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.

analyticsConfigurationType_applicationArn :: Lens' AnalyticsConfigurationType (Maybe Text) Source #

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.

analyticsConfigurationType_applicationId :: Lens' AnalyticsConfigurationType (Maybe Text) Source #

The application ID for an Amazon Pinpoint application.

analyticsConfigurationType_externalId :: Lens' AnalyticsConfigurationType (Maybe Text) Source #

The external ID.

analyticsConfigurationType_roleArn :: Lens' AnalyticsConfigurationType (Maybe Text) Source #

The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.

analyticsConfigurationType_userDataShared :: Lens' AnalyticsConfigurationType (Maybe Bool) Source #

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