Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.PinpointEmail.Types.CloudWatchDimensionConfiguration

Description

Documentation

data CloudWatchDimensionConfiguration Source #

An object that defines the dimension configuration to use when you send Amazon Pinpoint email events to Amazon CloudWatch.

See: newCloudWatchDimensionConfiguration smart constructor.

Constructors

CloudWatchDimensionConfiguration'

Fields

dimensionName :: Text
The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:
- It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
- It can contain no more than 256 characters.
dimensionValueSource :: DimensionValueSource
The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon Pinpoint to use your own email headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags.
defaultDimensionValue :: Text
The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:
- It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
- It can contain no more than 256 characters.

Instances

Instances details

Eq CloudWatchDimensionConfiguration Source #
Instance details Defined in Amazonka.PinpointEmail.Types.CloudWatchDimensionConfiguration Methods (==) :: CloudWatchDimensionConfiguration -> CloudWatchDimensionConfiguration -> Bool # (/=) :: CloudWatchDimensionConfiguration -> CloudWatchDimensionConfiguration -> Bool #
Read CloudWatchDimensionConfiguration Source #
Instance details Defined in Amazonka.PinpointEmail.Types.CloudWatchDimensionConfiguration Methods readsPrec :: Int -> ReadS CloudWatchDimensionConfiguration # readList :: ReadS [CloudWatchDimensionConfiguration] # readPrec :: ReadPrec CloudWatchDimensionConfiguration # readListPrec :: ReadPrec [CloudWatchDimensionConfiguration] #
Show CloudWatchDimensionConfiguration Source #
Instance details Defined in Amazonka.PinpointEmail.Types.CloudWatchDimensionConfiguration Methods showsPrec :: Int -> CloudWatchDimensionConfiguration -> ShowS # show :: CloudWatchDimensionConfiguration -> String # showList :: [CloudWatchDimensionConfiguration] -> ShowS #
Generic CloudWatchDimensionConfiguration Source #
Instance details Defined in Amazonka.PinpointEmail.Types.CloudWatchDimensionConfiguration Associated Types type Rep CloudWatchDimensionConfiguration :: Type -> Type # Methods from :: CloudWatchDimensionConfiguration -> Rep CloudWatchDimensionConfiguration x # to :: Rep CloudWatchDimensionConfiguration x -> CloudWatchDimensionConfiguration #
NFData CloudWatchDimensionConfiguration Source #
Instance details Defined in Amazonka.PinpointEmail.Types.CloudWatchDimensionConfiguration Methods rnf :: CloudWatchDimensionConfiguration -> () #
Hashable CloudWatchDimensionConfiguration Source #
Instance details Defined in Amazonka.PinpointEmail.Types.CloudWatchDimensionConfiguration Methods hashWithSalt :: Int -> CloudWatchDimensionConfiguration -> Int # hash :: CloudWatchDimensionConfiguration -> Int #
ToJSON CloudWatchDimensionConfiguration Source #
Instance details Defined in Amazonka.PinpointEmail.Types.CloudWatchDimensionConfiguration Methods toJSON :: CloudWatchDimensionConfiguration -> Value # toEncoding :: CloudWatchDimensionConfiguration -> Encoding # toJSONList :: [CloudWatchDimensionConfiguration] -> Value # toEncodingList :: [CloudWatchDimensionConfiguration] -> Encoding #
FromJSON CloudWatchDimensionConfiguration Source #
Instance details Defined in Amazonka.PinpointEmail.Types.CloudWatchDimensionConfiguration Methods parseJSON :: Value -> Parser CloudWatchDimensionConfiguration # parseJSONList :: Value -> Parser [CloudWatchDimensionConfiguration] #
type Rep CloudWatchDimensionConfiguration Source #
Instance details Defined in Amazonka.PinpointEmail.Types.CloudWatchDimensionConfiguration type Rep CloudWatchDimensionConfiguration = D1 ('MetaData "CloudWatchDimensionConfiguration" "Amazonka.PinpointEmail.Types.CloudWatchDimensionConfiguration" "libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email" 'False) (C1 ('MetaCons "CloudWatchDimensionConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dimensionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "dimensionValueSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DimensionValueSource) :: S1 ('MetaSel ('Just "defaultDimensionValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCloudWatchDimensionConfiguration Source #

Arguments

:: Text	`$sel:dimensionName:CloudWatchDimensionConfiguration'`
-> DimensionValueSource	`$sel:dimensionValueSource:CloudWatchDimensionConfiguration'`
-> Text	`$sel:defaultDimensionValue:CloudWatchDimensionConfiguration'`
-> CloudWatchDimensionConfiguration

Create a value of CloudWatchDimensionConfiguration 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:dimensionName:CloudWatchDimensionConfiguration', cloudWatchDimensionConfiguration_dimensionName - The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:

It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
It can contain no more than 256 characters.

$sel:dimensionValueSource:CloudWatchDimensionConfiguration', cloudWatchDimensionConfiguration_dimensionValueSource - The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon Pinpoint to use your own email headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags.

$sel:defaultDimensionValue:CloudWatchDimensionConfiguration', cloudWatchDimensionConfiguration_defaultDimensionValue - The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:

It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
It can contain no more than 256 characters.

cloudWatchDimensionConfiguration_dimensionName :: Lens' CloudWatchDimensionConfiguration Text Source #

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:

It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
It can contain no more than 256 characters.

cloudWatchDimensionConfiguration_dimensionValueSource :: Lens' CloudWatchDimensionConfiguration DimensionValueSource Source #

The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon Pinpoint to use your own email headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags.

cloudWatchDimensionConfiguration_defaultDimensionValue :: Lens' CloudWatchDimensionConfiguration Text Source #

The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:

It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
It can contain no more than 256 characters.