Class: Aws::SESV2::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-sesv2/client.rb

Overview

An API client for SESV2. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::SESV2::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ENV, ENV, ENV, and ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::SESV2::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::SESV2::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



444
445
446
 
# File 'lib/aws-sdk-sesv2/client.rb', line 444

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



5192
5193
5194
 
# File 'lib/aws-sdk-sesv2/client.rb', line 5192

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



5195
5196
5197
 
# File 'lib/aws-sdk-sesv2/client.rb', line 5195

def errors_module
  Errors
end

Instance Method Details

#batch_get_metric_data(params = {}) ⇒ Types::BatchGetMetricDataResponse

Retrieves batches of metric data collected based on your sending activity.

You can execute this operation no more than 16 times per second, and with at most 160 queries from the batches per second (cumulative).

Examples:

Request syntax with placeholder values


resp = client.batch_get_metric_data({
  queries: [ # required
    {
      id: "QueryIdentifier", # required
      namespace: "VDM", # required, accepts VDM
      metric: "SEND", # required, accepts SEND, COMPLAINT, PERMANENT_BOUNCE, TRANSIENT_BOUNCE, OPEN, CLICK, DELIVERY, DELIVERY_OPEN, DELIVERY_CLICK, DELIVERY_COMPLAINT
      dimensions: {
        "EMAIL_IDENTITY" => "MetricDimensionValue",
      },
      start_date: Time.now, # required
      end_date: Time.now, # required
    },
  ],
})

Response structure


resp.results #=> Array
resp.results[0].id #=> String
resp.results[0].timestamps #=> Array
resp.results[0].timestamps[0] #=> Time
resp.results[0].values #=> Array
resp.results[0].values[0] #=> Integer
resp.errors #=> Array
resp.errors[0].id #=> String
resp.errors[0].code #=> String, one of "INTERNAL_FAILURE", "ACCESS_DENIED"
resp.errors[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



498
499
500
501
 
# File 'lib/aws-sdk-sesv2/client.rb', line 498

def batch_get_metric_data(params = {}, options = {})
  req = build_request(:batch_get_metric_data, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
 
# File 'lib/aws-sdk-sesv2/client.rb', line 5165

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::SESV2')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-sesv2'
  context[:gem_version] = '1.63.0'
  Seahorse::Client::Request.new(handlers, context)
end

#cancel_export_job(params = {}) ⇒ Struct

Cancels an export job.

Examples:

Example: Cancel export job


# Cancels the export job with ID ef28cf62-9d8e-4b60-9283-b09816c99a99

resp = client.cancel_export_job({
  job_id: "ef28cf62-9d8e-4b60-9283-b09816c99a99", 
})

Request syntax with placeholder values


resp = client.cancel_export_job({
  job_id: "JobId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The export job ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



529
530
531
532
 
# File 'lib/aws-sdk-sesv2/client.rb', line 529

def cancel_export_job(params = {}, options = {})
  req = build_request(:cancel_export_job, params)
  req.send_request(options)
end

#create_configuration_set(params = {}) ⇒ Struct

Create a configuration set. *Configuration sets* are groups of rules that you can apply to the emails that you send. You apply a configuration set to an email by specifying the name of the configuration set when you call the Amazon SES API v2. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Examples:

Request syntax with placeholder values


resp = client.create_configuration_set({
  configuration_set_name: "ConfigurationSetName", # required
  tracking_options: {
    custom_redirect_domain: "CustomRedirectDomain", # required
    https_policy: "REQUIRE", # accepts REQUIRE, REQUIRE_OPEN_ONLY, OPTIONAL
  },
  delivery_options: {
    tls_policy: "REQUIRE", # accepts REQUIRE, OPTIONAL
    sending_pool_name: "PoolName",
  },
  reputation_options: {
    reputation_metrics_enabled: false,
    last_fresh_start: Time.now,
  },
  sending_options: {
    sending_enabled: false,
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  suppression_options: {
    suppressed_reasons: ["BOUNCE"], # accepts BOUNCE, COMPLAINT
  },
  vdm_options: {
    dashboard_options: {
      engagement_metrics: "ENABLED", # accepts ENABLED, DISABLED
    },
    guardian_options: {
      optimized_shared_delivery: "ENABLED", # accepts ENABLED, DISABLED
    },
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_set_name (required, String) —

    The name of the configuration set. The name can contain up to 64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_) only.

  • :tracking_options (Types::TrackingOptions) —

    An object that defines the open and click tracking options for emails that you send using the configuration set.

  • :delivery_options (Types::DeliveryOptions) —

    An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.

  • :reputation_options (Types::ReputationOptions) —

    An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.

  • :sending_options (Types::SendingOptions) —

    An object that defines whether or not Amazon SES can send email that you send using the configuration set.

  • :tags (Array<Types::Tag>) —

    An array of objects that define the tags (keys and values) to associate with the configuration set.

  • :suppression_options (Types::SuppressionOptions) —

    An object that contains information about the suppression list preferences for your account.

  • :vdm_options (Types::VdmOptions) —

    An object that defines the VDM options for emails that you send using the configuration set.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



618
619
620
621
 
# File 'lib/aws-sdk-sesv2/client.rb', line 618

def create_configuration_set(params = {}, options = {})
  req = build_request(:create_configuration_set, params)
  req.send_request(options)
end

#create_configuration_set_event_destination(params = {}) ⇒ Struct

Create an event destination. Events include message sends, deliveries, opens, clicks, bounces, and complaints. *Event destinations* are places that you can send information about these events to. For example, you can send event data to Amazon EventBridge and associate a rule to send the event to the specified target.

A single configuration set can include more than one event destination.

Examples:

Request syntax with placeholder values


resp = client.create_configuration_set_event_destination({
  configuration_set_name: "ConfigurationSetName", # required
  event_destination_name: "EventDestinationName", # required
  event_destination: { # required
    enabled: false,
    matching_event_types: ["SEND"], # accepts SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, RENDERING_FAILURE, DELIVERY_DELAY, SUBSCRIPTION
    kinesis_firehose_destination: {
      iam_role_arn: "AmazonResourceName", # required
      delivery_stream_arn: "AmazonResourceName", # required
    },
    cloud_watch_destination: {
      dimension_configurations: [ # required
        {
          dimension_name: "DimensionName", # required
          dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG
          default_dimension_value: "DefaultDimensionValue", # required
        },
      ],
    },
    sns_destination: {
      topic_arn: "AmazonResourceName", # required
    },
    event_bridge_destination: {
      event_bus_arn: "AmazonResourceName", # required
    },
    pinpoint_destination: {
      application_arn: "AmazonResourceName",
    },
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_set_name (required, String) —

    The name of the configuration set .

  • :event_destination_name (required, String) —

    A name that identifies the event destination within the configuration set.

  • :event_destination (required, Types::EventDestinationDefinition) —

    An object that defines the event destination.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



681
682
683
684
 
# File 'lib/aws-sdk-sesv2/client.rb', line 681

def create_configuration_set_event_destination(params = {}, options = {})
  req = build_request(:create_configuration_set_event_destination, params)
  req.send_request(options)
end

#create_contact(params = {}) ⇒ Struct

Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list.

Examples:

Request syntax with placeholder values


resp = client.create_contact({
  contact_list_name: "ContactListName", # required
  email_address: "EmailAddress", # required
  topic_preferences: [
    {
      topic_name: "TopicName", # required
      subscription_status: "OPT_IN", # required, accepts OPT_IN, OPT_OUT
    },
  ],
  unsubscribe_all: false,
  attributes_data: "AttributesData",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :contact_list_name (required, String) —

    The name of the contact list to which the contact should be added.

  • :email_address (required, String) —

    The contact’s email address.

  • :topic_preferences (Array<Types::TopicPreference>) —

    The contact’s preferences for being opted-in to or opted-out of topics.

  • :unsubscribe_all (Boolean) —

    A boolean value status noting if the contact is unsubscribed from all contact list topics.

  • :attributes_data (String) —

    The attribute data attached to a contact.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



727
728
729
730
 
# File 'lib/aws-sdk-sesv2/client.rb', line 727

def create_contact(params = {}, options = {})
  req = build_request(:create_contact, params)
  req.send_request(options)
end

#create_contact_list(params = {}) ⇒ Struct

Creates a contact list.

Examples:

Request syntax with placeholder values


resp = client.create_contact_list({
  contact_list_name: "ContactListName", # required
  topics: [
    {
      topic_name: "TopicName", # required
      display_name: "DisplayName", # required
      description: "Description",
      default_subscription_status: "OPT_IN", # required, accepts OPT_IN, OPT_OUT
    },
  ],
  description: "Description",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :contact_list_name (required, String) —

    The name of the contact list.

  • :topics (Array<Types::Topic>) —

    An interest group, theme, or label within a list. A contact list can have multiple topics.

  • :description (String) —

    A description of what the contact list is about.

  • :tags (Array<Types::Tag>) —

    The tags associated with a contact list.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



774
775
776
777
 
# File 'lib/aws-sdk-sesv2/client.rb', line 774

def create_contact_list(params = {}, options = {})
  req = build_request(:create_contact_list, params)
  req.send_request(options)
end

#create_custom_verification_email_template(params = {}) ⇒ Struct

Creates a new custom verification email template.

For more information about custom verification email templates, see

Using custom verification email templates][1

in the *Amazon SES

Developer Guide*.

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

[1]: docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom

Examples:

Request syntax with placeholder values


resp = client.create_custom_verification_email_template({
  template_name: "EmailTemplateName", # required
  from_email_address: "EmailAddress", # required
  template_subject: "EmailTemplateSubject", # required
  template_content: "TemplateContent", # required
  success_redirection_url: "SuccessRedirectionURL", # required
  failure_redirection_url: "FailureRedirectionURL", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template_name (required, String) —

    The name of the custom verification email template.

  • :from_email_address (required, String) —

    The email address that the custom verification email is sent from.

  • :template_subject (required, String) —

    The subject line of the custom verification email.

  • :template_content (required, String) —

    The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see [Custom verification email frequently asked questions] in the *Amazon SES Developer Guide*.

    [1]: docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom-faq

  • :success_redirection_url (required, String) —

    The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

  • :failure_redirection_url (required, String) —

    The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



835
836
837
838
 
# File 'lib/aws-sdk-sesv2/client.rb', line 835

def create_custom_verification_email_template(params = {}, options = {})
  req = build_request(:create_custom_verification_email_template, params)
  req.send_request(options)
end

#create_dedicated_ip_pool(params = {}) ⇒ Struct

Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Web Services account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, the message is sent from one of the addresses in the associated pool.

Examples:

Request syntax with placeholder values


resp = client.create_dedicated_ip_pool({
  pool_name: "PoolName", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  scaling_mode: "STANDARD", # accepts STANDARD, MANAGED
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :pool_name (required, String) —

    The name of the dedicated IP pool.

  • :tags (Array<Types::Tag>) —

    An object that defines the tags (keys and values) that you want to associate with the pool.

  • :scaling_mode (String) —

    The type of scaling mode.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



875
876
877
878
 
# File 'lib/aws-sdk-sesv2/client.rb', line 875

def create_dedicated_ip_pool(params = {}, options = {})
  req = build_request(:create_dedicated_ip_pool, params)
  req.send_request(options)
end

#create_deliverability_test_report(params = {}) ⇒ Types::CreateDeliverabilityTestReportResponse

Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon SES then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the ‘GetDeliverabilityTestReport` operation to view the results of the test.

Examples:

Request syntax with placeholder values


resp = client.create_deliverability_test_report({
  report_name: "ReportName",
  from_email_address: "EmailAddress", # required
  content: { # required
    simple: {
      subject: { # required
        data: "MessageData", # required
        charset: "Charset",
      },
      body: { # required
        text: {
          data: "MessageData", # required
          charset: "Charset",
        },
        html: {
          data: "MessageData", # required
          charset: "Charset",
        },
      },
      headers: [
        {
          name: "MessageHeaderName", # required
          value: "MessageHeaderValue", # required
        },
      ],
    },
    raw: {
      data: "data", # required
    },
    template: {
      template_name: "EmailTemplateName",
      template_arn: "AmazonResourceName",
      template_data: "EmailTemplateData",
      headers: [
        {
          name: "MessageHeaderName", # required
          value: "MessageHeaderValue", # required
        },
      ],
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.report_id #=> String
resp.deliverability_test_status #=> String, one of "IN_PROGRESS", "COMPLETED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :report_name (String) —

    A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.

  • :from_email_address (required, String) —

    The email address that the predictive inbox placement test email was sent from.

  • :content (required, Types::EmailContent) —

    The HTML body of the message that you sent when you performed the predictive inbox placement test.

  • :tags (Array<Types::Tag>) —

    An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.

Returns:

See Also:



971
972
973
974
 
# File 'lib/aws-sdk-sesv2/client.rb', line 971

def create_deliverability_test_report(params = {}, options = {})
  req = build_request(:create_deliverability_test_report, params)
  req.send_request(options)
end

#create_email_identity(params = {}) ⇒ Types::CreateEmailIdentityResponse

Starts the process of verifying an email identity. An identity is an email address or domain that you use when you send email. Before you can use an identity to send email, you first have to verify it. By verifying an identity, you demonstrate that you’re the owner of the identity, and that you’ve given Amazon SES API v2 permission to send email from the identity.

When you verify an email address, Amazon SES sends an email to the address. Your email address is verified as soon as you follow the link in the verification email.

When you verify a domain without specifying the ‘DkimSigningAttributes` object, this operation provides a set of DKIM tokens. You can convert these tokens into CNAME records, which you then add to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. This verification method is known as [Easy DKIM].

Alternatively, you can perform the verification process by providing your own public-private key pair. This verification method is known as Bring Your Own DKIM (BYODKIM). To use BYODKIM, your call to the ‘CreateEmailIdentity` operation has to include the `DkimSigningAttributes` object. When you specify this object, you provide a selector (a component of the DNS record name that identifies the public key to use for DKIM authentication) and a private key.

When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. For some DNS providers, it can take 72 hours or more to complete the domain verification process.

Additionally, you can associate an existing configuration set with the email identity that you’re verifying.

[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html

Examples:

Request syntax with placeholder values


resp = client.create_email_identity({
  email_identity: "Identity", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  dkim_signing_attributes: {
    domain_signing_selector: "Selector",
    domain_signing_private_key: "PrivateKey",
    next_signing_key_length: "RSA_1024_BIT", # accepts RSA_1024_BIT, RSA_2048_BIT
  },
  configuration_set_name: "ConfigurationSetName",
})

Response structure


resp.identity_type #=> String, one of "EMAIL_ADDRESS", "DOMAIN", "MANAGED_DOMAIN"
resp.verified_for_sending_status #=> Boolean
resp.dkim_attributes.signing_enabled #=> Boolean
resp.dkim_attributes.status #=> String, one of "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE", "NOT_STARTED"
resp.dkim_attributes.tokens #=> Array
resp.dkim_attributes.tokens[0] #=> String
resp.dkim_attributes.signing_attributes_origin #=> String, one of "AWS_SES", "EXTERNAL"
resp.dkim_attributes.next_signing_key_length #=> String, one of "RSA_1024_BIT", "RSA_2048_BIT"
resp.dkim_attributes.current_signing_key_length #=> String, one of "RSA_1024_BIT", "RSA_2048_BIT"
resp.dkim_attributes.last_key_generation_timestamp #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :email_identity (required, String) —

    The email address or domain to verify.

  • :tags (Array<Types::Tag>) —

    An array of objects that define the tags (keys and values) to associate with the email identity.

  • :dkim_signing_attributes (Types::DkimSigningAttributes) —

    If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for [Easy DKIM].

    You can only specify this object if the email identity is a domain, as opposed to an address.

    [1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html

  • :configuration_set_name (String) —

    The configuration set to use by default when sending from this identity. Note that any configuration set defined in the email sending request takes precedence.

Returns:

See Also:



1082
1083
1084
1085
 
# File 'lib/aws-sdk-sesv2/client.rb', line 1082

def create_email_identity(params = {}, options = {})
  req = build_request(:create_email_identity, params)
  req.send_request(options)
end

#create_email_identity_policy(params = {}) ⇒ Struct

Creates the specified sending authorization policy for the given identity (an email address or a domain).

<note markdown=“1”> This API is for the identity owner only. If you have not verified the identity, this API will return an error.

</note>

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the [Amazon SES Developer Guide].

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

[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html

Examples:

Request syntax with placeholder values


resp = client.create_email_identity_policy({
  email_identity: "Identity", # required
  policy_name: "PolicyName", # required
  policy: "Policy", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :email_identity (required, String) —

    The email identity.

  • :policy_name (required, String) —

    The name of the policy.

    The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.

  • :policy (required, String) —

    The text of the policy in JSON format. The policy cannot exceed 4 KB.

    For information about the syntax of sending authorization policies, see the [Amazon SES Developer Guide].

    [1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1138
1139
1140
1141
 
# File 'lib/aws-sdk-sesv2/client.rb', line 1138

def create_email_identity_policy(params = {}, options = {})
  req = build_request(:create_email_identity_policy, params)
  req.send_request(options)
end

#create_email_template(params = {}) ⇒ Struct

Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the [Amazon SES Developer Guide].

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

[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html

Examples:

Request syntax with placeholder values


resp = client.create_email_template({
  template_name: "EmailTemplateName", # required
  template_content: { # required
    subject: "EmailTemplateSubject",
    text: "EmailTemplateText",
    html: "EmailTemplateHtml",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template_name (required, String) —

    The name of the template.

  • :template_content (required, Types::EmailTemplateContent) —

    The content of the email template, composed of a subject line, an HTML part, and a text-only part.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1178
1179
1180
1181
 
# File 'lib/aws-sdk-sesv2/client.rb', line 1178

def create_email_template(params = {}, options = {})
  req = build_request(:create_email_template, params)
  req.send_request(options)
end

#create_export_job(params = {}) ⇒ Types::CreateExportJobResponse

Creates an export job for a data source and destination.

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

Examples:

Example: Create Metrics export job


# Creates a new export job for Metrics data

resp = client.create_export_job({
  export_data_source: {
    metrics_data_source: {
      dimensions: {
        "ISP" => [
          "*", 
        ], 
      }, 
      end_date: Time.parse("2023-07-02T00:00:00"), 
      metrics: [
        {
          aggregation: "VOLUME", 
          name: "SEND", 
        }, 
        {
          aggregation: "VOLUME", 
          name: "COMPLAINT", 
        }, 
        {
          aggregation: "RATE", 
          name: "COMPLAINT", 
        }, 
      ], 
      namespace: "VDM", 
      start_date: Time.parse("2023-07-01T00:00:00"), 
    }, 
  }, 
  export_destination: {
    data_format: "CSV", 
  }, 
})

resp.to_h outputs the following:
{
  job_id: "ef28cf62-9d8e-4b60-9283-b09816c99a99", 
}

Example: Create Message Insights export job


# Creates a new export job for Message Insights data

resp = client.create_export_job({
  export_data_source: {
    message_insights_data_source: {
      end_date: Time.parse("2023-07-02T00:00:00"), 
      exclude: {
        from_email_address: [
          "hello@example.com", 
        ], 
      }, 
      include: {
        subject: [
          "Hello", 
        ], 
      }, 
      start_date: Time.parse("2023-07-01T00:00:00"), 
    }, 
  }, 
  export_destination: {
    data_format: "CSV", 
  }, 
})

resp.to_h outputs the following:
{
  job_id: "ef28cf62-9d8e-4b60-9283-b09816c99a99", 
}

Request syntax with placeholder values


resp = client.create_export_job({
  export_data_source: { # required
    metrics_data_source: {
      dimensions: { # required
        "EMAIL_IDENTITY" => ["MetricDimensionValue"],
      },
      namespace: "VDM", # required, accepts VDM
      metrics: [ # required
        {
          name: "SEND", # accepts SEND, COMPLAINT, PERMANENT_BOUNCE, TRANSIENT_BOUNCE, OPEN, CLICK, DELIVERY, DELIVERY_OPEN, DELIVERY_CLICK, DELIVERY_COMPLAINT
          aggregation: "RATE", # accepts RATE, VOLUME
        },
      ],
      start_date: Time.now, # required
      end_date: Time.now, # required
    },
    message_insights_data_source: {
      start_date: Time.now, # required
      end_date: Time.now, # required
      include: {
        from_email_address: ["InsightsEmailAddress"],
        destination: ["InsightsEmailAddress"],
        subject: ["EmailSubject"],
        isp: ["Isp"],
        last_delivery_event: ["SEND"], # accepts SEND, DELIVERY, TRANSIENT_BOUNCE, PERMANENT_BOUNCE, UNDETERMINED_BOUNCE, COMPLAINT
        last_engagement_event: ["OPEN"], # accepts OPEN, CLICK
      },
      exclude: {
        from_email_address: ["InsightsEmailAddress"],
        destination: ["InsightsEmailAddress"],
        subject: ["EmailSubject"],
        isp: ["Isp"],
        last_delivery_event: ["SEND"], # accepts SEND, DELIVERY, TRANSIENT_BOUNCE, PERMANENT_BOUNCE, UNDETERMINED_BOUNCE, COMPLAINT
        last_engagement_event: ["OPEN"], # accepts OPEN, CLICK
      },
      max_results: 1,
    },
  },
  export_destination: { # required
    data_format: "CSV", # required, accepts CSV, JSON
    s3_url: "S3Url",
  },
})

Response structure


resp.job_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



1324
1325
1326
1327
 
# File 'lib/aws-sdk-sesv2/client.rb', line 1324

def create_export_job(params = {}, options = {})
  req = build_request(:create_export_job, params)
  req.send_request(options)
end

#create_import_job(params = {}) ⇒ Types::CreateImportJobResponse

Creates an import job for a data destination.

Examples:

Request syntax with placeholder values


resp = client.create_import_job({
  import_destination: { # required
    suppression_list_destination: {
      suppression_list_import_action: "DELETE", # required, accepts DELETE, PUT
    },
    contact_list_destination: {
      contact_list_name: "ContactListName", # required
      contact_list_import_action: "DELETE", # required, accepts DELETE, PUT
    },
  },
  import_data_source: { # required
    s3_url: "S3Url", # required
    data_format: "CSV", # required, accepts CSV, JSON
  },
})

Response structure


resp.job_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



1367
1368
1369
1370
 
# File 'lib/aws-sdk-sesv2/client.rb', line 1367

def create_import_job(params = {}, options = {})
  req = build_request(:create_import_job, params)
  req.send_request(options)
end

#delete_configuration_set(params = {}) ⇒ Struct

Delete an existing configuration set.

*Configuration sets* are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Examples:

Request syntax with placeholder values


resp = client.delete_configuration_set({
  configuration_set_name: "ConfigurationSetName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_set_name (required, String) —

    The name of the configuration set.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1395
1396
1397
1398
 
# File 'lib/aws-sdk-sesv2/client.rb', line 1395

def delete_configuration_set(params = {}, options = {})
  req = build_request(:delete_configuration_set, params)
  req.send_request(options)
end

#delete_configuration_set_event_destination(params = {}) ⇒ Struct

Delete an event destination.

Events include message sends, deliveries, opens, clicks, bounces, and complaints. *Event destinations* are places that you can send information about these events to. For example, you can send event data to Amazon EventBridge and associate a rule to send the event to the specified target.

Examples:

Request syntax with placeholder values


resp = client.delete_configuration_set_event_destination({
  configuration_set_name: "ConfigurationSetName", # required
  event_destination_name: "EventDestinationName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_set_name (required, String) —

    The name of the configuration set that contains the event destination to delete.

  • :event_destination_name (required, String) —

    The name of the event destination to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1428
1429
1430
1431
 
# File 'lib/aws-sdk-sesv2/client.rb', line 1428

def delete_configuration_set_event_destination(params = {}, options = {})
  req = build_request(:delete_configuration_set_event_destination, params)
  req.send_request(options)
end

#delete_contact(params = {}) ⇒ Struct

Removes a contact from a contact list.

Examples:

Request syntax with placeholder values


resp = client.delete_contact({
  contact_list_name: "ContactListName", # required
  email_address: "EmailAddress", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :contact_list_name (required, String) —

    The name of the contact list from which the contact should be removed.

  • :email_address (required, String) —

    The contact’s email address.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1454
1455
1456
1457
 
# File 'lib/aws-sdk-sesv2/client.rb', line 1454

def delete_contact(params = {}, options = {})
  req = build_request(:delete_contact, params)
  req.send_request(options)
end

#delete_contact_list(params = {}) ⇒ Struct

Deletes a contact list and all of the contacts on that list.

Examples:

Request syntax with placeholder values


resp = client.delete_contact_list({
  contact_list_name: "ContactListName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :contact_list_name (required, String) —

    The name of the contact list.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1476
1477
1478
1479
 
# File 'lib/aws-sdk-sesv2/client.rb', line 1476

def delete_contact_list(params = {}, options = {})
  req = build_request(:delete_contact_list, params)
  req.send_request(options)
end

#delete_custom_verification_email_template(params = {}) ⇒ Struct

Deletes an existing custom verification email template.

For more information about custom verification email templates, see

Using custom verification email templates][1

in the *Amazon SES

Developer Guide*.

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

[1]: docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom

Examples:

Request syntax with placeholder values


resp = client.delete_custom_verification_email_template({
  template_name: "EmailTemplateName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template_name (required, String) —

    The name of the custom verification email template that you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1509
1510
1511
1512
 
# File 'lib/aws-sdk-sesv2/client.rb', line 1509

def delete_custom_verification_email_template(params = {}, options = {})
  req = build_request(:delete_custom_verification_email_template, params)
  req.send_request(options)
end

#delete_dedicated_ip_pool(params = {}) ⇒ Struct

Delete a dedicated IP pool.

Examples:

Request syntax with placeholder values


resp = client.delete_dedicated_ip_pool({
  pool_name: "PoolName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :pool_name (required, String) —

    The name of the dedicated IP pool that you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1531
1532
1533
1534
 
# File 'lib/aws-sdk-sesv2/client.rb', line 1531

def delete_dedicated_ip_pool(params = {}, options = {})
  req = build_request(:delete_dedicated_ip_pool, params)
  req.send_request(options)
end

#delete_email_identity(params = {}) ⇒ Struct

Deletes an email identity. An identity can be either an email address or a domain name.

Examples:

Request syntax with placeholder values


resp = client.delete_email_identity({
  email_identity: "Identity", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :email_identity (required, String) —

    The identity (that is, the email address or domain) to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1554
1555
1556
1557
 
# File 'lib/aws-sdk-sesv2/client.rb', line 1554

def delete_email_identity(params = {}, options = {})
  req = build_request(:delete_email_identity, params)
  req.send_request(options)
end

#delete_email_identity_policy(params = {}) ⇒ Struct

Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.

<note markdown=“1”> This API is for the identity owner only. If you have not verified the identity, this API will return an error.

</note>

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the [Amazon SES Developer Guide].

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

[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html

Examples:

Request syntax with placeholder values


resp = client.delete_email_identity_policy({
  email_identity: "Identity", # required
  policy_name: "PolicyName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :email_identity (required, String) —

    The email identity.

  • :policy_name (required, String) —

    The name of the policy.

    The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1600
1601
1602
1603
 
# File 'lib/aws-sdk-sesv2/client.rb', line 1600

def delete_email_identity_policy(params = {}, options = {})
  req = build_request(:delete_email_identity_policy, params)
  req.send_request(options)
end

#delete_email_template(params = {}) ⇒ Struct

Deletes an email template.

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

Examples:

Request syntax with placeholder values


resp = client.delete_email_template({
  template_name: "EmailTemplateName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template_name (required, String) —

    The name of the template to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1624
1625
1626
1627
 
# File 'lib/aws-sdk-sesv2/client.rb', line 1624

def delete_email_template(params = {}, options = {})
  req = build_request(:delete_email_template, params)
  req.send_request(options)
end

#delete_suppressed_destination(params = {}) ⇒ Struct

Removes an email address from the suppression list for your account.

Examples:

Request syntax with placeholder values


resp = client.delete_suppressed_destination({
  email_address: "EmailAddress", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :email_address (required, String) —

    The suppressed email destination to remove from the account suppression list.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1647
1648
1649
1650
 
# File 'lib/aws-sdk-sesv2/client.rb', line 1647

def delete_suppressed_destination(params = {}, options = {})
  req = build_request(:delete_suppressed_destination, params)
  req.send_request(options)
end

#get_account(params = {}) ⇒ Types::GetAccountResponse

Obtain information about the email-sending status and capabilities of your Amazon SES account in the current Amazon Web Services Region.

Examples:

Response structure


resp.dedicated_ip_auto_warmup_enabled #=> Boolean
resp.enforcement_status #=> String
resp.production_access_enabled #=> Boolean
resp.send_quota.max_24_hour_send #=> Float
resp.send_quota.max_send_rate #=> Float
resp.send_quota.sent_last_24_hours #=> Float
resp.sending_enabled #=> Boolean
resp.suppression_attributes.suppressed_reasons #=> Array
resp.suppression_attributes.suppressed_reasons[0] #=> String, one of "BOUNCE", "COMPLAINT"
resp.details.mail_type #=> String, one of "MARKETING", "TRANSACTIONAL"
resp.details.website_url #=> String
resp.details.contact_language #=> String, one of "EN", "JA"
resp.details.use_case_description #=> String
resp.details.additional_contact_email_addresses #=> Array
resp.details.additional_contact_email_addresses[0] #=> String
resp.details.review_details.status #=> String, one of "PENDING", "FAILED", "GRANTED", "DENIED"
resp.details.review_details.case_id #=> String
resp.vdm_attributes.vdm_enabled #=> String, one of "ENABLED", "DISABLED"
resp.vdm_attributes.dashboard_attributes.engagement_metrics #=> String, one of "ENABLED", "DISABLED"
resp.vdm_attributes.guardian_attributes.optimized_shared_delivery #=> String, one of "ENABLED", "DISABLED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



1693
1694
1695
1696
 
# File 'lib/aws-sdk-sesv2/client.rb', line 1693

def (params = {}, options = {})
  req = build_request(:get_account, params)
  req.send_request(options)
end

#get_blacklist_reports(params = {}) ⇒ Types::GetBlacklistReportsResponse

Retrieve a list of the blacklists that your dedicated IP addresses appear on.

Examples:

Request syntax with placeholder values


resp = client.get_blacklist_reports({
  blacklist_item_names: ["BlacklistItemName"], # required
})

Response structure


resp.blacklist_report #=> Hash
resp.blacklist_report["BlacklistItemName"] #=> Array
resp.blacklist_report["BlacklistItemName"][0].rbl_name #=> String
resp.blacklist_report["BlacklistItemName"][0].listing_time #=> Time
resp.blacklist_report["BlacklistItemName"][0].description #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :blacklist_item_names (required, Array<String>) —

    A list of IP addresses that you want to retrieve blacklist information about. You can only specify the dedicated IP addresses that you use to send email using Amazon SES or Amazon Pinpoint.

Returns:

See Also:



1728
1729
1730
1731
 
# File 'lib/aws-sdk-sesv2/client.rb', line 1728

def get_blacklist_reports(params = {}, options = {})
  req = build_request(:get_blacklist_reports, params)
  req.send_request(options)
end

#get_configuration_set(params = {}) ⇒ Types::GetConfigurationSetResponse

Get information about an existing configuration set, including the dedicated IP pool that it’s associated with, whether or not it’s enabled for sending email, and more.

*Configuration sets* are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Examples:

Request syntax with placeholder values


resp = client.get_configuration_set({
  configuration_set_name: "ConfigurationSetName", # required
})

Response structure


resp.configuration_set_name #=> String
resp.tracking_options.custom_redirect_domain #=> String
resp.tracking_options.https_policy #=> String, one of "REQUIRE", "REQUIRE_OPEN_ONLY", "OPTIONAL"
resp.delivery_options.tls_policy #=> String, one of "REQUIRE", "OPTIONAL"
resp.delivery_options.sending_pool_name #=> String
resp.reputation_options.reputation_metrics_enabled #=> Boolean
resp.reputation_options.last_fresh_start #=> Time
resp.sending_options.sending_enabled #=> Boolean
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.suppression_options.suppressed_reasons #=> Array
resp.suppression_options.suppressed_reasons[0] #=> String, one of "BOUNCE", "COMPLAINT"
resp.vdm_options.dashboard_options.engagement_metrics #=> String, one of "ENABLED", "DISABLED"
resp.vdm_options.guardian_options.optimized_shared_delivery #=> String, one of "ENABLED", "DISABLED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_set_name (required, String) —

    The name of the configuration set.

Returns:

See Also:



1785
1786
1787
1788
 
# File 'lib/aws-sdk-sesv2/client.rb', line 1785

def get_configuration_set(params = {}, options = {})
  req = build_request(:get_configuration_set, params)
  req.send_request(options)
end

#get_configuration_set_event_destinations(params = {}) ⇒ Types::GetConfigurationSetEventDestinationsResponse

Retrieve a list of event destinations that are associated with a configuration set.

Events include message sends, deliveries, opens, clicks, bounces, and complaints. *Event destinations* are places that you can send information about these events to. For example, you can send event data to Amazon EventBridge and associate a rule to send the event to the specified target.

Examples:

Request syntax with placeholder values


resp = client.get_configuration_set_event_destinations({
  configuration_set_name: "ConfigurationSetName", # required
})

Response structure


resp.event_destinations #=> Array
resp.event_destinations[0].name #=> String
resp.event_destinations[0].enabled #=> Boolean
resp.event_destinations[0].matching_event_types #=> Array
resp.event_destinations[0].matching_event_types[0] #=> String, one of "SEND", "REJECT", "BOUNCE", "COMPLAINT", "DELIVERY", "OPEN", "CLICK", "RENDERING_FAILURE", "DELIVERY_DELAY", "SUBSCRIPTION"
resp.event_destinations[0].kinesis_firehose_destination.iam_role_arn #=> String
resp.event_destinations[0].kinesis_firehose_destination.delivery_stream_arn #=> String
resp.event_destinations[0].cloud_watch_destination.dimension_configurations #=> Array
resp.event_destinations[0].cloud_watch_destination.dimension_configurations[0].dimension_name #=> String
resp.event_destinations[0].cloud_watch_destination.dimension_configurations[0].dimension_value_source #=> String, one of "MESSAGE_TAG", "EMAIL_HEADER", "LINK_TAG"
resp.event_destinations[0].cloud_watch_destination.dimension_configurations[0].default_dimension_value #=> String
resp.event_destinations[0].sns_destination.topic_arn #=> String
resp.event_destinations[0].event_bridge_destination.event_bus_arn #=> String
resp.event_destinations[0].pinpoint_destination.application_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_set_name (required, String) —

    The name of the configuration set that contains the event destination.

Returns:

See Also:



1833
1834
1835
1836
 
# File 'lib/aws-sdk-sesv2/client.rb', line 1833

def get_configuration_set_event_destinations(params = {}, options = {})
  req = build_request(:get_configuration_set_event_destinations, params)
  req.send_request(options)
end

#get_contact(params = {}) ⇒ Types::GetContactResponse

Returns a contact from a contact list.

Examples:

Request syntax with placeholder values


resp = client.get_contact({
  contact_list_name: "ContactListName", # required
  email_address: "EmailAddress", # required
})

Response structure


resp.contact_list_name #=> String
resp.email_address #=> String
resp.topic_preferences #=> Array
resp.topic_preferences[0].topic_name #=> String
resp.topic_preferences[0].subscription_status #=> String, one of "OPT_IN", "OPT_OUT"
resp.topic_default_preferences #=> Array
resp.topic_default_preferences[0].topic_name #=> String
resp.topic_default_preferences[0].subscription_status #=> String, one of "OPT_IN", "OPT_OUT"
resp.unsubscribe_all #=> Boolean
resp.attributes_data #=> String
resp.created_timestamp #=> Time
resp.last_updated_timestamp #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :contact_list_name (required, String) —

    The name of the contact list to which the contact belongs.

  • :email_address (required, String) —

    The contact’s email address.

Returns:

See Also:



1883
1884
1885
1886
 
# File 'lib/aws-sdk-sesv2/client.rb', line 1883

def get_contact(params = {}, options = {})
  req = build_request(:get_contact, params)
  req.send_request(options)
end

#get_contact_list(params = {}) ⇒ Types::GetContactListResponse

Returns contact list metadata. It does not return any information about the contacts present in the list.

Examples:

Request syntax with placeholder values


resp = client.get_contact_list({
  contact_list_name: "ContactListName", # required
})

Response structure


resp.contact_list_name #=> String
resp.topics #=> Array
resp.topics[0].topic_name #=> String
resp.topics[0].display_name #=> String
resp.topics[0].description #=> String
resp.topics[0].default_subscription_status #=> String, one of "OPT_IN", "OPT_OUT"
resp.description #=> String
resp.created_timestamp #=> Time
resp.last_updated_timestamp #=> Time
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :contact_list_name (required, String) —

    The name of the contact list.

Returns:

See Also:



1928
1929
1930
1931
 
# File 'lib/aws-sdk-sesv2/client.rb', line 1928

def get_contact_list(params = {}, options = {})
  req = build_request(:get_contact_list, params)
  req.send_request(options)
end

#get_custom_verification_email_template(params = {}) ⇒ Types::GetCustomVerificationEmailTemplateResponse

Returns the custom email verification template for the template name you specify.

For more information about custom verification email templates, see

Using custom verification email templates][1

in the *Amazon SES

Developer Guide*.

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

[1]: docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom

Examples:

Request syntax with placeholder values


resp = client.get_custom_verification_email_template({
  template_name: "EmailTemplateName", # required
})

Response structure


resp.template_name #=> String
resp.from_email_address #=> String
resp.template_subject #=> String
resp.template_content #=> String
resp.success_redirection_url #=> String
resp.failure_redirection_url #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template_name (required, String) —

    The name of the custom verification email template that you want to retrieve.

Returns:

See Also:



1978
1979
1980
1981
 
# File 'lib/aws-sdk-sesv2/client.rb', line 1978

def get_custom_verification_email_template(params = {}, options = {})
  req = build_request(:get_custom_verification_email_template, params)
  req.send_request(options)
end

#get_dedicated_ip(params = {}) ⇒ Types::GetDedicatedIpResponse

Get information about a dedicated IP address, including the name of the dedicated IP pool that it’s associated with, as well information about the automatic warm-up process for the address.

Examples:

Request syntax with placeholder values


resp = client.get_dedicated_ip({
  ip: "Ip", # required
})

Response structure


resp.dedicated_ip.ip #=> String
resp.dedicated_ip.warmup_status #=> String, one of "IN_PROGRESS", "DONE"
resp.dedicated_ip.warmup_percentage #=> Integer
resp.dedicated_ip.pool_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ip (required, String) —

    The IP address that you want to obtain more information about. The value you specify has to be a dedicated IP address that’s assocaited with your Amazon Web Services account.

Returns:

See Also:



2013
2014
2015
2016
 
# File 'lib/aws-sdk-sesv2/client.rb', line 2013

def get_dedicated_ip(params = {}, options = {})
  req = build_request(:get_dedicated_ip, params)
  req.send_request(options)
end

#get_dedicated_ip_pool(params = {}) ⇒ Types::GetDedicatedIpPoolResponse

Retrieve information about the dedicated pool.

Examples:

Request syntax with placeholder values


resp = client.get_dedicated_ip_pool({
  pool_name: "PoolName", # required
})

Response structure


resp.dedicated_ip_pool.pool_name #=> String
resp.dedicated_ip_pool.scaling_mode #=> String, one of "STANDARD", "MANAGED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :pool_name (required, String) —

    The name of the dedicated IP pool to retrieve.

Returns:

See Also:



2042
2043
2044
2045
 
# File 'lib/aws-sdk-sesv2/client.rb', line 2042

def get_dedicated_ip_pool(params = {}, options = {})
  req = build_request(:get_dedicated_ip_pool, params)
  req.send_request(options)
end

#get_dedicated_ips(params = {}) ⇒ Types::GetDedicatedIpsResponse

List the dedicated IP addresses that are associated with your Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_dedicated_ips({
  pool_name: "PoolName",
  next_token: "NextToken",
  page_size: 1,
})

Response structure


resp.dedicated_ips #=> Array
resp.dedicated_ips[0].ip #=> String
resp.dedicated_ips[0].warmup_status #=> String, one of "IN_PROGRESS", "DONE"
resp.dedicated_ips[0].warmup_percentage #=> Integer
resp.dedicated_ips[0].pool_name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :pool_name (String) —

    The name of the IP pool that the dedicated IP address is associated with.

  • :next_token (String) —

    A token returned from a previous call to ‘GetDedicatedIps` to indicate the position of the dedicated IP pool in the list of IP pools.

  • :page_size (Integer) —

    The number of results to show in a single call to ‘GetDedicatedIpsRequest`. If the number of results is larger than the number you specified in this parameter, then the response includes a `NextToken` element, which you can use to obtain additional results.

Returns:

See Also:



2092
2093
2094
2095
 
# File 'lib/aws-sdk-sesv2/client.rb', line 2092

def get_dedicated_ips(params = {}, options = {})
  req = build_request(:get_dedicated_ips, params)
  req.send_request(options)
end

#get_deliverability_dashboard_options(params = {}) ⇒ Types::GetDeliverabilityDashboardOptionsResponse

Retrieve information about the status of the Deliverability dashboard for your account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other Amazon Web Services services. For more information about the features and cost of a Deliverability dashboard subscription, see [Amazon SES Pricing].

[1]: aws.amazon.com/ses/pricing/

Examples:

Response structure


resp.dashboard_enabled #=> Boolean
resp.subscription_expiry_date #=> Time
resp. #=> String, one of "ACTIVE", "PENDING_EXPIRATION", "DISABLED"
resp.active_subscribed_domains #=> Array
resp.active_subscribed_domains[0].domain #=> String
resp.active_subscribed_domains[0].subscription_start_date #=> Time
resp.active_subscribed_domains[0].inbox_placement_tracking_option.global #=> Boolean
resp.active_subscribed_domains[0].inbox_placement_tracking_option.tracked_isps #=> Array
resp.active_subscribed_domains[0].inbox_placement_tracking_option.tracked_isps[0] #=> String
resp.pending_expiration_subscribed_domains #=> Array
resp.pending_expiration_subscribed_domains[0].domain #=> String
resp.pending_expiration_subscribed_domains[0].subscription_start_date #=> Time
resp.pending_expiration_subscribed_domains[0].inbox_placement_tracking_option.global #=> Boolean
resp.pending_expiration_subscribed_domains[0].inbox_placement_tracking_option.tracked_isps #=> Array
resp.pending_expiration_subscribed_domains[0].inbox_placement_tracking_option.tracked_isps[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



2143
2144
2145
2146
 
# File 'lib/aws-sdk-sesv2/client.rb', line 2143

def get_deliverability_dashboard_options(params = {}, options = {})
  req = build_request(:get_deliverability_dashboard_options, params)
  req.send_request(options)
end

#get_deliverability_test_report(params = {}) ⇒ Types::GetDeliverabilityTestReportResponse

Retrieve the results of a predictive inbox placement test.

Examples:

Request syntax with placeholder values


resp = client.get_deliverability_test_report({
  report_id: "ReportId", # required
})

Response structure


resp.deliverability_test_report.report_id #=> String
resp.deliverability_test_report.report_name #=> String
resp.deliverability_test_report.subject #=> String
resp.deliverability_test_report.from_email_address #=> String
resp.deliverability_test_report.create_date #=> Time
resp.deliverability_test_report.deliverability_test_status #=> String, one of "IN_PROGRESS", "COMPLETED"
resp.overall_placement.inbox_percentage #=> Float
resp.overall_placement.spam_percentage #=> Float
resp.overall_placement.missing_percentage #=> Float
resp.overall_placement.spf_percentage #=> Float
resp.overall_placement.dkim_percentage #=> Float
resp.isp_placements #=> Array
resp.isp_placements[0].isp_name #=> String
resp.isp_placements[0].placement_statistics.inbox_percentage #=> Float
resp.isp_placements[0].placement_statistics.spam_percentage #=> Float
resp.isp_placements[0].placement_statistics.missing_percentage #=> Float
resp.isp_placements[0].placement_statistics.spf_percentage #=> Float
resp.isp_placements[0].placement_statistics.dkim_percentage #=> Float
resp.message #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :report_id (required, String) —

    A unique string that identifies the predictive inbox placement test.

Returns:

See Also:



2196
2197
2198
2199
 
# File 'lib/aws-sdk-sesv2/client.rb', line 2196

def get_deliverability_test_report(params = {}, options = {})
  req = build_request(:get_deliverability_test_report, params)
  req.send_request(options)
end

#get_domain_deliverability_campaign(params = {}) ⇒ Types::GetDomainDeliverabilityCampaignResponse

Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for.

Examples:

Request syntax with placeholder values


resp = client.get_domain_deliverability_campaign({
  campaign_id: "CampaignId", # required
})

Response structure


resp.domain_deliverability_campaign.campaign_id #=> String
resp.domain_deliverability_campaign.image_url #=> String
resp.domain_deliverability_campaign.subject #=> String
resp.domain_deliverability_campaign.from_address #=> String
resp.domain_deliverability_campaign.sending_ips #=> Array
resp.domain_deliverability_campaign.sending_ips[0] #=> String
resp.domain_deliverability_campaign.first_seen_date_time #=> Time
resp.domain_deliverability_campaign.last_seen_date_time #=> Time
resp.domain_deliverability_campaign.inbox_count #=> Integer
resp.domain_deliverability_campaign.spam_count #=> Integer
resp.domain_deliverability_campaign.read_rate #=> Float
resp.domain_deliverability_campaign.delete_rate #=> Float
resp.domain_deliverability_campaign.read_delete_rate #=> Float
resp.domain_deliverability_campaign.projected_volume #=> Integer
resp.domain_deliverability_campaign.esps #=> Array
resp.domain_deliverability_campaign.esps[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :campaign_id (required, String) —

    The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.

Returns:

See Also:



2242
2243
2244
2245
 
# File 'lib/aws-sdk-sesv2/client.rb', line 2242

def get_domain_deliverability_campaign(params = {}, options = {})
  req = build_request(:get_domain_deliverability_campaign, params)
  req.send_request(options)
end

#get_domain_statistics_report(params = {}) ⇒ Types::GetDomainStatisticsReportResponse

Retrieve inbox placement and engagement rates for the domains that you use to send email.

Examples:

Request syntax with placeholder values


resp = client.get_domain_statistics_report({
  domain: "Identity", # required
  start_date: Time.now, # required
  end_date: Time.now, # required
})

Response structure


resp.overall_volume.volume_statistics.inbox_raw_count #=> Integer
resp.overall_volume.volume_statistics.spam_raw_count #=> Integer
resp.overall_volume.volume_statistics.projected_inbox #=> Integer
resp.overall_volume.volume_statistics.projected_spam #=> Integer
resp.overall_volume.read_rate_percent #=> Float
resp.overall_volume.domain_isp_placements #=> Array
resp.overall_volume.domain_isp_placements[0].isp_name #=> String
resp.overall_volume.domain_isp_placements[0].inbox_raw_count #=> Integer
resp.overall_volume.domain_isp_placements[0].spam_raw_count #=> Integer
resp.overall_volume.domain_isp_placements[0].inbox_percentage #=> Float
resp.overall_volume.domain_isp_placements[0].spam_percentage #=> Float
resp.daily_volumes #=> Array
resp.daily_volumes[0].start_date #=> Time
resp.daily_volumes[0].volume_statistics.inbox_raw_count #=> Integer
resp.daily_volumes[0].volume_statistics.spam_raw_count #=> Integer
resp.daily_volumes[0].volume_statistics.projected_inbox #=> Integer
resp.daily_volumes[0].volume_statistics.projected_spam #=> Integer
resp.daily_volumes[0].domain_isp_placements #=> Array
resp.daily_volumes[0].domain_isp_placements[0].isp_name #=> String
resp.daily_volumes[0].domain_isp_placements[0].inbox_raw_count #=> Integer
resp.daily_volumes[0].domain_isp_placements[0].spam_raw_count #=> Integer
resp.daily_volumes[0].domain_isp_placements[0].inbox_percentage #=> Float
resp.daily_volumes[0].domain_isp_placements[0].spam_percentage #=> Float

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain (required, String) —

    The domain that you want to obtain deliverability metrics for.

  • :start_date (required, Time, DateTime, Date, Integer, String) —

    The first day (in Unix time) that you want to obtain domain deliverability metrics for.

  • :end_date (required, Time, DateTime, Date, Integer, String) —

    The last day (in Unix time) that you want to obtain domain deliverability metrics for. The ‘EndDate` that you specify has to be less than or equal to 30 days after the `StartDate`.

Returns:

See Also:



2305
2306
2307
2308
 
# File 'lib/aws-sdk-sesv2/client.rb', line 2305

def get_domain_statistics_report(params = {}, options = {})
  req = build_request(:get_domain_statistics_report, params)
  req.send_request(options)
end

#get_email_identity(params = {}) ⇒ Types::GetEmailIdentityResponse

Provides information about a specific identity, including the identity’s verification status, sending authorization policies, its DKIM authentication status, and its custom Mail-From settings.

Examples:

Request syntax with placeholder values


resp = client.get_email_identity({
  email_identity: "Identity", # required
})

Response structure


resp.identity_type #=> String, one of "EMAIL_ADDRESS", "DOMAIN", "MANAGED_DOMAIN"
resp.feedback_forwarding_status #=> Boolean
resp.verified_for_sending_status #=> Boolean
resp.dkim_attributes.signing_enabled #=> Boolean
resp.dkim_attributes.status #=> String, one of "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE", "NOT_STARTED"
resp.dkim_attributes.tokens #=> Array
resp.dkim_attributes.tokens[0] #=> String
resp.dkim_attributes.signing_attributes_origin #=> String, one of "AWS_SES", "EXTERNAL"
resp.dkim_attributes.next_signing_key_length #=> String, one of "RSA_1024_BIT", "RSA_2048_BIT"
resp.dkim_attributes.current_signing_key_length #=> String, one of "RSA_1024_BIT", "RSA_2048_BIT"
resp.dkim_attributes.last_key_generation_timestamp #=> Time
resp.mail_from_attributes.mail_from_domain #=> String
resp.mail_from_attributes.mail_from_domain_status #=> String, one of "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE"
resp.mail_from_attributes.behavior_on_mx_failure #=> String, one of "USE_DEFAULT_VALUE", "REJECT_MESSAGE"
resp.policies #=> Hash
resp.policies["PolicyName"] #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.configuration_set_name #=> String
resp.verification_status #=> String, one of "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE", "NOT_STARTED"
resp.verification_info.last_checked_timestamp #=> Time
resp.verification_info.last_success_timestamp #=> Time
resp.verification_info.error_type #=> String, one of "SERVICE_ERROR", "DNS_SERVER_ERROR", "HOST_NOT_FOUND", "TYPE_NOT_FOUND", "INVALID_VALUE"
resp.verification_info.soa_record.primary_name_server #=> String
resp.verification_info.soa_record.admin_email #=> String
resp.verification_info.soa_record.serial_number #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :email_identity (required, String) —

    The email identity.

Returns:

See Also:



2370
2371
2372
2373
 
# File 'lib/aws-sdk-sesv2/client.rb', line 2370

def get_email_identity(params = {}, options = {})
  req = build_request(:get_email_identity, params)
  req.send_request(options)
end

#get_email_identity_policies(params = {}) ⇒ Types::GetEmailIdentityPoliciesResponse

Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time.

<note markdown=“1”> This API is for the identity owner only. If you have not verified the identity, this API will return an error.

</note>

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the [Amazon SES Developer Guide].

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

[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html

Examples:

Request syntax with placeholder values


resp = client.get_email_identity_policies({
  email_identity: "Identity", # required
})

Response structure


resp.policies #=> Hash
resp.policies["PolicyName"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :email_identity (required, String) —

    The email identity.

Returns:

See Also:



2417
2418
2419
2420
 
# File 'lib/aws-sdk-sesv2/client.rb', line 2417

def get_email_identity_policies(params = {}, options = {})
  req = build_request(:get_email_identity_policies, params)
  req.send_request(options)
end

#get_email_template(params = {}) ⇒ Types::GetEmailTemplateResponse

Displays the template object (which includes the subject line, HTML part and text part) for the template you specify.

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

Examples:

Request syntax with placeholder values


resp = client.get_email_template({
  template_name: "EmailTemplateName", # required
})

Response structure


resp.template_name #=> String
resp.template_content.subject #=> String
resp.template_content.text #=> String
resp.template_content.html #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template_name (required, String) —

    The name of the template.

Returns:

See Also:



2452
2453
2454
2455
 
# File 'lib/aws-sdk-sesv2/client.rb', line 2452

def get_email_template(params = {}, options = {})
  req = build_request(:get_email_template, params)
  req.send_request(options)
end

#get_export_job(params = {}) ⇒ Types::GetExportJobResponse

Provides information about an export job.

Examples:

Example: Get export job


# Gets the export job with ID ef28cf62-9d8e-4b60-9283-b09816c99a99

resp = client.get_export_job({
  job_id: "ef28cf62-9d8e-4b60-9283-b09816c99a99", 
})

resp.to_h outputs the following:
{
  created_timestamp: Time.parse("1685700961057"), 
  export_data_source: {
    metrics_data_source: {
      dimensions: {
        "ISP" => [
          "*", 
        ], 
      }, 
      end_date: Time.parse("1675209600000"), 
      metrics: [
        {
          aggregation: "VOLUME", 
          name: "SEND", 
        }, 
        {
          aggregation: "VOLUME", 
          name: "COMPLAINT", 
        }, 
        {
          aggregation: "RATE", 
          name: "COMPLAINT", 
        }, 
      ], 
      namespace: "VDM", 
      start_date: Time.parse("1672531200000"), 
    }, 
  }, 
  export_destination: {
    data_format: "CSV", 
  }, 
  export_source_type: "METRICS_DATA", 
  job_id: "ef28cf62-9d8e-4b60-9283-b09816c99a99", 
  job_status: "PROCESSING", 
  statistics: {
    exported_records_count: 5, 
    processed_records_count: 5, 
  }, 
}

Request syntax with placeholder values


resp = client.get_export_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String
resp.export_source_type #=> String, one of "METRICS_DATA", "MESSAGE_INSIGHTS"
resp.job_status #=> String, one of "CREATED", "PROCESSING", "COMPLETED", "FAILED", "CANCELLED"
resp.export_destination.data_format #=> String, one of "CSV", "JSON"
resp.export_destination.s3_url #=> String
resp.export_data_source.metrics_data_source.dimensions #=> Hash
resp.export_data_source.metrics_data_source.dimensions["MetricDimensionName"] #=> Array
resp.export_data_source.metrics_data_source.dimensions["MetricDimensionName"][0] #=> String
resp.export_data_source.metrics_data_source.namespace #=> String, one of "VDM"
resp.export_data_source.metrics_data_source.metrics #=> Array
resp.export_data_source.metrics_data_source.metrics[0].name #=> String, one of "SEND", "COMPLAINT", "PERMANENT_BOUNCE", "TRANSIENT_BOUNCE", "OPEN", "CLICK", "DELIVERY", "DELIVERY_OPEN", "DELIVERY_CLICK", "DELIVERY_COMPLAINT"
resp.export_data_source.metrics_data_source.metrics[0].aggregation #=> String, one of "RATE", "VOLUME"
resp.export_data_source.metrics_data_source.start_date #=> Time
resp.export_data_source.metrics_data_source.end_date #=> Time
resp.export_data_source.message_insights_data_source.start_date #=> Time
resp.export_data_source.message_insights_data_source.end_date #=> Time
resp.export_data_source.message_insights_data_source.include.from_email_address #=> Array
resp.export_data_source.message_insights_data_source.include.from_email_address[0] #=> String
resp.export_data_source.message_insights_data_source.include.destination #=> Array
resp.export_data_source.message_insights_data_source.include.destination[0] #=> String
resp.export_data_source.message_insights_data_source.include.subject #=> Array
resp.export_data_source.message_insights_data_source.include.subject[0] #=> String
resp.export_data_source.message_insights_data_source.include.isp #=> Array
resp.export_data_source.message_insights_data_source.include.isp[0] #=> String
resp.export_data_source.message_insights_data_source.include.last_delivery_event #=> Array
resp.export_data_source.message_insights_data_source.include.last_delivery_event[0] #=> String, one of "SEND", "DELIVERY", "TRANSIENT_BOUNCE", "PERMANENT_BOUNCE", "UNDETERMINED_BOUNCE", "COMPLAINT"
resp.export_data_source.message_insights_data_source.include.last_engagement_event #=> Array
resp.export_data_source.message_insights_data_source.include.last_engagement_event[0] #=> String, one of "OPEN", "CLICK"
resp.export_data_source.message_insights_data_source.exclude.from_email_address #=> Array
resp.export_data_source.message_insights_data_source.exclude.from_email_address[0] #=> String
resp.export_data_source.message_insights_data_source.exclude.destination #=> Array
resp.export_data_source.message_insights_data_source.exclude.destination[0] #=> String
resp.export_data_source.message_insights_data_source.exclude.subject #=> Array
resp.export_data_source.message_insights_data_source.exclude.subject[0] #=> String
resp.export_data_source.message_insights_data_source.exclude.isp #=> Array
resp.export_data_source.message_insights_data_source.exclude.isp[0] #=> String
resp.export_data_source.message_insights_data_source.exclude.last_delivery_event #=> Array
resp.export_data_source.message_insights_data_source.exclude.last_delivery_event[0] #=> String, one of "SEND", "DELIVERY", "TRANSIENT_BOUNCE", "PERMANENT_BOUNCE", "UNDETERMINED_BOUNCE", "COMPLAINT"
resp.export_data_source.message_insights_data_source.exclude.last_engagement_event #=> Array
resp.export_data_source.message_insights_data_source.exclude.last_engagement_event[0] #=> String, one of "OPEN", "CLICK"
resp.export_data_source.message_insights_data_source.max_results #=> Integer
resp.created_timestamp #=> Time
resp.completed_timestamp #=> Time
resp.failure_info.failed_records_s3_url #=> String
resp.failure_info.error_message #=> String
resp.statistics.processed_records_count #=> Integer
resp.statistics.exported_records_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The export job ID.

Returns:

See Also:



2584
2585
2586
2587
 
# File 'lib/aws-sdk-sesv2/client.rb', line 2584

def get_export_job(params = {}, options = {})
  req = build_request(:get_export_job, params)
  req.send_request(options)
end

#get_import_job(params = {}) ⇒ Types::GetImportJobResponse

Provides information about an import job.

Examples:

Request syntax with placeholder values


resp = client.get_import_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String
resp.import_destination.suppression_list_destination.suppression_list_import_action #=> String, one of "DELETE", "PUT"
resp.import_destination.contact_list_destination.contact_list_name #=> String
resp.import_destination.contact_list_destination.contact_list_import_action #=> String, one of "DELETE", "PUT"
resp.import_data_source.s3_url #=> String
resp.import_data_source.data_format #=> String, one of "CSV", "JSON"
resp.failure_info.failed_records_s3_url #=> String
resp.failure_info.error_message #=> String
resp.job_status #=> String, one of "CREATED", "PROCESSING", "COMPLETED", "FAILED", "CANCELLED"
resp.created_timestamp #=> Time
resp.completed_timestamp #=> Time
resp.processed_records_count #=> Integer
resp.failed_records_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The ID of the import job.

Returns:

See Also:



2632
2633
2634
2635
 
# File 'lib/aws-sdk-sesv2/client.rb', line 2632

def get_import_job(params = {}, options = {})
  req = build_request(:get_import_job, params)
  req.send_request(options)
end

#get_message_insights(params = {}) ⇒ Types::GetMessageInsightsResponse

Provides information about a specific message, including the from address, the subject, the recipient address, email tags, as well as events associated with the message.

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

Examples:

Example: Get Message Insights


# Provides information about a specific message.

resp = client.get_message_insights({
  message_id: "000000000000ab00-0a000aa0-1234-0a0a-1234-0a0aaa0aa00a-000000", 
})

resp.to_h outputs the following:
{
  email_tags: [
    {
      name: "ses:operation", 
      value: "SendEmail", 
    }, 
    {
      name: "ses:recipient-isp", 
      value: "UNKNOWN_ISP", 
    }, 
    {
      name: "ses:source-ip", 
      value: "0.0.0.0", 
    }, 
    {
      name: "ses:from-domain", 
      value: "example.com", 
    }, 
    {
      name: "ses:sender-identity", 
      value: "hello@example.com", 
    }, 
    {
      name: "ses:caller-identity", 
      value: "Identity", 
    }, 
  ], 
  from_email_address: "hello@example.com", 
  insights: [
    {
      destination: "recipient@example.com", 
      events: [
        {
          timestamp: Time.parse("2023-01-01T00:00:00.000000+01:00"), 
          type: "SEND", 
        }, 
        {
          timestamp: Time.parse("2023-01-01T00:00:01.000000+01:00"), 
          type: "DELIVERY", 
        }, 
      ], 
      isp: "UNKNOWN_ISP", 
    }, 
  ], 
  message_id: "000000000000ab00-0a000aa0-1234-0a0a-1234-0a0aaa0aa00a-000000", 
  subject: "hello", 
}

Request syntax with placeholder values


resp = client.get_message_insights({
  message_id: "OutboundMessageId", # required
})

Response structure


resp.message_id #=> String
resp.from_email_address #=> String
resp.subject #=> String
resp.email_tags #=> Array
resp.email_tags[0].name #=> String
resp.email_tags[0].value #=> String
resp.insights #=> Array
resp.insights[0].destination #=> String
resp.insights[0].isp #=> String
resp.insights[0].events #=> Array
resp.insights[0].events[0].timestamp #=> Time
resp.insights[0].events[0].type #=> String, one of "SEND", "REJECT", "BOUNCE", "COMPLAINT", "DELIVERY", "OPEN", "CLICK", "RENDERING_FAILURE", "DELIVERY_DELAY", "SUBSCRIPTION"
resp.insights[0].events[0].details.bounce.bounce_type #=> String, one of "UNDETERMINED", "TRANSIENT", "PERMANENT"
resp.insights[0].events[0].details.bounce.bounce_sub_type #=> String
resp.insights[0].events[0].details.bounce.diagnostic_code #=> String
resp.insights[0].events[0].details.complaint.complaint_sub_type #=> String
resp.insights[0].events[0].details.complaint.complaint_feedback_type #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :message_id (required, String) —

    A ‘MessageId` is a unique identifier for a message, and is returned when sending emails through Amazon SES.

Returns:

See Also:



2743
2744
2745
2746
 
# File 'lib/aws-sdk-sesv2/client.rb', line 2743

def get_message_insights(params = {}, options = {})
  req = build_request(:get_message_insights, params)
  req.send_request(options)
end

#get_suppressed_destination(params = {}) ⇒ Types::GetSuppressedDestinationResponse

Retrieves information about a specific email address that’s on the suppression list for your account.

Examples:

Request syntax with placeholder values


resp = client.get_suppressed_destination({
  email_address: "EmailAddress", # required
})

Response structure


resp.suppressed_destination.email_address #=> String
resp.suppressed_destination.reason #=> String, one of "BOUNCE", "COMPLAINT"
resp.suppressed_destination.last_update_time #=> Time
resp.suppressed_destination.attributes.message_id #=> String
resp.suppressed_destination.attributes.feedback_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :email_address (required, String) —

    The email address that’s on the account suppression list.

Returns:

See Also:



2776
2777
2778
2779
 
# File 'lib/aws-sdk-sesv2/client.rb', line 2776

def get_suppressed_destination(params = {}, options = {})
  req = build_request(:get_suppressed_destination, params)
  req.send_request(options)
end

#list_configuration_sets(params = {}) ⇒ Types::ListConfigurationSetsResponse

List all of the configuration sets associated with your account in the current region.

*Configuration sets* are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_configuration_sets({
  next_token: "NextToken",
  page_size: 1,
})

Response structure


resp.configuration_sets #=> Array
resp.configuration_sets[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    A token returned from a previous call to ‘ListConfigurationSets` to indicate the position in the list of configuration sets.

  • :page_size (Integer) —

    The number of results to show in a single call to ‘ListConfigurationSets`. If the number of results is larger than the number you specified in this parameter, then the response includes a `NextToken` element, which you can use to obtain additional results.

Returns:

See Also:



2824
2825
2826
2827
 
# File 'lib/aws-sdk-sesv2/client.rb', line 2824

def list_configuration_sets(params = {}, options = {})
  req = build_request(:list_configuration_sets, params)
  req.send_request(options)
end

#list_contact_lists(params = {}) ⇒ Types::ListContactListsResponse

Lists all of the contact lists available.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_contact_lists({
  page_size: 1,
  next_token: "NextToken",
})

Response structure


resp.contact_lists #=> Array
resp.contact_lists[0].contact_list_name #=> String
resp.contact_lists[0].last_updated_timestamp #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :page_size (Integer) —

    Maximum number of contact lists to return at once. Use this parameter to paginate results. If additional contact lists exist beyond the specified limit, the ‘NextToken` element is sent in the response. Use the `NextToken` value in subsequent requests to retrieve additional lists.

  • :next_token (String) —

    A string token indicating that there might be additional contact lists available to be listed. Use the token provided in the Response to use in the subsequent call to ListContactLists with the same parameters to retrieve the next page of contact lists.

Returns:

See Also:



2869
2870
2871
2872
 
# File 'lib/aws-sdk-sesv2/client.rb', line 2869

def list_contact_lists(params = {}, options = {})
  req = build_request(:list_contact_lists, params)
  req.send_request(options)
end

#list_contacts(params = {}) ⇒ Types::ListContactsResponse

Lists the contacts present in a specific contact list.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_contacts({
  contact_list_name: "ContactListName", # required
  filter: {
    filtered_status: "OPT_IN", # accepts OPT_IN, OPT_OUT
    topic_filter: {
      topic_name: "TopicName",
      use_default_if_preference_unavailable: false,
    },
  },
  page_size: 1,
  next_token: "NextToken",
})

Response structure


resp.contacts #=> Array
resp.contacts[0].email_address #=> String
resp.contacts[0].topic_preferences #=> Array
resp.contacts[0].topic_preferences[0].topic_name #=> String
resp.contacts[0].topic_preferences[0].subscription_status #=> String, one of "OPT_IN", "OPT_OUT"
resp.contacts[0].topic_default_preferences #=> Array
resp.contacts[0].topic_default_preferences[0].topic_name #=> String
resp.contacts[0].topic_default_preferences[0].subscription_status #=> String, one of "OPT_IN", "OPT_OUT"
resp.contacts[0].unsubscribe_all #=> Boolean
resp.contacts[0].last_updated_timestamp #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :contact_list_name (required, String) —

    The name of the contact list.

  • :filter (Types::ListContactsFilter) —

    A filter that can be applied to a list of contacts.

  • :page_size (Integer) —

    The number of contacts that may be returned at once, which is dependent on if there are more or less contacts than the value of the PageSize. Use this parameter to paginate results. If additional contacts exist beyond the specified limit, the ‘NextToken` element is sent in the response. Use the `NextToken` value in subsequent requests to retrieve additional contacts.

  • :next_token (String) —

    A string token indicating that there might be additional contacts available to be listed. Use the token provided in the Response to use in the subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.

Returns:

See Also:



2936
2937
2938
2939
 
# File 'lib/aws-sdk-sesv2/client.rb', line 2936

def list_contacts(params = {}, options = {})
  req = build_request(:list_contacts, params)
  req.send_request(options)
end

#list_custom_verification_email_templates(params = {}) ⇒ Types::ListCustomVerificationEmailTemplatesResponse

Lists the existing custom verification email templates for your account in the current Amazon Web Services Region.

For more information about custom verification email templates, see

Using custom verification email templates][1

in the *Amazon SES

Developer Guide*.

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

[1]: docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_custom_verification_email_templates({
  next_token: "NextToken",
  page_size: 1,
})

Response structure


resp.custom_verification_email_templates #=> Array
resp.custom_verification_email_templates[0].template_name #=> String
resp.custom_verification_email_templates[0].from_email_address #=> String
resp.custom_verification_email_templates[0].template_subject #=> String
resp.custom_verification_email_templates[0].success_redirection_url #=> String
resp.custom_verification_email_templates[0].failure_redirection_url #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    A token returned from a previous call to ‘ListCustomVerificationEmailTemplates` to indicate the position in the list of custom verification email templates.

  • :page_size (Integer) —

    The number of results to show in a single call to ‘ListCustomVerificationEmailTemplates`. If the number of results is larger than the number you specified in this parameter, then the response includes a `NextToken` element, which you can use to obtain additional results.

    The value you specify has to be at least 1, and can be no more than 50.

Returns:

See Also:



2997
2998
2999
3000
 
# File 'lib/aws-sdk-sesv2/client.rb', line 2997

def list_custom_verification_email_templates(params = {}, options = {})
  req = build_request(:list_custom_verification_email_templates, params)
  req.send_request(options)
end

#list_dedicated_ip_pools(params = {}) ⇒ Types::ListDedicatedIpPoolsResponse

List all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_dedicated_ip_pools({
  next_token: "NextToken",
  page_size: 1,
})

Response structure


resp.dedicated_ip_pools #=> Array
resp.dedicated_ip_pools[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    A token returned from a previous call to ‘ListDedicatedIpPools` to indicate the position in the list of dedicated IP pools.

  • :page_size (Integer) —

    The number of results to show in a single call to ‘ListDedicatedIpPools`. If the number of results is larger than the number you specified in this parameter, then the response includes a `NextToken` element, which you can use to obtain additional results.

Returns:

See Also:



3039
3040
3041
3042
 
# File 'lib/aws-sdk-sesv2/client.rb', line 3039

def list_dedicated_ip_pools(params = {}, options = {})
  req = build_request(:list_dedicated_ip_pools, params)
  req.send_request(options)
end

#list_deliverability_test_reports(params = {}) ⇒ Types::ListDeliverabilityTestReportsResponse

Show a list of the predictive inbox placement tests that you’ve performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the ‘GetDeliverabilityTestReport` operation to view the results.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_deliverability_test_reports({
  next_token: "NextToken",
  page_size: 1,
})

Response structure


resp.deliverability_test_reports #=> Array
resp.deliverability_test_reports[0].report_id #=> String
resp.deliverability_test_reports[0].report_name #=> String
resp.deliverability_test_reports[0].subject #=> String
resp.deliverability_test_reports[0].from_email_address #=> String
resp.deliverability_test_reports[0].create_date #=> Time
resp.deliverability_test_reports[0].deliverability_test_status #=> String, one of "IN_PROGRESS", "COMPLETED"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    A token returned from a previous call to ‘ListDeliverabilityTestReports` to indicate the position in the list of predictive inbox placement tests.

  • :page_size (Integer) —

    The number of results to show in a single call to ‘ListDeliverabilityTestReports`. If the number of results is larger than the number you specified in this parameter, then the response includes a `NextToken` element, which you can use to obtain additional results.

    The value you specify has to be at least 0, and can be no more than 1000.

Returns:

See Also:



3093
3094
3095
3096
 
# File 'lib/aws-sdk-sesv2/client.rb', line 3093

def list_deliverability_test_reports(params = {}, options = {})
  req = build_request(:list_deliverability_test_reports, params)
  req.send_request(options)
end

#list_domain_deliverability_campaigns(params = {}) ⇒ Types::ListDomainDeliverabilityCampaignsResponse

Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard for the domain.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_domain_deliverability_campaigns({
  start_date: Time.now, # required
  end_date: Time.now, # required
  subscribed_domain: "Domain", # required
  next_token: "NextToken",
  page_size: 1,
})

Response structure


resp.domain_deliverability_campaigns #=> Array
resp.domain_deliverability_campaigns[0].campaign_id #=> String
resp.domain_deliverability_campaigns[0].image_url #=> String
resp.domain_deliverability_campaigns[0].subject #=> String
resp.domain_deliverability_campaigns[0].from_address #=> String
resp.domain_deliverability_campaigns[0].sending_ips #=> Array
resp.domain_deliverability_campaigns[0].sending_ips[0] #=> String
resp.domain_deliverability_campaigns[0].first_seen_date_time #=> Time
resp.domain_deliverability_campaigns[0].last_seen_date_time #=> Time
resp.domain_deliverability_campaigns[0].inbox_count #=> Integer
resp.domain_deliverability_campaigns[0].spam_count #=> Integer
resp.domain_deliverability_campaigns[0].read_rate #=> Float
resp.domain_deliverability_campaigns[0].delete_rate #=> Float
resp.domain_deliverability_campaigns[0].read_delete_rate #=> Float
resp.domain_deliverability_campaigns[0].projected_volume #=> Integer
resp.domain_deliverability_campaigns[0].esps #=> Array
resp.domain_deliverability_campaigns[0].esps[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :start_date (required, Time, DateTime, Date, Integer, String) —

    The first day that you want to obtain deliverability data for.

  • :end_date (required, Time, DateTime, Date, Integer, String) —

    The last day that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the ‘StartDate` parameter.

  • :subscribed_domain (required, String) —

    The domain to obtain deliverability data for.

  • :next_token (String) —

    A token that’s returned from a previous call to the ‘ListDomainDeliverabilityCampaigns` operation. This token indicates the position of a campaign in the list of campaigns.

  • :page_size (Integer) —

    The maximum number of results to include in response to a single call to the ‘ListDomainDeliverabilityCampaigns` operation. If the number of results is larger than the number that you specify in this parameter, the response includes a `NextToken` element, which you can use to obtain additional results.

Returns:

See Also:



3168
3169
3170
3171
 
# File 'lib/aws-sdk-sesv2/client.rb', line 3168

def list_domain_deliverability_campaigns(params = {}, options = {})
  req = build_request(:list_domain_deliverability_campaigns, params)
  req.send_request(options)
end

#list_email_identities(params = {}) ⇒ Types::ListEmailIdentitiesResponse

Returns a list of all of the email identities that are associated with your Amazon Web Services account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren’t. This operation returns identities that are associated with Amazon SES and Amazon Pinpoint.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_email_identities({
  next_token: "NextToken",
  page_size: 1,
})

Response structure


resp.email_identities #=> Array
resp.email_identities[0].identity_type #=> String, one of "EMAIL_ADDRESS", "DOMAIN", "MANAGED_DOMAIN"
resp.email_identities[0].identity_name #=> String
resp.email_identities[0].sending_enabled #=> Boolean
resp.email_identities[0].verification_status #=> String, one of "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE", "NOT_STARTED"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    A token returned from a previous call to ‘ListEmailIdentities` to indicate the position in the list of identities.

  • :page_size (Integer) —

    The number of results to show in a single call to ‘ListEmailIdentities`. If the number of results is larger than the number you specified in this parameter, then the response includes a `NextToken` element, which you can use to obtain additional results.

    The value you specify has to be at least 0, and can be no more than 1000.

Returns:

See Also:



3219
3220
3221
3222
 
# File 'lib/aws-sdk-sesv2/client.rb', line 3219

def list_email_identities(params = {}, options = {})
  req = build_request(:list_email_identities, params)
  req.send_request(options)
end

#list_email_templates(params = {}) ⇒ Types::ListEmailTemplatesResponse

Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region.

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_email_templates({
  next_token: "NextToken",
  page_size: 1,
})

Response structure


resp.templates_metadata #=> Array
resp.templates_metadata[0].template_name #=> String
resp.templates_metadata[0].created_timestamp #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    A token returned from a previous call to ‘ListEmailTemplates` to indicate the position in the list of email templates.

  • :page_size (Integer) —

    The number of results to show in a single call to ‘ListEmailTemplates`. If the number of results is larger than the number you specified in this parameter, then the response includes a `NextToken` element, which you can use to obtain additional results.

    The value you specify has to be at least 1, and can be no more than 100.

Returns:

See Also:



3267
3268
3269
3270
 
# File 'lib/aws-sdk-sesv2/client.rb', line 3267

def list_email_templates(params = {}, options = {})
  req = build_request(:list_email_templates, params)
  req.send_request(options)
end

#list_export_jobs(params = {}) ⇒ Types::ListExportJobsResponse

Lists all of the export jobs.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: List export jobs


# Lists export jobs of type METRICS_DATA and status PROCESSING

resp = client.list_export_jobs({
  export_source_type: "METRICS_DATA", 
  job_status: "PROCESSING", 
  page_size: 25, 
})

resp.to_h outputs the following:
{
  export_jobs: [
    {
      created_timestamp: Time.parse("167697473543"), 
      export_source_type: "METRICS_DATA", 
      job_id: "72de83a0-6b49-47ca-9783-8b812576887a", 
      job_status: "PROCESSING", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_export_jobs({
  next_token: "NextToken",
  page_size: 1,
  export_source_type: "METRICS_DATA", # accepts METRICS_DATA, MESSAGE_INSIGHTS
  job_status: "CREATED", # accepts CREATED, PROCESSING, COMPLETED, FAILED, CANCELLED
})

Response structure


resp.export_jobs #=> Array
resp.export_jobs[0].job_id #=> String
resp.export_jobs[0].export_source_type #=> String, one of "METRICS_DATA", "MESSAGE_INSIGHTS"
resp.export_jobs[0].job_status #=> String, one of "CREATED", "PROCESSING", "COMPLETED", "FAILED", "CANCELLED"
resp.export_jobs[0].created_timestamp #=> Time
resp.export_jobs[0].completed_timestamp #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token returned from a previous call to ‘ListExportJobs` to indicate the position in the list of export jobs.

  • :page_size (Integer) —

    Maximum number of export jobs to return at once. Use this parameter to paginate results. If additional export jobs exist beyond the specified limit, the ‘NextToken` element is sent in the response. Use the `NextToken` value in subsequent calls to `ListExportJobs` to retrieve additional export jobs.

  • :export_source_type (String) —

    A value used to list export jobs that have a certain ‘ExportSourceType`.

  • :job_status (String) —

    A value used to list export jobs that have a certain ‘JobStatus`.

Returns:

See Also:



3345
3346
3347
3348
 
# File 'lib/aws-sdk-sesv2/client.rb', line 3345

def list_export_jobs(params = {}, options = {})
  req = build_request(:list_export_jobs, params)
  req.send_request(options)
end

#list_import_jobs(params = {}) ⇒ Types::ListImportJobsResponse

Lists all of the import jobs.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_import_jobs({
  import_destination_type: "SUPPRESSION_LIST", # accepts SUPPRESSION_LIST, CONTACT_LIST
  next_token: "NextToken",
  page_size: 1,
})

Response structure


resp.import_jobs #=> Array
resp.import_jobs[0].job_id #=> String
resp.import_jobs[0].import_destination.suppression_list_destination.suppression_list_import_action #=> String, one of "DELETE", "PUT"
resp.import_jobs[0].import_destination.contact_list_destination.contact_list_name #=> String
resp.import_jobs[0].import_destination.contact_list_destination.contact_list_import_action #=> String, one of "DELETE", "PUT"
resp.import_jobs[0].job_status #=> String, one of "CREATED", "PROCESSING", "COMPLETED", "FAILED", "CANCELLED"
resp.import_jobs[0].created_timestamp #=> Time
resp.import_jobs[0].processed_records_count #=> Integer
resp.import_jobs[0].failed_records_count #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :import_destination_type (String) —

    The destination of the import job, which can be used to list import jobs that have a certain ‘ImportDestinationType`.

  • :next_token (String) —

    A string token indicating that there might be additional import jobs available to be listed. Copy this token to a subsequent call to ‘ListImportJobs` with the same parameters to retrieve the next page of import jobs.

  • :page_size (Integer) —

    Maximum number of import jobs to return at once. Use this parameter to paginate results. If additional import jobs exist beyond the specified limit, the ‘NextToken` element is sent in the response. Use the `NextToken` value in subsequent requests to retrieve additional addresses.

Returns:

See Also:



3401
3402
3403
3404
 
# File 'lib/aws-sdk-sesv2/client.rb', line 3401

def list_import_jobs(params = {}, options = {})
  req = build_request(:list_import_jobs, params)
  req.send_request(options)
end

#list_recommendations(params = {}) ⇒ Types::ListRecommendationsResponse

Lists the recommendations present in your Amazon SES account in the current Amazon Web Services Region.

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_recommendations({
  filter: {
    "TYPE" => "ListRecommendationFilterValue",
  },
  next_token: "NextToken",
  page_size: 1,
})

Response structure


resp.recommendations #=> Array
resp.recommendations[0].resource_arn #=> String
resp.recommendations[0].type #=> String, one of "DKIM", "DMARC", "SPF", "BIMI"
resp.recommendations[0].description #=> String
resp.recommendations[0].status #=> String, one of "OPEN", "FIXED"
resp.recommendations[0].created_timestamp #=> Time
resp.recommendations[0].last_updated_timestamp #=> Time
resp.recommendations[0].impact #=> String, one of "LOW", "HIGH"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter (Hash<String,String>) —

    Filters applied when retrieving recommendations. Can eiter be an individual filter, or combinations of ‘STATUS` and `IMPACT` or `STATUS` and `TYPE`

  • :next_token (String) —

    A token returned from a previous call to ‘ListRecommendations` to indicate the position in the list of recommendations.

  • :page_size (Integer) —

    The number of results to show in a single call to ‘ListRecommendations`. If the number of results is larger than the number you specified in this parameter, then the response includes a `NextToken` element, which you can use to obtain additional results.

    The value you specify has to be at least 1, and can be no more than 100.

Returns:

See Also:



3462
3463
3464
3465
 
# File 'lib/aws-sdk-sesv2/client.rb', line 3462

def list_recommendations(params = {}, options = {})
  req = build_request(:list_recommendations, params)
  req.send_request(options)
end

#list_suppressed_destinations(params = {}) ⇒ Types::ListSuppressedDestinationsResponse

Retrieves a list of email addresses that are on the suppression list for your account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_suppressed_destinations({
  reasons: ["BOUNCE"], # accepts BOUNCE, COMPLAINT
  start_date: Time.now,
  end_date: Time.now,
  next_token: "NextToken",
  page_size: 1,
})

Response structure


resp.suppressed_destination_summaries #=> Array
resp.suppressed_destination_summaries[0].email_address #=> String
resp.suppressed_destination_summaries[0].reason #=> String, one of "BOUNCE", "COMPLAINT"
resp.suppressed_destination_summaries[0].last_update_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :reasons (Array<String>) —

    The factors that caused the email address to be added to .

  • :start_date (Time, DateTime, Date, Integer, String) —

    Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list after a specific date.

  • :end_date (Time, DateTime, Date, Integer, String) —

    Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list before a specific date.

  • :next_token (String) —

    A token returned from a previous call to ‘ListSuppressedDestinations` to indicate the position in the list of suppressed email addresses.

  • :page_size (Integer) —

    The number of results to show in a single call to ‘ListSuppressedDestinations`. If the number of results is larger than the number you specified in this parameter, then the response includes a `NextToken` element, which you can use to obtain additional results.

Returns:

See Also:



3522
3523
3524
3525
 
# File 'lib/aws-sdk-sesv2/client.rb', line 3522

def list_suppressed_destinations(params = {}, options = {})
  req = build_request(:list_suppressed_destinations, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Retrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a label that you optionally define and associate with a resource. Each tag consists of a required *tag key* and an optional associated *tag value*. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "AmazonResourceName", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource that you want to retrieve tag information for.

Returns:

See Also:



3558
3559
3560
3561
 
# File 'lib/aws-sdk-sesv2/client.rb', line 3558

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#put_account_dedicated_ip_warmup_attributes(params = {}) ⇒ Struct

Enable or disable the automatic warm-up feature for dedicated IP addresses.

Examples:

Request syntax with placeholder values


resp = client.({
  auto_warmup_enabled: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_warmup_enabled (Boolean) —

    Enables or disables the automatic warm-up feature for dedicated IP addresses that are associated with your Amazon SES account in the current Amazon Web Services Region. Set to ‘true` to enable the automatic warm-up feature, or set to `false` to disable it.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3584
3585
3586
3587
 
# File 'lib/aws-sdk-sesv2/client.rb', line 3584

def (params = {}, options = {})
  req = build_request(:put_account_dedicated_ip_warmup_attributes, params)
  req.send_request(options)
end

#put_account_details(params = {}) ⇒ Struct

Update your Amazon SES account details.

Examples:

Request syntax with placeholder values


resp = client.({
  mail_type: "MARKETING", # required, accepts MARKETING, TRANSACTIONAL
  website_url: "WebsiteURL", # required
  contact_language: "EN", # accepts EN, JA
  use_case_description: "UseCaseDescription",
  additional_contact_email_addresses: ["AdditionalContactEmailAddress"],
  production_access_enabled: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :mail_type (required, String) —

    The type of email your account will send.

  • :website_url (required, String) —

    The URL of your website. This information helps us better understand the type of content that you plan to send.

  • :contact_language (String) —

    The language you would prefer to be contacted with.

  • :use_case_description (String) —

    A description of the types of email that you plan to send.

  • :additional_contact_email_addresses (Array<String>) —

    Additional email addresses that you would like to be notified regarding Amazon SES matters.

  • :production_access_enabled (Boolean) —

    Indicates whether or not your account should have production access in the current Amazon Web Services Region.

    If the value is ‘false`, then your account is in the sandbox. When your account is in the sandbox, you can only send email to verified identities.

    If the value is ‘true`, then your account has production access. When your account has production access, you can send email to any address. The sending quota and maximum sending rate for your account vary based on your specific use case.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3638
3639
3640
3641
 
# File 'lib/aws-sdk-sesv2/client.rb', line 3638

def (params = {}, options = {})
  req = build_request(:put_account_details, params)
  req.send_request(options)
end

#put_account_sending_attributes(params = {}) ⇒ Struct

Enable or disable the ability of your account to send email.

Examples:

Request syntax with placeholder values


resp = client.({
  sending_enabled: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :sending_enabled (Boolean) —

    Enables or disables your account’s ability to send email. Set to ‘true` to enable email sending, or set to `false` to disable email sending.

    <note markdown=“1”> If Amazon Web Services paused your account’s ability to send email, you can’t use this operation to resume your account’s ability to send email.

    </note>

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3668
3669
3670
3671
 
# File 'lib/aws-sdk-sesv2/client.rb', line 3668

def (params = {}, options = {})
  req = build_request(:put_account_sending_attributes, params)
  req.send_request(options)
end

#put_account_suppression_attributes(params = {}) ⇒ Struct

Change the settings for the account-level suppression list.

Examples:

Request syntax with placeholder values


resp = client.({
  suppressed_reasons: ["BOUNCE"], # accepts BOUNCE, COMPLAINT
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :suppressed_reasons (Array<String>) —

    A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. This list can contain any or all of the following:

    • ‘COMPLAINT` – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.

    • ‘BOUNCE` – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3700
3701
3702
3703
 
# File 'lib/aws-sdk-sesv2/client.rb', line 3700

def (params = {}, options = {})
  req = build_request(:put_account_suppression_attributes, params)
  req.send_request(options)
end

#put_account_vdm_attributes(params = {}) ⇒ Struct

Update your Amazon SES account VDM attributes.

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

Examples:

Request syntax with placeholder values


resp = client.({
  vdm_attributes: { # required
    vdm_enabled: "ENABLED", # required, accepts ENABLED, DISABLED
    dashboard_attributes: {
      engagement_metrics: "ENABLED", # accepts ENABLED, DISABLED
    },
    guardian_attributes: {
      optimized_shared_delivery: "ENABLED", # accepts ENABLED, DISABLED
    },
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vdm_attributes (required, Types::VdmAttributes) —

    The VDM attributes that you wish to apply to your Amazon SES account.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3732
3733
3734
3735
 
# File 'lib/aws-sdk-sesv2/client.rb', line 3732

def (params = {}, options = {})
  req = build_request(:put_account_vdm_attributes, params)
  req.send_request(options)
end

#put_configuration_set_delivery_options(params = {}) ⇒ Struct

Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email.

Examples:

Request syntax with placeholder values


resp = client.put_configuration_set_delivery_options({
  configuration_set_name: "ConfigurationSetName", # required
  tls_policy: "REQUIRE", # accepts REQUIRE, OPTIONAL
  sending_pool_name: "SendingPoolName",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_set_name (required, String) —

    The name of the configuration set to associate with a dedicated IP pool.

  • :tls_policy (String) —

    Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is ‘Require`, messages are only delivered if a TLS connection can be established. If the value is `Optional`, messages can be delivered in plain text if a TLS connection can’t be established.

  • :sending_pool_name (String) —

    The name of the dedicated IP pool to associate with the configuration set.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3770
3771
3772
3773
 
# File 'lib/aws-sdk-sesv2/client.rb', line 3770

def put_configuration_set_delivery_options(params = {}, options = {})
  req = build_request(:put_configuration_set_delivery_options, params)
  req.send_request(options)
end

#put_configuration_set_reputation_options(params = {}) ⇒ Struct

Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific Amazon Web Services Region.

Examples:

Request syntax with placeholder values


resp = client.put_configuration_set_reputation_options({
  configuration_set_name: "ConfigurationSetName", # required
  reputation_metrics_enabled: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_set_name (required, String) —

    The name of the configuration set.

  • :reputation_metrics_enabled (Boolean) —

    If ‘true`, tracking of reputation metrics is enabled for the configuration set. If `false`, tracking of reputation metrics is disabled for the configuration set.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3800
3801
3802
3803
 
# File 'lib/aws-sdk-sesv2/client.rb', line 3800

def put_configuration_set_reputation_options(params = {}, options = {})
  req = build_request(:put_configuration_set_reputation_options, params)
  req.send_request(options)
end

#put_configuration_set_sending_options(params = {}) ⇒ Struct

Enable or disable email sending for messages that use a particular configuration set in a specific Amazon Web Services Region.

Examples:

Request syntax with placeholder values


resp = client.put_configuration_set_sending_options({
  configuration_set_name: "ConfigurationSetName", # required
  sending_enabled: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_set_name (required, String) —

    The name of the configuration set to enable or disable email sending for.

  • :sending_enabled (Boolean) —

    If ‘true`, email sending is enabled for the configuration set. If `false`, email sending is disabled for the configuration set.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3829
3830
3831
3832
 
# File 'lib/aws-sdk-sesv2/client.rb', line 3829

def put_configuration_set_sending_options(params = {}, options = {})
  req = build_request(:put_configuration_set_sending_options, params)
  req.send_request(options)
end

#put_configuration_set_suppression_options(params = {}) ⇒ Struct

Specify the account suppression list preferences for a configuration set.

Examples:

Request syntax with placeholder values


resp = client.put_configuration_set_suppression_options({
  configuration_set_name: "ConfigurationSetName", # required
  suppressed_reasons: ["BOUNCE"], # accepts BOUNCE, COMPLAINT
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_set_name (required, String) —

    The name of the configuration set to change the suppression list preferences for.

  • :suppressed_reasons (Array<String>) —

    A list that contains the reasons that email addresses are automatically added to the suppression list for your account. This list can contain any or all of the following:

    • ‘COMPLAINT` – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.

    • ‘BOUNCE` – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3867
3868
3869
3870
 
# File 'lib/aws-sdk-sesv2/client.rb', line 3867

def put_configuration_set_suppression_options(params = {}, options = {})
  req = build_request(:put_configuration_set_suppression_options, params)
  req.send_request(options)
end

#put_configuration_set_tracking_options(params = {}) ⇒ Struct

Specify a custom domain to use for open and click tracking elements in email that you send.

Examples:

Request syntax with placeholder values


resp = client.put_configuration_set_tracking_options({
  configuration_set_name: "ConfigurationSetName", # required
  custom_redirect_domain: "CustomRedirectDomain",
  https_policy: "REQUIRE", # accepts REQUIRE, REQUIRE_OPEN_ONLY, OPTIONAL
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_set_name (required, String) —

    The name of the configuration set.

  • :custom_redirect_domain (String) —

    The domain to use to track open and click events.

  • :https_policy (String) —

    The https policy to use for tracking open and click events. If the value is OPTIONAL or HttpsPolicy is not specified, the open trackers use HTTP and click tracker use the original protocol of the link. If the value is REQUIRE, both open and click tracker uses HTTPS and if the value is REQUIRE_OPEN_ONLY open tracker uses HTTPS and link tracker is same as original protocol of the link.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3903
3904
3905
3906
 
# File 'lib/aws-sdk-sesv2/client.rb', line 3903

def put_configuration_set_tracking_options(params = {}, options = {})
  req = build_request(:put_configuration_set_tracking_options, params)
  req.send_request(options)
end

#put_configuration_set_vdm_options(params = {}) ⇒ Struct

Specify VDM preferences for email that you send using the configuration set.

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

Examples:

Request syntax with placeholder values


resp = client.put_configuration_set_vdm_options({
  configuration_set_name: "ConfigurationSetName", # required
  vdm_options: {
    dashboard_options: {
      engagement_metrics: "ENABLED", # accepts ENABLED, DISABLED
    },
    guardian_options: {
      optimized_shared_delivery: "ENABLED", # accepts ENABLED, DISABLED
    },
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_set_name (required, String) —

    The name of the configuration set.

  • :vdm_options (Types::VdmOptions) —

    The VDM options to apply to the configuration set.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3939
3940
3941
3942
 
# File 'lib/aws-sdk-sesv2/client.rb', line 3939

def put_configuration_set_vdm_options(params = {}, options = {})
  req = build_request(:put_configuration_set_vdm_options, params)
  req.send_request(options)
end

#put_dedicated_ip_in_pool(params = {}) ⇒ Struct

Move a dedicated IP address to an existing dedicated IP pool.

<note markdown=“1”> The dedicated IP address that you specify must already exist, and must be associated with your Amazon Web Services account.

The dedicated IP pool you specify must already exist. You can create a

new pool by using the ‘CreateDedicatedIpPool` operation.

</note>

Examples:

Request syntax with placeholder values


resp = client.put_dedicated_ip_in_pool({
  ip: "Ip", # required
  destination_pool_name: "PoolName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ip (required, String) —

    The IP address that you want to move to the dedicated IP pool. The value you specify has to be a dedicated IP address that’s associated with your Amazon Web Services account.

  • :destination_pool_name (required, String) —

    The name of the IP pool that you want to add the dedicated IP address to. You have to specify an IP pool that already exists.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3976
3977
3978
3979
 
# File 'lib/aws-sdk-sesv2/client.rb', line 3976

def put_dedicated_ip_in_pool(params = {}, options = {})
  req = build_request(:put_dedicated_ip_in_pool, params)
  req.send_request(options)
end

#put_dedicated_ip_pool_scaling_attributes(params = {}) ⇒ Struct

Used to convert a dedicated IP pool to a different scaling mode.

<note markdown=“1”> ‘MANAGED` pools cannot be converted to `STANDARD` scaling mode.

</note>

Examples:

Example: Used to convert a dedicated IP pool to a different scaling mode.


# This example converts a dedicated IP pool from STANDARD to MANAGED.

resp = client.put_dedicated_ip_pool_scaling_attributes({
  pool_name: "sample-ses-pool", 
  scaling_mode: "MANAGED", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.put_dedicated_ip_pool_scaling_attributes({
  pool_name: "PoolName", # required
  scaling_mode: "STANDARD", # required, accepts STANDARD, MANAGED
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :pool_name (required, String) —

    The name of the dedicated IP pool.

  • :scaling_mode (required, String) —

    The scaling mode to apply to the dedicated IP pool.

    <note markdown=“1”> Changing the scaling mode from ‘MANAGED` to `STANDARD` is not supported.

    </note>

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4025
4026
4027
4028
 
# File 'lib/aws-sdk-sesv2/client.rb', line 4025

def put_dedicated_ip_pool_scaling_attributes(params = {}, options = {})
  req = build_request(:put_dedicated_ip_pool_scaling_attributes, params)
  req.send_request(options)
end

#put_dedicated_ip_warmup_attributes(params = {}) ⇒ Struct

Returns an empty response.

Examples:

Request syntax with placeholder values


resp = client.put_dedicated_ip_warmup_attributes({
  ip: "Ip", # required
  warmup_percentage: 1, # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ip (required, String) —

    The dedicated IP address that you want to update the warm-up attributes for.

  • :warmup_percentage (required, Integer) —

    The warm-up percentage that you want to associate with the dedicated IP address.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4051
4052
4053
4054
 
# File 'lib/aws-sdk-sesv2/client.rb', line 4051

def put_dedicated_ip_warmup_attributes(params = {}, options = {})
  req = build_request(:put_dedicated_ip_warmup_attributes, params)
  req.send_request(options)
end

#put_deliverability_dashboard_option(params = {}) ⇒ Struct

Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other Amazon Web Services services. For more information about the features and cost of a Deliverability dashboard subscription, see [Amazon SES Pricing].

[1]: aws.amazon.com/ses/pricing/

Examples:

Request syntax with placeholder values


resp = client.put_deliverability_dashboard_option({
  dashboard_enabled: false, # required
  subscribed_domains: [
    {
      domain: "Domain",
      subscription_start_date: Time.now,
      inbox_placement_tracking_option: {
        global: false,
        tracked_isps: ["IspName"],
      },
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dashboard_enabled (required, Boolean) —

    Specifies whether to enable the Deliverability dashboard. To enable the dashboard, set this value to ‘true`.

  • :subscribed_domains (Array<Types::DomainDeliverabilityTrackingOption>) —

    An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4102
4103
4104
4105
 
# File 'lib/aws-sdk-sesv2/client.rb', line 4102

def put_deliverability_dashboard_option(params = {}, options = {})
  req = build_request(:put_deliverability_dashboard_option, params)
  req.send_request(options)
end

#put_email_identity_configuration_set_attributes(params = {}) ⇒ Struct

Used to associate a configuration set with an email identity.

Examples:

Request syntax with placeholder values


resp = client.put_email_identity_configuration_set_attributes({
  email_identity: "Identity", # required
  configuration_set_name: "ConfigurationSetName",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :email_identity (required, String) —

    The email address or domain to associate with a configuration set.

  • :configuration_set_name (String) —

    The configuration set to associate with an email identity.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4128
4129
4130
4131
 
# File 'lib/aws-sdk-sesv2/client.rb', line 4128

def put_email_identity_configuration_set_attributes(params = {}, options = {})
  req = build_request(:put_email_identity_configuration_set_attributes, params)
  req.send_request(options)
end

#put_email_identity_dkim_attributes(params = {}) ⇒ Struct

Used to enable or disable DKIM authentication for an email identity.

Examples:

Request syntax with placeholder values


resp = client.put_email_identity_dkim_attributes({
  email_identity: "Identity", # required
  signing_enabled: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :email_identity (required, String) —

    The email identity.

  • :signing_enabled (Boolean) —

    Sets the DKIM signing configuration for the identity.

    When you set this value ‘true`, then the messages that are sent from the identity are signed using DKIM. If you set this value to `false`, your messages are sent without DKIM signing.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4158
4159
4160
4161
 
# File 'lib/aws-sdk-sesv2/client.rb', line 4158

def put_email_identity_dkim_attributes(params = {}, options = {})
  req = build_request(:put_email_identity_dkim_attributes, params)
  req.send_request(options)
end

#put_email_identity_dkim_signing_attributes(params = {}) ⇒ Types::PutEmailIdentityDkimSigningAttributesResponse

Used to configure or change the DKIM authentication settings for an email domain identity. You can use this operation to do any of the following:

  • Update the signing attributes for an identity that uses Bring Your Own DKIM (BYODKIM).

  • Update the key length that should be used for Easy DKIM.

  • Change from using no DKIM authentication to using Easy DKIM.

  • Change from using no DKIM authentication to using BYODKIM.

  • Change from using Easy DKIM to using BYODKIM.

  • Change from using BYODKIM to using Easy DKIM.

Examples:

Request syntax with placeholder values


resp = client.put_email_identity_dkim_signing_attributes({
  email_identity: "Identity", # required
  signing_attributes_origin: "AWS_SES", # required, accepts AWS_SES, EXTERNAL
  signing_attributes: {
    domain_signing_selector: "Selector",
    domain_signing_private_key: "PrivateKey",
    next_signing_key_length: "RSA_1024_BIT", # accepts RSA_1024_BIT, RSA_2048_BIT
  },
})

Response structure


resp.dkim_status #=> String, one of "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE", "NOT_STARTED"
resp.dkim_tokens #=> Array
resp.dkim_tokens[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



4233
4234
4235
4236
 
# File 'lib/aws-sdk-sesv2/client.rb', line 4233

def put_email_identity_dkim_signing_attributes(params = {}, options = {})
  req = build_request(:put_email_identity_dkim_signing_attributes, params)
  req.send_request(options)
end

#put_email_identity_feedback_attributes(params = {}) ⇒ Struct

Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event.

If the value is ‘true`, you receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the `Return-Path` header of the original email.

You’re required to have a method of tracking bounces and complaints. If you haven’t set up another mechanism for receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).

Examples:

Request syntax with placeholder values


resp = client.put_email_identity_feedback_attributes({
  email_identity: "Identity", # required
  email_forwarding_enabled: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :email_identity (required, String) —

    The email identity.

  • :email_forwarding_enabled (Boolean) —

    Sets the feedback forwarding configuration for the identity.

    If the value is ‘true`, you receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the `Return-Path` header of the original email.

    You’re required to have a method of tracking bounces and complaints. If you haven’t set up another mechanism for receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4281
4282
4283
4284
 
# File 'lib/aws-sdk-sesv2/client.rb', line 4281

def put_email_identity_feedback_attributes(params = {}, options = {})
  req = build_request(:put_email_identity_feedback_attributes, params)
  req.send_request(options)
end

#put_email_identity_mail_from_attributes(params = {}) ⇒ Struct

Used to enable or disable the custom Mail-From domain configuration for an email identity.

Examples:

Request syntax with placeholder values


resp = client.put_email_identity_mail_from_attributes({
  email_identity: "Identity", # required
  mail_from_domain: "MailFromDomainName",
  behavior_on_mx_failure: "USE_DEFAULT_VALUE", # accepts USE_DEFAULT_VALUE, REJECT_MESSAGE
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :email_identity (required, String) —

    The verified email identity.

  • :mail_from_domain (String) —

    The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria:

    • It has to be a subdomain of the verified identity.

    • It can’t be used to receive email.

    • It can’t be used in a “From” address if the MAIL FROM domain is a destination for feedback forwarding emails.

  • :behavior_on_mx_failure (String) —

    The action to take if the required MX record isn’t found when you send an email. When you set this value to ‘UseDefaultValue`, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to `RejectMessage`, the Amazon SES API v2 returns a `MailFromDomainNotVerified` error, and doesn’t attempt to deliver the email.

    These behaviors are taken when the custom MAIL FROM domain configuration is in the ‘Pending`, `Failed`, and `TemporaryFailure` states.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4329
4330
4331
4332
 
# File 'lib/aws-sdk-sesv2/client.rb', line 4329

def put_email_identity_mail_from_attributes(params = {}, options = {})
  req = build_request(:put_email_identity_mail_from_attributes, params)
  req.send_request(options)
end

#put_suppressed_destination(params = {}) ⇒ Struct

Adds an email address to the suppression list for your account.

Examples:

Request syntax with placeholder values


resp = client.put_suppressed_destination({
  email_address: "EmailAddress", # required
  reason: "BOUNCE", # required, accepts BOUNCE, COMPLAINT
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :email_address (required, String) —

    The email address that should be added to the suppression list for your account.

  • :reason (required, String) —

    The factors that should cause the email address to be added to the suppression list for your account.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4357
4358
4359
4360
 
# File 'lib/aws-sdk-sesv2/client.rb', line 4357

def put_suppressed_destination(params = {}, options = {})
  req = build_request(:put_suppressed_destination, params)
  req.send_request(options)
end

#send_bulk_email(params = {}) ⇒ Types::SendBulkEmailResponse

Composes an email message to multiple destinations.

Examples:

Request syntax with placeholder values


resp = client.send_bulk_email({
  from_email_address: "EmailAddress",
  from_email_address_identity_arn: "AmazonResourceName",
  reply_to_addresses: ["EmailAddress"],
  feedback_forwarding_email_address: "EmailAddress",
  feedback_forwarding_email_address_identity_arn: "AmazonResourceName",
  default_email_tags: [
    {
      name: "MessageTagName", # required
      value: "MessageTagValue", # required
    },
  ],
  default_content: { # required
    template: {
      template_name: "EmailTemplateName",
      template_arn: "AmazonResourceName",
      template_data: "EmailTemplateData",
      headers: [
        {
          name: "MessageHeaderName", # required
          value: "MessageHeaderValue", # required
        },
      ],
    },
  },
  bulk_email_entries: [ # required
    {
      destination: { # required
        to_addresses: ["EmailAddress"],
        cc_addresses: ["EmailAddress"],
        bcc_addresses: ["EmailAddress"],
      },
      replacement_tags: [
        {
          name: "MessageTagName", # required
          value: "MessageTagValue", # required
        },
      ],
      replacement_email_content: {
        replacement_template: {
          replacement_template_data: "EmailTemplateData",
        },
      },
      replacement_headers: [
        {
          name: "MessageHeaderName", # required
          value: "MessageHeaderValue", # required
        },
      ],
    },
  ],
  configuration_set_name: "ConfigurationSetName",
})

Response structure


resp.bulk_email_entry_results #=> Array
resp.bulk_email_entry_results[0].status #=> String, one of "SUCCESS", "MESSAGE_REJECTED", "MAIL_FROM_DOMAIN_NOT_VERIFIED", "CONFIGURATION_SET_NOT_FOUND", "TEMPLATE_NOT_FOUND", "ACCOUNT_SUSPENDED", "ACCOUNT_THROTTLED", "ACCOUNT_DAILY_QUOTA_EXCEEDED", "INVALID_SENDING_POOL_NAME", "ACCOUNT_SENDING_PAUSED", "CONFIGURATION_SET_SENDING_PAUSED", "INVALID_PARAMETER", "TRANSIENT_FAILURE", "FAILED"
resp.bulk_email_entry_results[0].error #=> String
resp.bulk_email_entry_results[0].message_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :from_email_address (String) —

    The email address to use as the “From” address for the email. The address that you specify has to be verified.

  • :from_email_address_identity_arn (String) —

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ‘FromEmailAddress` parameter.

    For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use sender@example.com, then you would specify the ‘FromEmailAddressIdentityArn` to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the `FromEmailAddress` to be sender@example.com.

    For more information about sending authorization, see the [Amazon SES Developer Guide].

    [1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html

  • :reply_to_addresses (Array<String>) —

    The “Reply-to” email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

  • :feedback_forwarding_email_address (String) —

    The address that you want bounce and complaint notifications to be sent to.

  • :feedback_forwarding_email_address_identity_arn (String) —

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ‘FeedbackForwardingEmailAddress` parameter.

    For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ‘FeedbackForwardingEmailAddressIdentityArn` to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the `FeedbackForwardingEmailAddress` to be feedback@example.com.

    For more information about sending authorization, see the [Amazon SES Developer Guide].

    [1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html

  • :default_email_tags (Array<Types::MessageTag>) —

    A list of tags, in the form of name/value pairs, to apply to an email that you send using the ‘SendEmail` operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

  • :default_content (required, Types::BulkEmailContent) —

    An object that contains the body of the message. You can specify a template message.

  • :bulk_email_entries (required, Array<Types::BulkEmailEntry>) —

    The list of bulk email entry objects.

  • :configuration_set_name (String) —

    The name of the configuration set to use when sending the email.

Returns:

See Also:



4503
4504
4505
4506
 
# File 'lib/aws-sdk-sesv2/client.rb', line 4503

def send_bulk_email(params = {}, options = {})
  req = build_request(:send_bulk_email, params)
  req.send_request(options)
end

#send_custom_verification_email(params = {}) ⇒ Types::SendCustomVerificationEmailResponse

Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address.

To use this operation, you must first create a custom verification email template. For more information about creating and using custom verification email templates, see [Using custom verification email templates] in the *Amazon SES Developer Guide*.

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

[1]: docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom

Examples:

Request syntax with placeholder values


resp = client.send_custom_verification_email({
  email_address: "EmailAddress", # required
  template_name: "EmailTemplateName", # required
  configuration_set_name: "ConfigurationSetName",
})

Response structure


resp.message_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :email_address (required, String) —

    The email address to verify.

  • :template_name (required, String) —

    The name of the custom verification email template to use when sending the verification email.

  • :configuration_set_name (String) —

    Name of a configuration set to use when sending the verification email.

Returns:

See Also:



4555
4556
4557
4558
 
# File 'lib/aws-sdk-sesv2/client.rb', line 4555

def send_custom_verification_email(params = {}, options = {})
  req = build_request(:send_custom_verification_email, params)
  req.send_request(options)
end

#send_email(params = {}) ⇒ Types::SendEmailResponse

Sends an email message. You can use the Amazon SES API v2 to send the following types of messages:

  • Simple – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon SES assembles the message for you.

  • Raw – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message.

  • Templated – A message that contains personalization tags. When you send this type of email, Amazon SES API v2 automatically replaces the tags with values that you specify.

Examples:

Request syntax with placeholder values


resp = client.send_email({
  from_email_address: "EmailAddress",
  from_email_address_identity_arn: "AmazonResourceName",
  destination: {
    to_addresses: ["EmailAddress"],
    cc_addresses: ["EmailAddress"],
    bcc_addresses: ["EmailAddress"],
  },
  reply_to_addresses: ["EmailAddress"],
  feedback_forwarding_email_address: "EmailAddress",
  feedback_forwarding_email_address_identity_arn: "AmazonResourceName",
  content: { # required
    simple: {
      subject: { # required
        data: "MessageData", # required
        charset: "Charset",
      },
      body: { # required
        text: {
          data: "MessageData", # required
          charset: "Charset",
        },
        html: {
          data: "MessageData", # required
          charset: "Charset",
        },
      },
      headers: [
        {
          name: "MessageHeaderName", # required
          value: "MessageHeaderValue", # required
        },
      ],
    },
    raw: {
      data: "data", # required
    },
    template: {
      template_name: "EmailTemplateName",
      template_arn: "AmazonResourceName",
      template_data: "EmailTemplateData",
      headers: [
        {
          name: "MessageHeaderName", # required
          value: "MessageHeaderValue", # required
        },
      ],
    },
  },
  email_tags: [
    {
      name: "MessageTagName", # required
      value: "MessageTagValue", # required
    },
  ],
  configuration_set_name: "ConfigurationSetName",
  list_management_options: {
    contact_list_name: "ContactListName", # required
    topic_name: "TopicName",
  },
})

Response structure


resp.message_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :from_email_address (String) —

    The email address to use as the “From” address for the email. The address that you specify has to be verified.

  • :from_email_address_identity_arn (String) —

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ‘FromEmailAddress` parameter.

    For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use sender@example.com, then you would specify the ‘FromEmailAddressIdentityArn` to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the `FromEmailAddress` to be sender@example.com.

    For more information about sending authorization, see the [Amazon SES Developer Guide].

    For Raw emails, the ‘FromEmailAddressIdentityArn` value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.

    [1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html

  • :destination (Types::Destination) —

    An object that contains the recipients of the email message.

  • :reply_to_addresses (Array<String>) —

    The “Reply-to” email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

  • :feedback_forwarding_email_address (String) —

    The address that you want bounce and complaint notifications to be sent to.

  • :feedback_forwarding_email_address_identity_arn (String) —

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ‘FeedbackForwardingEmailAddress` parameter.

    For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ‘FeedbackForwardingEmailAddressIdentityArn` to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the `FeedbackForwardingEmailAddress` to be feedback@example.com.

    For more information about sending authorization, see the [Amazon SES Developer Guide].

    [1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html

  • :content (required, Types::EmailContent) —

    An object that contains the body of the message. You can send either a Simple message, Raw message, or a Templated message.

  • :email_tags (Array<Types::MessageTag>) —

    A list of tags, in the form of name/value pairs, to apply to an email that you send using the ‘SendEmail` operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

  • :configuration_set_name (String) —

    The name of the configuration set to use when sending the email.

  • :list_management_options (Types::ListManagementOptions) —

    An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.

Returns:

See Also:



4729
4730
4731
4732
 
# File 'lib/aws-sdk-sesv2/client.rb', line 4729

def send_email(params = {}, options = {})
  req = build_request(:send_email, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Add one or more tags (keys and values) to a specified resource. A tag is a label that you optionally define and associate with a resource. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.

Each tag consists of a required *tag key* and an associated *tag value*, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AmazonResourceName", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource that you want to add one or more tags to.

  • :tags (required, Array<Types::Tag>) —

    A list of the tags that you want to add to the resource. A tag consists of a required tag key (‘Key`) and an associated tag value (`Value`). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4773
4774
4775
4776
 
# File 'lib/aws-sdk-sesv2/client.rb', line 4773

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#test_render_email_template(params = {}) ⇒ Types::TestRenderEmailTemplateResponse

Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.

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

Examples:

Request syntax with placeholder values


resp = client.test_render_email_template({
  template_name: "EmailTemplateName", # required
  template_data: "EmailTemplateData", # required
})

Response structure


resp.rendered_template #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template_name (required, String) —

    The name of the template.

  • :template_data (required, String) —

    A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Returns:

See Also:



4810
4811
4812
4813
 
# File 'lib/aws-sdk-sesv2/client.rb', line 4810

def test_render_email_template(params = {}, options = {})
  req = build_request(:test_render_email_template, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Remove one or more tags (keys and values) from a specified resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "AmazonResourceName", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource that you want to remove one or more tags from.

  • :tag_keys (required, Array<String>) —

    The tags (tag keys) that you want to remove from the resource. When you specify a tag key, the action removes both that key and its associated tag value.

    To remove more than one tag from the resource, append the ‘TagKeys` parameter and argument for each additional tag to remove, separated by an ampersand. For example: `/v2/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2`

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4844
4845
4846
4847
 
# File 'lib/aws-sdk-sesv2/client.rb', line 4844

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_configuration_set_event_destination(params = {}) ⇒ Struct

Update the configuration of an event destination for a configuration set.

Events include message sends, deliveries, opens, clicks, bounces, and complaints. *Event destinations* are places that you can send information about these events to. For example, you can send event data to Amazon EventBridge and associate a rule to send the event to the specified target.

Examples:

Request syntax with placeholder values


resp = client.update_configuration_set_event_destination({
  configuration_set_name: "ConfigurationSetName", # required
  event_destination_name: "EventDestinationName", # required
  event_destination: { # required
    enabled: false,
    matching_event_types: ["SEND"], # accepts SEND, REJECT, BOUNCE, COMPLAINT, DELIVERY, OPEN, CLICK, RENDERING_FAILURE, DELIVERY_DELAY, SUBSCRIPTION
    kinesis_firehose_destination: {
      iam_role_arn: "AmazonResourceName", # required
      delivery_stream_arn: "AmazonResourceName", # required
    },
    cloud_watch_destination: {
      dimension_configurations: [ # required
        {
          dimension_name: "DimensionName", # required
          dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG
          default_dimension_value: "DefaultDimensionValue", # required
        },
      ],
    },
    sns_destination: {
      topic_arn: "AmazonResourceName", # required
    },
    event_bridge_destination: {
      event_bus_arn: "AmazonResourceName", # required
    },
    pinpoint_destination: {
      application_arn: "AmazonResourceName",
    },
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_set_name (required, String) —

    The name of the configuration set that contains the event destination to modify.

  • :event_destination_name (required, String) —

    The name of the event destination.

  • :event_destination (required, Types::EventDestinationDefinition) —

    An object that defines the event destination.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4907
4908
4909
4910
 
# File 'lib/aws-sdk-sesv2/client.rb', line 4907

def update_configuration_set_event_destination(params = {}, options = {})
  req = build_request(:update_configuration_set_event_destination, params)
  req.send_request(options)
end

#update_contact(params = {}) ⇒ Struct

Updates a contact’s preferences for a list.

<note markdown=“1”> You must specify all existing topic preferences in the ‘TopicPreferences` object, not just the ones that need updating; otherwise, all your existing preferences will be removed.

</note>

Examples:

Request syntax with placeholder values


resp = client.update_contact({
  contact_list_name: "ContactListName", # required
  email_address: "EmailAddress", # required
  topic_preferences: [
    {
      topic_name: "TopicName", # required
      subscription_status: "OPT_IN", # required, accepts OPT_IN, OPT_OUT
    },
  ],
  unsubscribe_all: false,
  attributes_data: "AttributesData",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :contact_list_name (required, String) —

    The name of the contact list.

  • :email_address (required, String) —

    The contact’s email address.

  • :topic_preferences (Array<Types::TopicPreference>) —

    The contact’s preference for being opted-in to or opted-out of a topic.

  • :unsubscribe_all (Boolean) —

    A boolean value status noting if the contact is unsubscribed from all contact list topics.

  • :attributes_data (String) —

    The attribute data attached to a contact.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4958
4959
4960
4961
 
# File 'lib/aws-sdk-sesv2/client.rb', line 4958

def update_contact(params = {}, options = {})
  req = build_request(:update_contact, params)
  req.send_request(options)
end

#update_contact_list(params = {}) ⇒ Struct

Updates contact list metadata. This operation does a complete replacement.

Examples:

Request syntax with placeholder values


resp = client.update_contact_list({
  contact_list_name: "ContactListName", # required
  topics: [
    {
      topic_name: "TopicName", # required
      display_name: "DisplayName", # required
      description: "Description",
      default_subscription_status: "OPT_IN", # required, accepts OPT_IN, OPT_OUT
    },
  ],
  description: "Description",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :contact_list_name (required, String) —

    The name of the contact list.

  • :topics (Array<Types::Topic>) —

    An interest group, theme, or label within a list. A contact list can have multiple topics.

  • :description (String) —

    A description of what the contact list is about.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4997
4998
4999
5000
 
# File 'lib/aws-sdk-sesv2/client.rb', line 4997

def update_contact_list(params = {}, options = {})
  req = build_request(:update_contact_list, params)
  req.send_request(options)
end

#update_custom_verification_email_template(params = {}) ⇒ Struct

Updates an existing custom verification email template.

For more information about custom verification email templates, see

Using custom verification email templates][1

in the *Amazon SES

Developer Guide*.

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

[1]: docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom

Examples:

Request syntax with placeholder values


resp = client.update_custom_verification_email_template({
  template_name: "EmailTemplateName", # required
  from_email_address: "EmailAddress", # required
  template_subject: "EmailTemplateSubject", # required
  template_content: "TemplateContent", # required
  success_redirection_url: "SuccessRedirectionURL", # required
  failure_redirection_url: "FailureRedirectionURL", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template_name (required, String) —

    The name of the custom verification email template that you want to update.

  • :from_email_address (required, String) —

    The email address that the custom verification email is sent from.

  • :template_subject (required, String) —

    The subject line of the custom verification email.

  • :template_content (required, String) —

    The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see [Custom verification email frequently asked questions] in the *Amazon SES Developer Guide*.

    [1]: docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom-faq

  • :success_redirection_url (required, String) —

    The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

  • :failure_redirection_url (required, String) —

    The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5059
5060
5061
5062
 
# File 'lib/aws-sdk-sesv2/client.rb', line 5059

def update_custom_verification_email_template(params = {}, options = {})
  req = build_request(:update_custom_verification_email_template, params)
  req.send_request(options)
end

#update_email_identity_policy(params = {}) ⇒ Struct

Updates the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.

<note markdown=“1”> This API is for the identity owner only. If you have not verified the identity, this API will return an error.

</note>

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the [Amazon SES Developer Guide].

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

[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html

Examples:

Request syntax with placeholder values


resp = client.update_email_identity_policy({
  email_identity: "Identity", # required
  policy_name: "PolicyName", # required
  policy: "Policy", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :email_identity (required, String) —

    The email identity.

  • :policy_name (required, String) —

    The name of the policy.

    The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.

  • :policy (required, String) —

    The text of the policy in JSON format. The policy cannot exceed 4 KB.

    For information about the syntax of sending authorization policies, see the [Amazon SES Developer Guide].

    [1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5116
5117
5118
5119
 
# File 'lib/aws-sdk-sesv2/client.rb', line 5116

def update_email_identity_policy(params = {}, options = {})
  req = build_request(:update_email_identity_policy, params)
  req.send_request(options)
end

#update_email_template(params = {}) ⇒ Struct

Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the [Amazon SES Developer Guide].

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

[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html

Examples:

Request syntax with placeholder values


resp = client.update_email_template({
  template_name: "EmailTemplateName", # required
  template_content: { # required
    subject: "EmailTemplateSubject",
    text: "EmailTemplateText",
    html: "EmailTemplateHtml",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template_name (required, String) —

    The name of the template.

  • :template_content (required, Types::EmailTemplateContent) —

    The content of the email template, composed of a subject line, an HTML part, and a text-only part.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5156
5157
5158
5159
 
# File 'lib/aws-sdk-sesv2/client.rb', line 5156

def update_email_template(params = {}, options = {})
  req = build_request(:update_email_template, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


5185
5186
5187
 
# File 'lib/aws-sdk-sesv2/client.rb', line 5185

def waiter_names
  []
end