libZSservicesZSamazonka-sesZSamazonka-ses
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SES.Types.CloudWatchDimensionConfiguration

Description

 
Synopsis

Documentation

data CloudWatchDimensionConfiguration Source #

Contains the dimension configuration to use when you publish email sending events to Amazon CloudWatch.

For information about publishing email sending events to Amazon CloudWatch, see the Amazon SES Developer Guide.

See: newCloudWatchDimensionConfiguration smart constructor.

Constructors

CloudWatchDimensionConfiguration' 

Fields

  • dimensionName :: Text

    The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must:

    • This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
    • Contain less than 256 characters.
  • dimensionValueSource :: DimensionValueSource

    The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon SES 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 SES to use your own email headers, choose emailHeader.

  • defaultDimensionValue :: Text

    The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must:

    • This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
    • Contain less than 256 characters.

Instances

Instances details
Eq CloudWatchDimensionConfiguration Source # 
Instance details

Defined in Amazonka.SES.Types.CloudWatchDimensionConfiguration

Read CloudWatchDimensionConfiguration Source # 
Instance details

Defined in Amazonka.SES.Types.CloudWatchDimensionConfiguration

Show CloudWatchDimensionConfiguration Source # 
Instance details

Defined in Amazonka.SES.Types.CloudWatchDimensionConfiguration

Generic CloudWatchDimensionConfiguration Source # 
Instance details

Defined in Amazonka.SES.Types.CloudWatchDimensionConfiguration

Associated Types

type Rep CloudWatchDimensionConfiguration :: Type -> Type #

NFData CloudWatchDimensionConfiguration Source # 
Instance details

Defined in Amazonka.SES.Types.CloudWatchDimensionConfiguration

Hashable CloudWatchDimensionConfiguration Source # 
Instance details

Defined in Amazonka.SES.Types.CloudWatchDimensionConfiguration

ToQuery CloudWatchDimensionConfiguration Source # 
Instance details

Defined in Amazonka.SES.Types.CloudWatchDimensionConfiguration

FromXML CloudWatchDimensionConfiguration Source # 
Instance details

Defined in Amazonka.SES.Types.CloudWatchDimensionConfiguration

type Rep CloudWatchDimensionConfiguration Source # 
Instance details

Defined in Amazonka.SES.Types.CloudWatchDimensionConfiguration

type Rep CloudWatchDimensionConfiguration = D1 ('MetaData "CloudWatchDimensionConfiguration" "Amazonka.SES.Types.CloudWatchDimensionConfiguration" "libZSservicesZSamazonka-sesZSamazonka-ses" '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 #

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

  • This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
  • Contain less than 256 characters.

$sel:dimensionValueSource:CloudWatchDimensionConfiguration', cloudWatchDimensionConfiguration_dimensionValueSource - The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon SES 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 SES to use your own email headers, choose emailHeader.

$sel:defaultDimensionValue:CloudWatchDimensionConfiguration', cloudWatchDimensionConfiguration_defaultDimensionValue - The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must:

  • This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
  • Contain less than 256 characters.

cloudWatchDimensionConfiguration_dimensionName :: Lens' CloudWatchDimensionConfiguration Text Source #

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must:

  • This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
  • Contain less than 256 characters.

cloudWatchDimensionConfiguration_dimensionValueSource :: Lens' CloudWatchDimensionConfiguration DimensionValueSource Source #

The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon SES 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 SES to use your own email headers, choose emailHeader.

cloudWatchDimensionConfiguration_defaultDimensionValue :: Lens' CloudWatchDimensionConfiguration Text Source #

The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must:

  • This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
  • Contain less than 256 characters.