Describe Configuration Set

ses_describe_configuration_set

R Documentation

Returns the details of the specified configuration set

Description

Returns the details of the specified configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Usage

ses_describe_configuration_set(ConfigurationSetName,
  ConfigurationSetAttributeNames)

Arguments

ConfigurationSetName

[required] The name of the configuration set to describe.

ConfigurationSetAttributeNames

A list of configuration set attributes to return.

Value

A list with the following syntax:

list(
  ConfigurationSet = list(
    Name = "string"
  ),
  EventDestinations = list(
    list(
      Name = "string",
      Enabled = TRUE|FALSE,
      MatchingEventTypes = list(
        "send"|"reject"|"bounce"|"complaint"|"delivery"|"open"|"click"|"renderingFailure"
      ),
      KinesisFirehoseDestination = list(
        IAMRoleARN = "string",
        DeliveryStreamARN = "string"
      ),
      CloudWatchDestination = list(
        DimensionConfigurations = list(
          list(
            DimensionName = "string",
            DimensionValueSource = "messageTag"|"emailHeader"|"linkTag",
            DefaultDimensionValue = "string"
          )
        )
      ),
      SNSDestination = list(
        TopicARN = "string"
      )
    )
  ),
  TrackingOptions = list(
    CustomRedirectDomain = "string"
  ),
  DeliveryOptions = list(
    TlsPolicy = "Require"|"Optional"
  ),
  ReputationOptions = list(
    SendingEnabled = TRUE|FALSE,
    ReputationMetricsEnabled = TRUE|FALSE,
    LastFreshStart = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$describe_configuration_set(
  ConfigurationSetName = "string",
  ConfigurationSetAttributeNames = list(
    "eventDestinations"|"trackingOptions"|"deliveryOptions"|"reputationOptions"
  )
)