You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SES::Types::CloudWatchDimensionConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb

Overview

Note:

When making an API call, you may pass CloudWatchDimensionConfiguration data as a hash:

{
  dimension_name: "DimensionName", # required
  dimension_value_source: "messageTag", # required, accepts messageTag, emailHeader, linkTag
  default_dimension_value: "DefaultDimensionValue", # required
}

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.

Instance Attribute Summary collapse

Instance Attribute Details

#default_dimension_valueString

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:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • Contain less than 256 characters.

Returns:

  • (String)


487
488
489
490
491
492
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 487

class CloudWatchDimensionConfiguration < Struct.new(
  :dimension_name,
  :dimension_value_source,
  :default_dimension_value)
  include Aws::Structure
end

#dimension_nameString

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

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • Contain less than 256 characters.

Returns:

  • (String)


487
488
489
490
491
492
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 487

class CloudWatchDimensionConfiguration < Struct.new(
  :dimension_name,
  :dimension_value_source,
  :default_dimension_value)
  include Aws::Structure
end

#dimension_value_sourceString

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.

Returns:

  • (String)


487
488
489
490
491
492
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 487

class CloudWatchDimensionConfiguration < Struct.new(
  :dimension_name,
  :dimension_value_source,
  :default_dimension_value)
  include Aws::Structure
end