Class: Aws::MailManager::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb

Overview

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

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

For details on configuring region and credentials see the developer guide.

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

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 used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or 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[:credentials]

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

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.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['AWS_EC2_METADATA_DISABLED'] 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:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :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.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :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. Takes effect only when disable_clock_skew_correction is not set.

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

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

  • :disable_clock_skew_correction (Boolean) —

    Used only in standard and adaptive retry modes. When true, the SDK does not apply a clock skew correction, does not update its stored skew from responses, and does not retry clock skew errors. Clock skew correction is enabled by default.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :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_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :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.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :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 https://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 the 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 - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

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

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

  • :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) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or 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::MailManager::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::MailManager::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 'http://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.



485
486
487
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 485

def initialize(*args)
  super
end

Instance Method Details

#create_addon_instance(params = {}) ⇒ Types::CreateAddonInstanceResponse

Creates an Add On instance for the subscription indicated in the request. The resulting Amazon Resource Name (ARN) can be used in a conditional statement for a rule set or traffic policy.

Examples:

Request syntax with placeholder values


resp = client.create_addon_instance({
  client_token: "IdempotencyToken",
  addon_subscription_id: "AddonSubscriptionId", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.addon_instance_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique token that Amazon SES uses to recognize subsequent retries of the same request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :addon_subscription_id (required, String) —

    The unique ID of a previously created subscription that an Add On instance is created for. You can only have one instance per subscription.

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

    The tags used to organize, track, or control access for the resource. For example, { "tags": "key2":"value2" }.

Returns:

See Also:



537
538
539
540
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 537

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

#create_addon_subscription(params = {}) ⇒ Types::CreateAddonSubscriptionResponse

Creates a subscription for an Add On representing the acceptance of its terms of use and additional pricing. The subscription can then be used to create an instance for use in rule sets or traffic policies.

Examples:

Request syntax with placeholder values


resp = client.create_addon_subscription({
  client_token: "IdempotencyToken",
  addon_name: "AddonName", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.addon_subscription_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique token that Amazon SES uses to recognize subsequent retries of the same request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :addon_name (required, String) —

    The name of the Add On to subscribe to. You can only have one subscription for each Add On name.

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

    The tags used to organize, track, or control access for the resource. For example, { "tags": "key2":"value2" }.

Returns:

See Also:



587
588
589
590
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 587

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

#create_address_list(params = {}) ⇒ Types::CreateAddressListResponse

Creates a new address list.

Examples:

Request syntax with placeholder values


resp = client.create_address_list({
  client_token: "IdempotencyToken",
  address_list_name: "AddressListName", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.address_list_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique token that Amazon SES uses to recognize subsequent retries of the same request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :address_list_name (required, String) —

    A user-friendly name for the address list.

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

    The tags used to organize, track, or control access for the resource. For example, { "tags": "key2":"value2" }.

Returns:

See Also:



634
635
636
637
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 634

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

#create_address_list_import_job(params = {}) ⇒ Types::CreateAddressListImportJobResponse

Creates an import job for an address list.

Examples:

Request syntax with placeholder values


resp = client.create_address_list_import_job({
  client_token: "IdempotencyToken",
  address_list_id: "AddressListId", # required
  name: "JobName", # required
  import_data_format: { # required
    import_data_type: "CSV", # required, accepts CSV, JSON
  },
})

Response structure


resp.job_id #=> String
resp.pre_signed_url #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique token that Amazon SES uses to recognize subsequent retries of the same request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :address_list_id (required, String) —

    The unique identifier of the address list for importing addresses to.

  • :name (required, String) —

    A user-friendly name for the import job.

  • :import_data_format (required, Types::ImportDataFormat) —

    The format of the input for an import job.

Returns:

See Also:



682
683
684
685
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 682

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

#create_archive(params = {}) ⇒ Types::CreateArchiveResponse

Creates a new email archive resource for storing and retaining emails.

Examples:

Request syntax with placeholder values


resp = client.create_archive({
  client_token: "IdempotencyToken",
  archive_name: "ArchiveNameString", # required
  retention: {
    retention_period: "THREE_MONTHS", # accepts THREE_MONTHS, SIX_MONTHS, NINE_MONTHS, ONE_YEAR, EIGHTEEN_MONTHS, TWO_YEARS, THIRTY_MONTHS, THREE_YEARS, FOUR_YEARS, FIVE_YEARS, SIX_YEARS, SEVEN_YEARS, EIGHT_YEARS, NINE_YEARS, TEN_YEARS, PERMANENT
  },
  kms_key_arn: "KmsKeyArn",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.archive_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique token Amazon SES uses to recognize retries of this request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :archive_name (required, String) —

    A unique name for the new archive.

  • :retention (Types::ArchiveRetention) —

    The period for retaining emails in the archive before automatic deletion.

  • :kms_key_arn (String) —

    The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.

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

    The tags used to organize, track, or control access for the resource. For example, { "tags": "key2":"value2" }.

Returns:

See Also:



740
741
742
743
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 740

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

#create_ingress_point(params = {}) ⇒ Types::CreateIngressPointResponse

Provision a new ingress endpoint resource.

Examples:

Example: Create Open IngressPoint


resp = client.create_ingress_point({
  ingress_point_name: "ingressPointName", 
  rule_set_id: "rs-12345", 
  tags: [
    {
      key: "key", 
      value: "value", 
    }, 
  ], 
  traffic_policy_id: "tp-12345", 
  type: "OPEN", 
})

resp.to_h outputs the following:
{
  ingress_point_id: "inp-12345", 
}

Example: Create Auth IngressPoint with Password


resp = client.create_ingress_point({
  ingress_point_configuration: {
    smtp_password: "smtpPassword", 
  }, 
  ingress_point_name: "ingressPointName", 
  rule_set_id: "rs-12345", 
  tags: [
    {
      key: "key", 
      value: "value", 
    }, 
  ], 
  traffic_policy_id: "tp-12345", 
  type: "AUTH", 
})

resp.to_h outputs the following:
{
  ingress_point_id: "inp-12345", 
}

Example: Create Auth IngressPoint with SecretsManager Secret


resp = client.create_ingress_point({
  ingress_point_configuration: {
    secret_arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:abcde", 
  }, 
  ingress_point_name: "ingressPointName", 
  rule_set_id: "rs-12345", 
  tags: [
    {
      key: "key", 
      value: "value", 
    }, 
  ], 
  traffic_policy_id: "tp-12345", 
  type: "AUTH", 
})

resp.to_h outputs the following:
{
  ingress_point_id: "inp-12345", 
}

Request syntax with placeholder values


resp = client.create_ingress_point({
  client_token: "IdempotencyToken",
  ingress_point_name: "IngressPointName", # required
  type: "OPEN", # required, accepts OPEN, AUTH, MTLS
  rule_set_id: "RuleSetId", # required
  traffic_policy_id: "TrafficPolicyId", # required
  ingress_point_configuration: {
    smtp_password: "SmtpPassword",
    secret_arn: "SecretArn",
    tls_auth_configuration: {
      trust_store: {
        ca_content: "CAContent", # required
        crl_content: "CrlContent",
        kms_key_arn: "KmsKeyArn",
      },
    },
  },
  network_configuration: {
    public_network_configuration: {
      ip_type: "IPV4", # required, accepts IPV4, DUAL_STACK
    },
    private_network_configuration: {
      vpc_endpoint_id: "VpcEndpointId", # required
    },
  },
  tls_policy: "REQUIRED", # accepts REQUIRED, OPTIONAL, FIPS
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.ingress_point_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique token that Amazon SES uses to recognize subsequent retries of the same request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :ingress_point_name (required, String) —

    A user friendly name for an ingress endpoint resource.

  • :type (required, String) —

    The type of the ingress endpoint to create.

  • :rule_set_id (required, String) —

    The identifier of an existing rule set that you attach to an ingress endpoint resource.

  • :traffic_policy_id (required, String) —

    The identifier of an existing traffic policy that you attach to an ingress endpoint resource.

  • :ingress_point_configuration (Types::IngressPointConfiguration) —

    If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.

  • :network_configuration (Types::NetworkConfiguration) —

    Specifies the network configuration for the ingress point. This allows you to create an IPv4-only, Dual-Stack, or PrivateLink type of ingress point. If not specified, the default network type is IPv4-only.

  • :tls_policy (String) —

    The Transport Layer Security (TLS) policy for the ingress point. The FIPS value is only valid in US and Canada regions.

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

    The tags used to organize, track, or control access for the resource. For example, { "tags": "key2":"value2" }.

Returns:

See Also:



901
902
903
904
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 901

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

#create_relay(params = {}) ⇒ Types::CreateRelayResponse

Creates a relay resource which can be used in rules to relay incoming emails to defined relay destinations.

Examples:

Request syntax with placeholder values


resp = client.create_relay({
  client_token: "IdempotencyToken",
  relay_name: "RelayName", # required
  server_name: "RelayServerName", # required
  server_port: 1, # required
  authentication: { # required
    secret_arn: "SecretArn",
    no_authentication: {
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.relay_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique token that Amazon SES uses to recognize subsequent retries of the same request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :relay_name (required, String) —

    The unique name of the relay resource.

  • :server_name (required, String) —

    The destination relay server address.

  • :server_port (required, Integer) —

    The destination relay server port.

  • :authentication (required, Types::RelayAuthentication) —

    Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.

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

    The tags used to organize, track, or control access for the resource. For example, { "tags": "key2":"value2" }.

Returns:

See Also:



966
967
968
969
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 966

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

#create_rule_set(params = {}) ⇒ Types::CreateRuleSetResponse

Provision a new rule set.

Examples:

Request syntax with placeholder values


resp = client.create_rule_set({
  client_token: "IdempotencyToken",
  rule_set_name: "RuleSetName", # required
  rules: [ # required
    {
      name: "RuleName",
      conditions: [
        {
          boolean_expression: {
            evaluate: { # required
              attribute: "READ_RECEIPT_REQUESTED", # accepts READ_RECEIPT_REQUESTED, TLS, TLS_WRAPPED
              analysis: {
                analyzer: "AnalyzerArn", # required
                result_field: "ResultField", # required
              },
              is_in_address_list: {
                attribute: "RECIPIENT", # required, accepts RECIPIENT, MAIL_FROM, SENDER, FROM, TO, CC
                address_lists: ["AddressListArn"], # required
              },
            },
            operator: "IS_TRUE", # required, accepts IS_TRUE, IS_FALSE
          },
          string_expression: {
            evaluate: { # required
              attribute: "MAIL_FROM", # accepts MAIL_FROM, HELO, RECIPIENT, SENDER, FROM, SUBJECT, TO, CC
              mime_header_attribute: "MimeHeaderAttribute",
              analysis: {
                analyzer: "AnalyzerArn", # required
                result_field: "ResultField", # required
              },
              client_certificate_attribute: "CN", # accepts CN, SAN_RFC822_NAME, SAN_DNS_NAME, SAN_DIRECTORY_NAME, SAN_UNIFORM_RESOURCE_IDENTIFIER, SAN_IP_ADDRESS, SAN_REGISTERED_ID, SERIAL_NUMBER
            },
            operator: "EQUALS", # required, accepts EQUALS, NOT_EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS
            values: ["RuleStringValue"], # required
          },
          number_expression: {
            evaluate: { # required
              attribute: "MESSAGE_SIZE", # accepts MESSAGE_SIZE
            },
            operator: "EQUALS", # required, accepts EQUALS, NOT_EQUALS, LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUAL, GREATER_THAN_OR_EQUAL
            value: 1.0, # required
          },
          ip_expression: {
            evaluate: { # required
              attribute: "SOURCE_IP", # accepts SOURCE_IP
            },
            operator: "CIDR_MATCHES", # required, accepts CIDR_MATCHES, NOT_CIDR_MATCHES
            values: ["RuleIpStringValue"], # required
          },
          verdict_expression: {
            evaluate: { # required
              attribute: "SPF", # accepts SPF, DKIM
              analysis: {
                analyzer: "AnalyzerArn", # required
                result_field: "ResultField", # required
              },
            },
            operator: "EQUALS", # required, accepts EQUALS, NOT_EQUALS
            values: ["PASS"], # required, accepts PASS, FAIL, GRAY, PROCESSING_FAILED
          },
          dmarc_expression: {
            operator: "EQUALS", # required, accepts EQUALS, NOT_EQUALS
            values: ["NONE"], # required, accepts NONE, QUARANTINE, REJECT
          },
        },
      ],
      unless: [
        {
          boolean_expression: {
            evaluate: { # required
              attribute: "READ_RECEIPT_REQUESTED", # accepts READ_RECEIPT_REQUESTED, TLS, TLS_WRAPPED
              analysis: {
                analyzer: "AnalyzerArn", # required
                result_field: "ResultField", # required
              },
              is_in_address_list: {
                attribute: "RECIPIENT", # required, accepts RECIPIENT, MAIL_FROM, SENDER, FROM, TO, CC
                address_lists: ["AddressListArn"], # required
              },
            },
            operator: "IS_TRUE", # required, accepts IS_TRUE, IS_FALSE
          },
          string_expression: {
            evaluate: { # required
              attribute: "MAIL_FROM", # accepts MAIL_FROM, HELO, RECIPIENT, SENDER, FROM, SUBJECT, TO, CC
              mime_header_attribute: "MimeHeaderAttribute",
              analysis: {
                analyzer: "AnalyzerArn", # required
                result_field: "ResultField", # required
              },
              client_certificate_attribute: "CN", # accepts CN, SAN_RFC822_NAME, SAN_DNS_NAME, SAN_DIRECTORY_NAME, SAN_UNIFORM_RESOURCE_IDENTIFIER, SAN_IP_ADDRESS, SAN_REGISTERED_ID, SERIAL_NUMBER
            },
            operator: "EQUALS", # required, accepts EQUALS, NOT_EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS
            values: ["RuleStringValue"], # required
          },
          number_expression: {
            evaluate: { # required
              attribute: "MESSAGE_SIZE", # accepts MESSAGE_SIZE
            },
            operator: "EQUALS", # required, accepts EQUALS, NOT_EQUALS, LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUAL, GREATER_THAN_OR_EQUAL
            value: 1.0, # required
          },
          ip_expression: {
            evaluate: { # required
              attribute: "SOURCE_IP", # accepts SOURCE_IP
            },
            operator: "CIDR_MATCHES", # required, accepts CIDR_MATCHES, NOT_CIDR_MATCHES
            values: ["RuleIpStringValue"], # required
          },
          verdict_expression: {
            evaluate: { # required
              attribute: "SPF", # accepts SPF, DKIM
              analysis: {
                analyzer: "AnalyzerArn", # required
                result_field: "ResultField", # required
              },
            },
            operator: "EQUALS", # required, accepts EQUALS, NOT_EQUALS
            values: ["PASS"], # required, accepts PASS, FAIL, GRAY, PROCESSING_FAILED
          },
          dmarc_expression: {
            operator: "EQUALS", # required, accepts EQUALS, NOT_EQUALS
            values: ["NONE"], # required, accepts NONE, QUARANTINE, REJECT
          },
        },
      ],
      actions: [ # required
        {
          drop: {
          },
          relay: {
            action_failure_policy: "CONTINUE", # accepts CONTINUE, DROP
            relay: "IdOrArn", # required
            mail_from: "REPLACE", # accepts REPLACE, PRESERVE
          },
          archive: {
            action_failure_policy: "CONTINUE", # accepts CONTINUE, DROP
            target_archive: "NameOrArn", # required
          },
          write_to_s3: {
            action_failure_policy: "CONTINUE", # accepts CONTINUE, DROP
            role_arn: "IamRoleArn", # required
            s3_bucket: "S3Bucket", # required
            s3_prefix: "S3Prefix",
            s3_sse_kms_key_id: "KmsKeyId",
          },
          send: {
            action_failure_policy: "CONTINUE", # accepts CONTINUE, DROP
            role_arn: "IamRoleArn", # required
          },
          add_header: {
            header_name: "HeaderName", # required
            header_value: "HeaderValue", # required
          },
          replace_recipient: {
            replace_with: ["EmailAddress"],
          },
          deliver_to_mailbox: {
            action_failure_policy: "CONTINUE", # accepts CONTINUE, DROP
            mailbox_arn: "NameOrArn", # required
            role_arn: "IamRoleArn", # required
          },
          deliver_to_q_business: {
            action_failure_policy: "CONTINUE", # accepts CONTINUE, DROP
            application_id: "QBusinessApplicationId", # required
            index_id: "QBusinessIndexId", # required
            role_arn: "IamRoleArn", # required
          },
          publish_to_sns: {
            action_failure_policy: "CONTINUE", # accepts CONTINUE, DROP
            topic_arn: "SnsTopicArn", # required
            role_arn: "IamRoleArn", # required
            encoding: "UTF-8", # accepts UTF-8, BASE64
            payload_type: "HEADERS", # accepts HEADERS, CONTENT
          },
          bounce: {
            action_failure_policy: "CONTINUE", # accepts CONTINUE, DROP
            role_arn: "IamRoleArn", # required
            sender: "EmailAddress", # required
            status_code: "StatusCode", # required
            smtp_reply_code: "SmtpReplyCode", # required
            diagnostic_message: "DiagnosticMessage", # required
            message: "BounceMessage",
          },
          invoke_lambda: {
            action_failure_policy: "CONTINUE", # accepts CONTINUE, DROP
            function_arn: "LambdaFunctionArn", # required
            invocation_type: "EVENT", # required, accepts EVENT, REQUEST_RESPONSE
            role_arn: "IamRoleArn", # required
            retry_time_minutes: 1,
          },
        },
      ],
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.rule_set_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique token that Amazon SES uses to recognize subsequent retries of the same request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :rule_set_name (required, String) —

    A user-friendly name for the rule set.

  • :rules (required, Array<Types::Rule>) —

    Conditional rules that are evaluated for determining actions on email.

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

    The tags used to organize, track, or control access for the resource. For example, { "tags": "key2":"value2" }.

Returns:

See Also:



1208
1209
1210
1211
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 1208

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

#create_traffic_policy(params = {}) ⇒ Types::CreateTrafficPolicyResponse

Provision a new traffic policy resource.

Examples:

Example: Create TrafficPolicy


resp = client.create_traffic_policy({
  default_action: "DENY", 
  policy_statements: [
    {
      action: "ALLOW", 
      conditions: [
        {
          ip_expression: {
            evaluate: {
              attribute: "SENDER_IP", 
            }, 
            operator: "CIDR_MATCHES", 
            values: [
              "0.0.0.0/12", 
            ], 
          }, 
        }, 
      ], 
    }, 
  ], 
  traffic_policy_name: "trafficPolicyName", 
})

resp.to_h outputs the following:
{
  traffic_policy_id: "tp-13245", 
}

Request syntax with placeholder values


resp = client.create_traffic_policy({
  client_token: "IdempotencyToken",
  traffic_policy_name: "TrafficPolicyName", # required
  policy_statements: [ # required
    {
      conditions: [ # required
        {
          string_expression: {
            evaluate: { # required
              attribute: "RECIPIENT", # accepts RECIPIENT
              analysis: {
                analyzer: "AnalyzerArn", # required
                result_field: "ResultField", # required
              },
            },
            operator: "EQUALS", # required, accepts EQUALS, NOT_EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS
            values: ["String"], # required
          },
          ip_expression: {
            evaluate: { # required
              attribute: "SENDER_IP", # accepts SENDER_IP
            },
            operator: "CIDR_MATCHES", # required, accepts CIDR_MATCHES, NOT_CIDR_MATCHES
            values: ["Ipv4Cidr"], # required
          },
          ipv_6_expression: {
            evaluate: { # required
              attribute: "SENDER_IPV6", # accepts SENDER_IPV6
            },
            operator: "CIDR_MATCHES", # required, accepts CIDR_MATCHES, NOT_CIDR_MATCHES
            values: ["Ipv6Cidr"], # required
          },
          tls_expression: {
            evaluate: { # required
              attribute: "TLS_PROTOCOL", # accepts TLS_PROTOCOL
            },
            operator: "MINIMUM_TLS_VERSION", # required, accepts MINIMUM_TLS_VERSION, IS
            value: "TLS1_2", # required, accepts TLS1_2, TLS1_3
          },
          boolean_expression: {
            evaluate: { # required
              analysis: {
                analyzer: "AnalyzerArn", # required
                result_field: "ResultField", # required
              },
              is_in_address_list: {
                attribute: "RECIPIENT", # required, accepts RECIPIENT
                address_lists: ["AddressListArn"], # required
              },
            },
            operator: "IS_TRUE", # required, accepts IS_TRUE, IS_FALSE
          },
        },
      ],
      action: "ALLOW", # required, accepts ALLOW, DENY
    },
  ],
  default_action: "ALLOW", # required, accepts ALLOW, DENY
  max_message_size_bytes: 1,
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.traffic_policy_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique token that Amazon SES uses to recognize subsequent retries of the same request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :traffic_policy_name (required, String) —

    A user-friendly name for the traffic policy resource.

  • :policy_statements (required, Array<Types::PolicyStatement>) —

    Conditional statements for filtering email traffic.

  • :default_action (required, String) —

    Default action instructs the traffic policy to either Allow or Deny (block) messages that fall outside of (or not addressed by) the conditions of your policy statements

  • :max_message_size_bytes (Integer) —

    The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.

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

    The tags used to organize, track, or control access for the resource. For example, { "tags": "key2":"value2" }.

Returns:

See Also:



1354
1355
1356
1357
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 1354

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

#delete_addon_instance(params = {}) ⇒ Struct

Deletes an Add On instance.

Examples:

Request syntax with placeholder values


resp = client.delete_addon_instance({
  addon_instance_id: "AddonInstanceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :addon_instance_id (required, String) —

    The Add On instance ID to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1376
1377
1378
1379
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 1376

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

#delete_addon_subscription(params = {}) ⇒ Struct

Deletes an Add On subscription.

Examples:

Request syntax with placeholder values


resp = client.delete_addon_subscription({
  addon_subscription_id: "AddonSubscriptionId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :addon_subscription_id (required, String) —

    The Add On subscription ID to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1398
1399
1400
1401
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 1398

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

#delete_address_list(params = {}) ⇒ Struct

Deletes an address list.

Examples:

Request syntax with placeholder values


resp = client.delete_address_list({
  address_list_id: "AddressListId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :address_list_id (required, String) —

    The identifier of an existing address list resource to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1420
1421
1422
1423
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 1420

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

#delete_archive(params = {}) ⇒ Struct

Initiates deletion of an email archive. This changes the archive state to pending deletion. In this state, no new emails can be added, and existing archived emails become inaccessible (search, export, download). The archive and all of its contents will be permanently deleted 30 days after entering the pending deletion state, regardless of the configured retention period.

Examples:

Request syntax with placeholder values


resp = client.delete_archive({
  archive_id: "ArchiveIdString", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :archive_id (required, String) —

    The identifier of the archive to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1447
1448
1449
1450
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 1447

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

#delete_ingress_point(params = {}) ⇒ Struct

Delete an ingress endpoint resource.

Examples:

Example: Delete IngressPoint


resp = client.delete_ingress_point({
  ingress_point_id: "inp-12345", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.delete_ingress_point({
  ingress_point_id: "IngressPointId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :ingress_point_id (required, String) —

    The identifier of the ingress endpoint resource that you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1481
1482
1483
1484
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 1481

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

#delete_relay(params = {}) ⇒ Struct

Deletes an existing relay resource.

Examples:

Request syntax with placeholder values


resp = client.delete_relay({
  relay_id: "RelayId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :relay_id (required, String) —

    The unique relay identifier.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1503
1504
1505
1506
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 1503

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

#delete_rule_set(params = {}) ⇒ Struct

Delete a rule set.

Examples:

Request syntax with placeholder values


resp = client.delete_rule_set({
  rule_set_id: "RuleSetId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :rule_set_id (required, String) —

    The identifier of an existing rule set resource to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1525
1526
1527
1528
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 1525

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

#delete_traffic_policy(params = {}) ⇒ Struct

Delete a traffic policy resource.

Examples:

Example: Delete TrafficPolicy


resp = client.delete_traffic_policy({
  traffic_policy_id: "tp-12345", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.delete_traffic_policy({
  traffic_policy_id: "TrafficPolicyId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :traffic_policy_id (required, String) —

    The identifier of the traffic policy that you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1558
1559
1560
1561
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 1558

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

#deregister_member_from_address_list(params = {}) ⇒ Struct

Removes a member from an address list.

Examples:

Request syntax with placeholder values


resp = client.deregister_member_from_address_list({
  address_list_id: "AddressListId", # required
  address: "Address", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :address_list_id (required, String) —

    The unique identifier of the address list to remove the address from.

  • :address (required, String) —

    The address to be removed from the address list.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1584
1585
1586
1587
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 1584

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

#get_addon_instance(params = {}) ⇒ Types::GetAddonInstanceResponse

Gets detailed information about an Add On instance.

Examples:

Request syntax with placeholder values


resp = client.get_addon_instance({
  addon_instance_id: "AddonInstanceId", # required
})

Response structure


resp.addon_subscription_id #=> String
resp.addon_name #=> String
resp.addon_instance_arn #=> String
resp.created_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :addon_instance_id (required, String) —

    The Add On instance ID to retrieve information for.

Returns:

See Also:



1618
1619
1620
1621
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 1618

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

#get_addon_subscription(params = {}) ⇒ Types::GetAddonSubscriptionResponse

Gets detailed information about an Add On subscription.

Examples:

Request syntax with placeholder values


resp = client.get_addon_subscription({
  addon_subscription_id: "AddonSubscriptionId", # required
})

Response structure


resp.addon_name #=> String
resp.addon_subscription_arn #=> String
resp.created_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :addon_subscription_id (required, String) —

    The Add On subscription ID to retrieve information for.

Returns:

See Also:



1650
1651
1652
1653
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 1650

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

#get_address_list(params = {}) ⇒ Types::GetAddressListResponse

Fetch attributes of an address list.

Examples:

Request syntax with placeholder values


resp = client.get_address_list({
  address_list_id: "AddressListId", # required
})

Response structure


resp.address_list_id #=> String
resp.address_list_arn #=> String
resp.address_list_name #=> String
resp.created_timestamp #=> Time
resp.last_updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :address_list_id (required, String) —

    The identifier of an existing address list resource to be retrieved.

Returns:

See Also:



1686
1687
1688
1689
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 1686

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

#get_address_list_import_job(params = {}) ⇒ Types::GetAddressListImportJobResponse

Fetch attributes of an import job.

Examples:

Request syntax with placeholder values


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

Response structure


resp.job_id #=> String
resp.name #=> String
resp.status #=> String, one of "CREATED", "PROCESSING", "COMPLETED", "FAILED", "STOPPED"
resp.pre_signed_url #=> String
resp.imported_items_count #=> Integer
resp.failed_items_count #=> Integer
resp.import_data_format.import_data_type #=> String, one of "CSV", "JSON"
resp.address_list_id #=> String
resp.created_timestamp #=> Time
resp.start_timestamp #=> Time
resp.completed_timestamp #=> Time
resp.error #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The identifier of the import job that needs to be retrieved.

Returns:

See Also:



1736
1737
1738
1739
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 1736

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

#get_archive(params = {}) ⇒ Types::GetArchiveResponse

Retrieves the full details and current state of a specified email archive.

Examples:

Request syntax with placeholder values


resp = client.get_archive({
  archive_id: "ArchiveIdString", # required
})

Response structure


resp.archive_id #=> String
resp.archive_name #=> String
resp.archive_arn #=> String
resp.archive_state #=> String, one of "ACTIVE", "PENDING_DELETION"
resp.retention.retention_period #=> String, one of "THREE_MONTHS", "SIX_MONTHS", "NINE_MONTHS", "ONE_YEAR", "EIGHTEEN_MONTHS", "TWO_YEARS", "THIRTY_MONTHS", "THREE_YEARS", "FOUR_YEARS", "FIVE_YEARS", "SIX_YEARS", "SEVEN_YEARS", "EIGHT_YEARS", "NINE_YEARS", "TEN_YEARS", "PERMANENT"
resp.created_timestamp #=> Time
resp.last_updated_timestamp #=> Time
resp.kms_key_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :archive_id (required, String) —

    The identifier of the archive to retrieve.

Returns:

See Also:



1779
1780
1781
1782
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 1779

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

#get_archive_export(params = {}) ⇒ Types::GetArchiveExportResponse

Retrieves the details and current status of a specific email archive export job.

Examples:

Request syntax with placeholder values


resp = client.get_archive_export({
  export_id: "ExportId", # required
})

Response structure


resp.archive_id #=> String
resp.filters.include #=> Array
resp.filters.include[0].string_expression.evaluate.attribute #=> String, one of "TO", "FROM", "CC", "SUBJECT", "ENVELOPE_TO", "ENVELOPE_FROM"
resp.filters.include[0].string_expression.operator #=> String, one of "CONTAINS"
resp.filters.include[0].string_expression.values #=> Array
resp.filters.include[0].string_expression.values[0] #=> String
resp.filters.include[0].boolean_expression.evaluate.attribute #=> String, one of "HAS_ATTACHMENTS"
resp.filters.include[0].boolean_expression.operator #=> String, one of "IS_TRUE", "IS_FALSE"
resp.filters.unless #=> Array
resp.filters.unless[0].string_expression.evaluate.attribute #=> String, one of "TO", "FROM", "CC", "SUBJECT", "ENVELOPE_TO", "ENVELOPE_FROM"
resp.filters.unless[0].string_expression.operator #=> String, one of "CONTAINS"
resp.filters.unless[0].string_expression.values #=> Array
resp.filters.unless[0].string_expression.values[0] #=> String
resp.filters.unless[0].boolean_expression.evaluate.attribute #=> String, one of "HAS_ATTACHMENTS"
resp.filters.unless[0].boolean_expression.operator #=> String, one of "IS_TRUE", "IS_FALSE"
resp.from_timestamp #=> Time
resp.to_timestamp #=> Time
resp.max_results #=> Integer
resp.export_destination_configuration.s3.s3_location #=> String
resp.status.submission_timestamp #=> Time
resp.status.completion_timestamp #=> Time
resp.status.state #=> String, one of "QUEUED", "PREPROCESSING", "PROCESSING", "COMPLETED", "FAILED", "CANCELLED"
resp.status.error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :export_id (required, String) —

    The identifier of the export job to get details for.

Returns:

See Also:



1836
1837
1838
1839
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 1836

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

#get_archive_message(params = {}) ⇒ Types::GetArchiveMessageResponse

Returns a pre-signed URL that provides temporary download access to the specific email message stored in the archive.

Examples:

Request syntax with placeholder values


resp = client.get_archive_message({
  archived_message_id: "ArchivedMessageId", # required
})

Response structure


resp.message_download_link #=> String
resp.metadata.timestamp #=> Time
resp.metadata.ingress_point_id #=> String
resp.metadata.traffic_policy_id #=> String
resp.metadata.rule_set_id #=> String
resp.metadata.sender_hostname #=> String
resp.metadata.sender_ip_address #=> String
resp.metadata.tls_cipher_suite #=> String
resp.metadata.tls_protocol #=> String
resp.metadata.sending_method #=> String
resp.metadata.source_identity #=> String
resp.metadata.sending_pool #=> String
resp.metadata.configuration_set #=> String
resp.metadata.source_arn #=> String
resp.envelope.helo #=> String
resp.envelope.from #=> String
resp.envelope.to #=> Array
resp.envelope.to[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :archived_message_id (required, String) —

    The unique identifier of the archived email message.

Returns:

See Also:



1884
1885
1886
1887
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 1884

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

#get_archive_message_content(params = {}) ⇒ Types::GetArchiveMessageContentResponse

Returns the textual content of a specific email message stored in the archive. Attachments are not included.

Examples:

Request syntax with placeholder values


resp = client.get_archive_message_content({
  archived_message_id: "ArchivedMessageId", # required
})

Response structure


resp.body.text #=> String
resp.body.html #=> String
resp.body.message_malformed #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :archived_message_id (required, String) —

    The unique identifier of the archived email message.

Returns:

See Also:



1915
1916
1917
1918
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 1915

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

#get_archive_search(params = {}) ⇒ Types::GetArchiveSearchResponse

Retrieves the details and current status of a specific email archive search job.

Examples:

Request syntax with placeholder values


resp = client.get_archive_search({
  search_id: "SearchId", # required
})

Response structure


resp.archive_id #=> String
resp.filters.include #=> Array
resp.filters.include[0].string_expression.evaluate.attribute #=> String, one of "TO", "FROM", "CC", "SUBJECT", "ENVELOPE_TO", "ENVELOPE_FROM"
resp.filters.include[0].string_expression.operator #=> String, one of "CONTAINS"
resp.filters.include[0].string_expression.values #=> Array
resp.filters.include[0].string_expression.values[0] #=> String
resp.filters.include[0].boolean_expression.evaluate.attribute #=> String, one of "HAS_ATTACHMENTS"
resp.filters.include[0].boolean_expression.operator #=> String, one of "IS_TRUE", "IS_FALSE"
resp.filters.unless #=> Array
resp.filters.unless[0].string_expression.evaluate.attribute #=> String, one of "TO", "FROM", "CC", "SUBJECT", "ENVELOPE_TO", "ENVELOPE_FROM"
resp.filters.unless[0].string_expression.operator #=> String, one of "CONTAINS"
resp.filters.unless[0].string_expression.values #=> Array
resp.filters.unless[0].string_expression.values[0] #=> String
resp.filters.unless[0].boolean_expression.evaluate.attribute #=> String, one of "HAS_ATTACHMENTS"
resp.filters.unless[0].boolean_expression.operator #=> String, one of "IS_TRUE", "IS_FALSE"
resp.from_timestamp #=> Time
resp.to_timestamp #=> Time
resp.max_results #=> Integer
resp.status.submission_timestamp #=> Time
resp.status.completion_timestamp #=> Time
resp.status.state #=> String, one of "QUEUED", "RUNNING", "COMPLETED", "FAILED", "CANCELLED"
resp.status.error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :search_id (required, String) —

    The identifier of the search job to get details for.

Returns:

See Also:



1970
1971
1972
1973
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 1970

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

#get_archive_search_results(params = {}) ⇒ Types::GetArchiveSearchResultsResponse

Returns the results of a completed email archive search job.

Examples:

Request syntax with placeholder values


resp = client.get_archive_search_results({
  search_id: "SearchId", # required
})

Response structure


resp.rows #=> Array
resp.rows[0].archived_message_id #=> String
resp.rows[0].received_timestamp #=> Time
resp.rows[0].date #=> String
resp.rows[0].to #=> String
resp.rows[0].from #=> String
resp.rows[0].cc #=> String
resp.rows[0].subject #=> String
resp.rows[0].message_id #=> String
resp.rows[0].has_attachments #=> Boolean
resp.rows[0].received_headers #=> Array
resp.rows[0].received_headers[0] #=> String
resp.rows[0].in_reply_to #=> String
resp.rows[0].x_mailer #=> String
resp.rows[0].x_original_mailer #=> String
resp.rows[0].x_priority #=> String
resp.rows[0].ingress_point_id #=> String
resp.rows[0].sender_hostname #=> String
resp.rows[0].sender_ip_address #=> String
resp.rows[0].envelope.helo #=> String
resp.rows[0].envelope.from #=> String
resp.rows[0].envelope.to #=> Array
resp.rows[0].envelope.to[0] #=> String
resp.rows[0].source_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :search_id (required, String) —

    The identifier of the completed search job.

Returns:

See Also:



2021
2022
2023
2024
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 2021

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

#get_ingress_point(params = {}) ⇒ Types::GetIngressPointResponse

Fetch ingress endpoint resource attributes.

Examples:

Example: Get Open IngressPoint


resp = client.get_ingress_point({
  ingress_point_id: "inp-12345", 
})

resp.to_h outputs the following:
{
  a_record: "abcde123.prod.us-east-1.email-border.ses.aws.a2z.com", 
  ingress_point_arn: "arn:aws:ses:us-east-1:123456789012:mailmanager-ingress-point/inp-12345", 
  ingress_point_id: "inp-12345", 
  ingress_point_name: "ingressPointName", 
  status: "ACTIVE", 
  type: "OPEN", 
}

Example: Get Auth IngressPoint


resp = client.get_ingress_point({
  ingress_point_id: "inp-12345", 
})

resp.to_h outputs the following:
{
  a_record: "abcde123.prod.us-east-1.email-border.ses.aws.a2z.com", 
  ingress_point_arn: "arn:aws:ses:us-east-1:123456789012:mailmanager-ingress-point/inp-12345", 
  ingress_point_auth_configuration: {
    secret_arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:abcde", 
  }, 
  ingress_point_id: "inp-12345", 
  ingress_point_name: "ingressPointName", 
  status: "ACTIVE", 
  type: "AUTH", 
}

Request syntax with placeholder values


resp = client.get_ingress_point({
  ingress_point_id: "IngressPointId", # required
  include_trust_store_contents: "EXCLUDE", # accepts EXCLUDE, INCLUDE
})

Response structure


resp.ingress_point_id #=> String
resp.ingress_point_name #=> String
resp.ingress_point_arn #=> String
resp.status #=> String, one of "PROVISIONING", "DEPROVISIONING", "UPDATING", "ACTIVE", "CLOSED", "FAILED", "ASSOCIATED_VPC_ENDPOINT_DOES_NOT_EXIST"
resp.type #=> String, one of "OPEN", "AUTH", "MTLS"
resp.a_record #=> String
resp.rule_set_id #=> String
resp.traffic_policy_id #=> String
resp.ingress_point_auth_configuration.ingress_point_password_configuration.smtp_password_version #=> String
resp.ingress_point_auth_configuration.ingress_point_password_configuration.previous_smtp_password_version #=> String
resp.ingress_point_auth_configuration.ingress_point_password_configuration.previous_smtp_password_expiry_timestamp #=> Time
resp.ingress_point_auth_configuration.secret_arn #=> String
resp.ingress_point_auth_configuration.tls_auth_configuration.trust_store.ca_content #=> String
resp.ingress_point_auth_configuration.tls_auth_configuration.trust_store.crl_content #=> String
resp.ingress_point_auth_configuration.tls_auth_configuration.trust_store.kms_key_arn #=> String
resp.network_configuration.public_network_configuration.ip_type #=> String, one of "IPV4", "DUAL_STACK"
resp.network_configuration.private_network_configuration.vpc_endpoint_id #=> String
resp.tls_policy #=> String, one of "REQUIRED", "OPTIONAL", "FIPS"
resp.created_timestamp #=> Time
resp.last_updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :ingress_point_id (required, String) —

    The identifier of an ingress endpoint.

  • :include_trust_store_contents (String) —

    Whether to include the trust store contents in the response. Use INCLUDE to retrieve trust store certificate and CRL contents.

Returns:

See Also:



2121
2122
2123
2124
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 2121

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

#get_member_of_address_list(params = {}) ⇒ Types::GetMemberOfAddressListResponse

Fetch attributes of a member in an address list.

Examples:

Request syntax with placeholder values


resp = client.get_member_of_address_list({
  address_list_id: "AddressListId", # required
  address: "Address", # required
})

Response structure


resp.address #=> String
resp.created_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :address_list_id (required, String) —

    The unique identifier of the address list to retrieve the address from.

  • :address (required, String) —

    The address to be retrieved from the address list.

Returns:

See Also:



2156
2157
2158
2159
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 2156

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

#get_relay(params = {}) ⇒ Types::GetRelayResponse

Fetch the relay resource and it's attributes.

Examples:

Request syntax with placeholder values


resp = client.get_relay({
  relay_id: "RelayId", # required
})

Response structure


resp.relay_id #=> String
resp.relay_arn #=> String
resp.relay_name #=> String
resp.server_name #=> String
resp.server_port #=> Integer
resp.authentication.secret_arn #=> String
resp.created_timestamp #=> Time
resp.last_modified_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :relay_id (required, String) —

    A unique relay identifier.

Returns:

See Also:



2198
2199
2200
2201
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 2198

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

#get_rule_set(params = {}) ⇒ Types::GetRuleSetResponse

Fetch attributes of a rule set.

Examples:

Request syntax with placeholder values


resp = client.get_rule_set({
  rule_set_id: "RuleSetId", # required
})

Response structure


resp.rule_set_id #=> String
resp.rule_set_arn #=> String
resp.rule_set_name #=> String
resp.created_date #=> Time
resp.last_modification_date #=> Time
resp.rules #=> Array
resp.rules[0].name #=> String
resp.rules[0].conditions #=> Array
resp.rules[0].conditions[0].boolean_expression.evaluate.attribute #=> String, one of "READ_RECEIPT_REQUESTED", "TLS", "TLS_WRAPPED"
resp.rules[0].conditions[0].boolean_expression.evaluate.analysis.analyzer #=> String
resp.rules[0].conditions[0].boolean_expression.evaluate.analysis.result_field #=> String
resp.rules[0].conditions[0].boolean_expression.evaluate.is_in_address_list.attribute #=> String, one of "RECIPIENT", "MAIL_FROM", "SENDER", "FROM", "TO", "CC"
resp.rules[0].conditions[0].boolean_expression.evaluate.is_in_address_list.address_lists #=> Array
resp.rules[0].conditions[0].boolean_expression.evaluate.is_in_address_list.address_lists[0] #=> String
resp.rules[0].conditions[0].boolean_expression.operator #=> String, one of "IS_TRUE", "IS_FALSE"
resp.rules[0].conditions[0].string_expression.evaluate.attribute #=> String, one of "MAIL_FROM", "HELO", "RECIPIENT", "SENDER", "FROM", "SUBJECT", "TO", "CC"
resp.rules[0].conditions[0].string_expression.evaluate.mime_header_attribute #=> String
resp.rules[0].conditions[0].string_expression.evaluate.analysis.analyzer #=> String
resp.rules[0].conditions[0].string_expression.evaluate.analysis.result_field #=> String
resp.rules[0].conditions[0].string_expression.evaluate.client_certificate_attribute #=> String, one of "CN", "SAN_RFC822_NAME", "SAN_DNS_NAME", "SAN_DIRECTORY_NAME", "SAN_UNIFORM_RESOURCE_IDENTIFIER", "SAN_IP_ADDRESS", "SAN_REGISTERED_ID", "SERIAL_NUMBER"
resp.rules[0].conditions[0].string_expression.operator #=> String, one of "EQUALS", "NOT_EQUALS", "STARTS_WITH", "ENDS_WITH", "CONTAINS"
resp.rules[0].conditions[0].string_expression.values #=> Array
resp.rules[0].conditions[0].string_expression.values[0] #=> String
resp.rules[0].conditions[0].number_expression.evaluate.attribute #=> String, one of "MESSAGE_SIZE"
resp.rules[0].conditions[0].number_expression.operator #=> String, one of "EQUALS", "NOT_EQUALS", "LESS_THAN", "GREATER_THAN", "LESS_THAN_OR_EQUAL", "GREATER_THAN_OR_EQUAL"
resp.rules[0].conditions[0].number_expression.value #=> Float
resp.rules[0].conditions[0].ip_expression.evaluate.attribute #=> String, one of "SOURCE_IP"
resp.rules[0].conditions[0].ip_expression.operator #=> String, one of "CIDR_MATCHES", "NOT_CIDR_MATCHES"
resp.rules[0].conditions[0].ip_expression.values #=> Array
resp.rules[0].conditions[0].ip_expression.values[0] #=> String
resp.rules[0].conditions[0].verdict_expression.evaluate.attribute #=> String, one of "SPF", "DKIM"
resp.rules[0].conditions[0].verdict_expression.evaluate.analysis.analyzer #=> String
resp.rules[0].conditions[0].verdict_expression.evaluate.analysis.result_field #=> String
resp.rules[0].conditions[0].verdict_expression.operator #=> String, one of "EQUALS", "NOT_EQUALS"
resp.rules[0].conditions[0].verdict_expression.values #=> Array
resp.rules[0].conditions[0].verdict_expression.values[0] #=> String, one of "PASS", "FAIL", "GRAY", "PROCESSING_FAILED"
resp.rules[0].conditions[0].dmarc_expression.operator #=> String, one of "EQUALS", "NOT_EQUALS"
resp.rules[0].conditions[0].dmarc_expression.values #=> Array
resp.rules[0].conditions[0].dmarc_expression.values[0] #=> String, one of "NONE", "QUARANTINE", "REJECT"
resp.rules[0].unless #=> Array
resp.rules[0].unless[0].boolean_expression.evaluate.attribute #=> String, one of "READ_RECEIPT_REQUESTED", "TLS", "TLS_WRAPPED"
resp.rules[0].unless[0].boolean_expression.evaluate.analysis.analyzer #=> String
resp.rules[0].unless[0].boolean_expression.evaluate.analysis.result_field #=> String
resp.rules[0].unless[0].boolean_expression.evaluate.is_in_address_list.attribute #=> String, one of "RECIPIENT", "MAIL_FROM", "SENDER", "FROM", "TO", "CC"
resp.rules[0].unless[0].boolean_expression.evaluate.is_in_address_list.address_lists #=> Array
resp.rules[0].unless[0].boolean_expression.evaluate.is_in_address_list.address_lists[0] #=> String
resp.rules[0].unless[0].boolean_expression.operator #=> String, one of "IS_TRUE", "IS_FALSE"
resp.rules[0].unless[0].string_expression.evaluate.attribute #=> String, one of "MAIL_FROM", "HELO", "RECIPIENT", "SENDER", "FROM", "SUBJECT", "TO", "CC"
resp.rules[0].unless[0].string_expression.evaluate.mime_header_attribute #=> String
resp.rules[0].unless[0].string_expression.evaluate.analysis.analyzer #=> String
resp.rules[0].unless[0].string_expression.evaluate.analysis.result_field #=> String
resp.rules[0].unless[0].string_expression.evaluate.client_certificate_attribute #=> String, one of "CN", "SAN_RFC822_NAME", "SAN_DNS_NAME", "SAN_DIRECTORY_NAME", "SAN_UNIFORM_RESOURCE_IDENTIFIER", "SAN_IP_ADDRESS", "SAN_REGISTERED_ID", "SERIAL_NUMBER"
resp.rules[0].unless[0].string_expression.operator #=> String, one of "EQUALS", "NOT_EQUALS", "STARTS_WITH", "ENDS_WITH", "CONTAINS"
resp.rules[0].unless[0].string_expression.values #=> Array
resp.rules[0].unless[0].string_expression.values[0] #=> String
resp.rules[0].unless[0].number_expression.evaluate.attribute #=> String, one of "MESSAGE_SIZE"
resp.rules[0].unless[0].number_expression.operator #=> String, one of "EQUALS", "NOT_EQUALS", "LESS_THAN", "GREATER_THAN", "LESS_THAN_OR_EQUAL", "GREATER_THAN_OR_EQUAL"
resp.rules[0].unless[0].number_expression.value #=> Float
resp.rules[0].unless[0].ip_expression.evaluate.attribute #=> String, one of "SOURCE_IP"
resp.rules[0].unless[0].ip_expression.operator #=> String, one of "CIDR_MATCHES", "NOT_CIDR_MATCHES"
resp.rules[0].unless[0].ip_expression.values #=> Array
resp.rules[0].unless[0].ip_expression.values[0] #=> String
resp.rules[0].unless[0].verdict_expression.evaluate.attribute #=> String, one of "SPF", "DKIM"
resp.rules[0].unless[0].verdict_expression.evaluate.analysis.analyzer #=> String
resp.rules[0].unless[0].verdict_expression.evaluate.analysis.result_field #=> String
resp.rules[0].unless[0].verdict_expression.operator #=> String, one of "EQUALS", "NOT_EQUALS"
resp.rules[0].unless[0].verdict_expression.values #=> Array
resp.rules[0].unless[0].verdict_expression.values[0] #=> String, one of "PASS", "FAIL", "GRAY", "PROCESSING_FAILED"
resp.rules[0].unless[0].dmarc_expression.operator #=> String, one of "EQUALS", "NOT_EQUALS"
resp.rules[0].unless[0].dmarc_expression.values #=> Array
resp.rules[0].unless[0].dmarc_expression.values[0] #=> String, one of "NONE", "QUARANTINE", "REJECT"
resp.rules[0].actions #=> Array
resp.rules[0].actions[0].relay.action_failure_policy #=> String, one of "CONTINUE", "DROP"
resp.rules[0].actions[0].relay.relay #=> String
resp.rules[0].actions[0].relay.mail_from #=> String, one of "REPLACE", "PRESERVE"
resp.rules[0].actions[0].archive.action_failure_policy #=> String, one of "CONTINUE", "DROP"
resp.rules[0].actions[0].archive.target_archive #=> String
resp.rules[0].actions[0].write_to_s3.action_failure_policy #=> String, one of "CONTINUE", "DROP"
resp.rules[0].actions[0].write_to_s3.role_arn #=> String
resp.rules[0].actions[0].write_to_s3.s3_bucket #=> String
resp.rules[0].actions[0].write_to_s3.s3_prefix #=> String
resp.rules[0].actions[0].write_to_s3.s3_sse_kms_key_id #=> String
resp.rules[0].actions[0].send.action_failure_policy #=> String, one of "CONTINUE", "DROP"
resp.rules[0].actions[0].send.role_arn #=> String
resp.rules[0].actions[0].add_header.header_name #=> String
resp.rules[0].actions[0].add_header.header_value #=> String
resp.rules[0].actions[0].replace_recipient.replace_with #=> Array
resp.rules[0].actions[0].replace_recipient.replace_with[0] #=> String
resp.rules[0].actions[0].deliver_to_mailbox.action_failure_policy #=> String, one of "CONTINUE", "DROP"
resp.rules[0].actions[0].deliver_to_mailbox.mailbox_arn #=> String
resp.rules[0].actions[0].deliver_to_mailbox.role_arn #=> String
resp.rules[0].actions[0].deliver_to_q_business.action_failure_policy #=> String, one of "CONTINUE", "DROP"
resp.rules[0].actions[0].deliver_to_q_business.application_id #=> String
resp.rules[0].actions[0].deliver_to_q_business.index_id #=> String
resp.rules[0].actions[0].deliver_to_q_business.role_arn #=> String
resp.rules[0].actions[0].publish_to_sns.action_failure_policy #=> String, one of "CONTINUE", "DROP"
resp.rules[0].actions[0].publish_to_sns.topic_arn #=> String
resp.rules[0].actions[0].publish_to_sns.role_arn #=> String
resp.rules[0].actions[0].publish_to_sns.encoding #=> String, one of "UTF-8", "BASE64"
resp.rules[0].actions[0].publish_to_sns.payload_type #=> String, one of "HEADERS", "CONTENT"
resp.rules[0].actions[0].bounce.action_failure_policy #=> String, one of "CONTINUE", "DROP"
resp.rules[0].actions[0].bounce.role_arn #=> String
resp.rules[0].actions[0].bounce.sender #=> String
resp.rules[0].actions[0].bounce.status_code #=> String
resp.rules[0].actions[0].bounce.smtp_reply_code #=> String
resp.rules[0].actions[0].bounce.diagnostic_message #=> String
resp.rules[0].actions[0].bounce.message #=> String
resp.rules[0].actions[0].invoke_lambda.action_failure_policy #=> String, one of "CONTINUE", "DROP"
resp.rules[0].actions[0].invoke_lambda.function_arn #=> String
resp.rules[0].actions[0].invoke_lambda.invocation_type #=> String, one of "EVENT", "REQUEST_RESPONSE"
resp.rules[0].actions[0].invoke_lambda.role_arn #=> String
resp.rules[0].actions[0].invoke_lambda.retry_time_minutes #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :rule_set_id (required, String) —

    The identifier of an existing rule set to be retrieved.

Returns:

See Also:



2342
2343
2344
2345
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 2342

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

#get_traffic_policy(params = {}) ⇒ Types::GetTrafficPolicyResponse

Fetch attributes of a traffic policy resource.

Examples:

Example: Get TrafficPolicy


resp = client.get_traffic_policy({
  traffic_policy_id: "tp-12345", 
})

resp.to_h outputs the following:
{
  default_action: "DENY", 
  max_message_size_bytes: 1000, 
  policy_statements: [
    {
      action: "ALLOW", 
      conditions: [
        {
          string_expression: {
            evaluate: {
              attribute: "RECIPIENT", 
            }, 
            operator: "EQUALS", 
            values: [
              "example@amazon.com", 
              "example@gmail.com", 
            ], 
          }, 
        }, 
      ], 
    }, 
  ], 
  traffic_policy_arn: "arn:aws:ses:us-east-1:123456789012:mailmanager-traffic-policy/tp-12345", 
  traffic_policy_id: "tp-12345", 
  traffic_policy_name: "trafficPolicyName", 
}

Request syntax with placeholder values


resp = client.get_traffic_policy({
  traffic_policy_id: "TrafficPolicyId", # required
})

Response structure


resp.traffic_policy_name #=> String
resp.traffic_policy_id #=> String
resp.traffic_policy_arn #=> String
resp.policy_statements #=> Array
resp.policy_statements[0].conditions #=> Array
resp.policy_statements[0].conditions[0].string_expression.evaluate.attribute #=> String, one of "RECIPIENT"
resp.policy_statements[0].conditions[0].string_expression.evaluate.analysis.analyzer #=> String
resp.policy_statements[0].conditions[0].string_expression.evaluate.analysis.result_field #=> String
resp.policy_statements[0].conditions[0].string_expression.operator #=> String, one of "EQUALS", "NOT_EQUALS", "STARTS_WITH", "ENDS_WITH", "CONTAINS"
resp.policy_statements[0].conditions[0].string_expression.values #=> Array
resp.policy_statements[0].conditions[0].string_expression.values[0] #=> String
resp.policy_statements[0].conditions[0].ip_expression.evaluate.attribute #=> String, one of "SENDER_IP"
resp.policy_statements[0].conditions[0].ip_expression.operator #=> String, one of "CIDR_MATCHES", "NOT_CIDR_MATCHES"
resp.policy_statements[0].conditions[0].ip_expression.values #=> Array
resp.policy_statements[0].conditions[0].ip_expression.values[0] #=> String
resp.policy_statements[0].conditions[0].ipv_6_expression.evaluate.attribute #=> String, one of "SENDER_IPV6"
resp.policy_statements[0].conditions[0].ipv_6_expression.operator #=> String, one of "CIDR_MATCHES", "NOT_CIDR_MATCHES"
resp.policy_statements[0].conditions[0].ipv_6_expression.values #=> Array
resp.policy_statements[0].conditions[0].ipv_6_expression.values[0] #=> String
resp.policy_statements[0].conditions[0].tls_expression.evaluate.attribute #=> String, one of "TLS_PROTOCOL"
resp.policy_statements[0].conditions[0].tls_expression.operator #=> String, one of "MINIMUM_TLS_VERSION", "IS"
resp.policy_statements[0].conditions[0].tls_expression.value #=> String, one of "TLS1_2", "TLS1_3"
resp.policy_statements[0].conditions[0].boolean_expression.evaluate.analysis.analyzer #=> String
resp.policy_statements[0].conditions[0].boolean_expression.evaluate.analysis.result_field #=> String
resp.policy_statements[0].conditions[0].boolean_expression.evaluate.is_in_address_list.attribute #=> String, one of "RECIPIENT"
resp.policy_statements[0].conditions[0].boolean_expression.evaluate.is_in_address_list.address_lists #=> Array
resp.policy_statements[0].conditions[0].boolean_expression.evaluate.is_in_address_list.address_lists[0] #=> String
resp.policy_statements[0].conditions[0].boolean_expression.operator #=> String, one of "IS_TRUE", "IS_FALSE"
resp.policy_statements[0].action #=> String, one of "ALLOW", "DENY"
resp.max_message_size_bytes #=> Integer
resp.default_action #=> String, one of "ALLOW", "DENY"
resp.created_timestamp #=> Time
resp.last_updated_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :traffic_policy_id (required, String) —

    The identifier of the traffic policy resource.

Returns:

See Also:



2444
2445
2446
2447
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 2444

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

#list_addon_instances(params = {}) ⇒ Types::ListAddonInstancesResponse

Lists all Add On instances in 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_addon_instances({
  next_token: "PaginationToken",
  page_size: 1,
})

Response structure


resp.addon_instances #=> Array
resp.addon_instances[0].addon_instance_id #=> String
resp.addon_instances[0].addon_subscription_id #=> String
resp.addon_instances[0].addon_name #=> String
resp.addon_instances[0].addon_instance_arn #=> String
resp.addon_instances[0].created_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

  • :page_size (Integer) —

    The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.

Returns:

See Also:



2488
2489
2490
2491
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 2488

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

#list_addon_subscriptions(params = {}) ⇒ Types::ListAddonSubscriptionsResponse

Lists all Add On subscriptions in 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_addon_subscriptions({
  next_token: "PaginationToken",
  page_size: 1,
})

Response structure


resp.addon_subscriptions #=> Array
resp.addon_subscriptions[0].addon_subscription_id #=> String
resp.addon_subscriptions[0].addon_name #=> String
resp.addon_subscriptions[0].addon_subscription_arn #=> String
resp.addon_subscriptions[0].created_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

  • :page_size (Integer) —

    The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.

Returns:

See Also:



2531
2532
2533
2534
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 2531

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

#list_address_list_import_jobs(params = {}) ⇒ Types::ListAddressListImportJobsResponse

Lists jobs for an address 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_address_list_import_jobs({
  address_list_id: "AddressListId", # required
  next_token: "PaginationToken",
  page_size: 1,
})

Response structure


resp.import_jobs #=> Array
resp.import_jobs[0].job_id #=> String
resp.import_jobs[0].name #=> String
resp.import_jobs[0].status #=> String, one of "CREATED", "PROCESSING", "COMPLETED", "FAILED", "STOPPED"
resp.import_jobs[0].pre_signed_url #=> String
resp.import_jobs[0].imported_items_count #=> Integer
resp.import_jobs[0].failed_items_count #=> Integer
resp.import_jobs[0].import_data_format.import_data_type #=> String, one of "CSV", "JSON"
resp.import_jobs[0].address_list_id #=> String
resp.import_jobs[0].created_timestamp #=> Time
resp.import_jobs[0].start_timestamp #=> Time
resp.import_jobs[0].completed_timestamp #=> Time
resp.import_jobs[0].error #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :address_list_id (required, String) —

    The unique identifier of the address list for listing import jobs.

  • :next_token (String) —

    If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

  • :page_size (Integer) —

    The maximum number of import jobs that are returned per call. You can use NextToken to retrieve the next page of jobs.

Returns:

See Also:



2586
2587
2588
2589
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 2586

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

#list_address_lists(params = {}) ⇒ Types::ListAddressListsResponse

Lists address lists for this 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_address_lists({
  next_token: "PaginationToken",
  page_size: 1,
})

Response structure


resp.address_lists #=> Array
resp.address_lists[0].address_list_id #=> String
resp.address_lists[0].address_list_arn #=> String
resp.address_lists[0].address_list_name #=> String
resp.address_lists[0].created_timestamp #=> Time
resp.address_lists[0].last_updated_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

  • :page_size (Integer) —

    The maximum number of address list resources that are returned per call. You can use NextToken to retrieve the next page of address lists.

Returns:

See Also:



2631
2632
2633
2634
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 2631

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

#list_archive_exports(params = {}) ⇒ Types::ListArchiveExportsResponse

Returns a list of email archive export 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_archive_exports({
  archive_id: "ArchiveId", # required
  next_token: "PaginationToken",
  page_size: 1,
})

Response structure


resp.exports #=> Array
resp.exports[0].export_id #=> String
resp.exports[0].status.submission_timestamp #=> Time
resp.exports[0].status.completion_timestamp #=> Time
resp.exports[0].status.state #=> String, one of "QUEUED", "PREPROCESSING", "PROCESSING", "COMPLETED", "FAILED", "CANCELLED"
resp.exports[0].status.error_message #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :archive_id (required, String) —

    The identifier of the archive.

  • :next_token (String) —

    If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

  • :page_size (Integer) —

    The maximum number of archive export jobs that are returned per call. You can use NextToken to obtain further pages of archives.

Returns:

See Also:



2679
2680
2681
2682
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 2679

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

#list_archive_searches(params = {}) ⇒ Types::ListArchiveSearchesResponse

Returns a list of email archive search 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_archive_searches({
  archive_id: "ArchiveId", # required
  next_token: "PaginationToken",
  page_size: 1,
})

Response structure


resp.searches #=> Array
resp.searches[0].search_id #=> String
resp.searches[0].status.submission_timestamp #=> Time
resp.searches[0].status.completion_timestamp #=> Time
resp.searches[0].status.state #=> String, one of "QUEUED", "RUNNING", "COMPLETED", "FAILED", "CANCELLED"
resp.searches[0].status.error_message #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :archive_id (required, String) —

    The identifier of the archive.

  • :next_token (String) —

    If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

  • :page_size (Integer) —

    The maximum number of archive search jobs that are returned per call. You can use NextToken to obtain further pages of archives.

Returns:

See Also:



2727
2728
2729
2730
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 2727

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

#list_archives(params = {}) ⇒ Types::ListArchivesResponse

Returns a list of all email archives in 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_archives({
  next_token: "PaginationToken",
  page_size: 1,
})

Response structure


resp.archives #=> Array
resp.archives[0].archive_id #=> String
resp.archives[0].archive_name #=> String
resp.archives[0].archive_state #=> String, one of "ACTIVE", "PENDING_DELETION"
resp.archives[0].last_updated_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

  • :page_size (Integer) —

    The maximum number of archives that are returned per call. You can use NextToken to obtain further pages of archives.

Returns:

See Also:



2770
2771
2772
2773
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 2770

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

#list_ingress_points(params = {}) ⇒ Types::ListIngressPointsResponse

List all ingress endpoint resources.

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

Examples:

Example: List IngressPoints


resp = client.list_ingress_points({
})

resp.to_h outputs the following:
{
  ingress_points: [
    {
      a_record: "abcde123.prod.us-east-1.email-border.ses.aws.a2z.com", 
      ingress_point_id: "inp-12345", 
      ingress_point_name: "ingressPointName", 
      status: "ACTIVE", 
      type: "OPEN", 
    }, 
  ], 
}

Example: List IngressPoints with PageSize


resp = client.list_ingress_points({
  page_size: 10, 
})

resp.to_h outputs the following:
{
  ingress_points: [
    {
      a_record: "abcde123.prod.us-east-1.email-border.ses.aws.a2z.com", 
      ingress_point_id: "inp-12345", 
      ingress_point_name: "ingressPointName", 
      status: "ACTIVE", 
      type: "OPEN", 
    }, 
  ], 
}

Example: List IngressPoints with NextToken


resp = client.list_ingress_points({
  next_token: "nextToken", 
})

resp.to_h outputs the following:
{
  ingress_points: [
    {
      a_record: "abcde123.prod.us-east-1.email-border.ses.aws.a2z.com", 
      ingress_point_id: "inp-12345", 
      ingress_point_name: "ingressPointName", 
      status: "ACTIVE", 
      type: "OPEN", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_ingress_points({
  page_size: 1,
  next_token: "PaginationToken",
})

Response structure


resp.ingress_points #=> Array
resp.ingress_points[0].ingress_point_name #=> String
resp.ingress_points[0].ingress_point_id #=> String
resp.ingress_points[0].status #=> String, one of "PROVISIONING", "DEPROVISIONING", "UPDATING", "ACTIVE", "CLOSED", "FAILED", "ASSOCIATED_VPC_ENDPOINT_DOES_NOT_EXIST"
resp.ingress_points[0].type #=> String, one of "OPEN", "AUTH", "MTLS"
resp.ingress_points[0].a_record #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :page_size (Integer) —

    The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.

  • :next_token (String) —

    If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

Returns:

See Also:



2871
2872
2873
2874
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 2871

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

#list_members_of_address_list(params = {}) ⇒ Types::ListMembersOfAddressListResponse

Lists members of an address 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_members_of_address_list({
  address_list_id: "AddressListId", # required
  filter: {
    address_prefix: "AddressPrefix",
  },
  next_token: "PaginationToken",
  page_size: 1,
})

Response structure


resp.addresses #=> Array
resp.addresses[0].address #=> String
resp.addresses[0].created_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :address_list_id (required, String) —

    The unique identifier of the address list to list the addresses from.

  • :filter (Types::AddressFilter) —

    Filter to be used to limit the results.

  • :next_token (String) —

    If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

  • :page_size (Integer) —

    The maximum number of address list members that are returned per call. You can use NextToken to retrieve the next page of members.

Returns:

See Also:



2922
2923
2924
2925
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 2922

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

#list_relays(params = {}) ⇒ Types::ListRelaysResponse

Lists all the existing relay resources.

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_relays({
  page_size: 1,
  next_token: "PaginationToken",
})

Response structure


resp.relays #=> Array
resp.relays[0].relay_id #=> String
resp.relays[0].relay_name #=> String
resp.relays[0].last_modified_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :page_size (Integer) —

    The number of relays to be returned in one request.

  • :next_token (String) —

    If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

Returns:

See Also:



2963
2964
2965
2966
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 2963

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

#list_rule_sets(params = {}) ⇒ Types::ListRuleSetsResponse

List rule sets for this 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_rule_sets({
  next_token: "PaginationToken",
  page_size: 1,
})

Response structure


resp.rule_sets #=> Array
resp.rule_sets[0].rule_set_id #=> String
resp.rule_sets[0].rule_set_name #=> String
resp.rule_sets[0].last_modification_date #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

  • :page_size (Integer) —

    The maximum number of rule set resources that are returned per call. You can use NextToken to obtain further rule sets.

Returns:

See Also:



3005
3006
3007
3008
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 3005

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

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

Retrieves the list of tags (keys and values) assigned to the resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "TaggableResourceArn", # 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 to retrieve tags from.

Returns:

See Also:



3035
3036
3037
3038
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 3035

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

#list_traffic_policies(params = {}) ⇒ Types::ListTrafficPoliciesResponse

List traffic policy resources.

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

Examples:

Example: List TrafficPolicies


resp = client.list_traffic_policies({
})

resp.to_h outputs the following:
{
  traffic_policies: [
    {
      default_action: "DENY", 
      traffic_policy_id: "tp-12345", 
      traffic_policy_name: "trafficPolicyName", 
    }, 
  ], 
}

Example: List TrafficPolicies with PageSize


resp = client.list_traffic_policies({
  page_size: 10, 
})

resp.to_h outputs the following:
{
  traffic_policies: [
    {
      default_action: "DENY", 
      traffic_policy_id: "tp-12345", 
      traffic_policy_name: "trafficPolicyName", 
    }, 
  ], 
}

Example: List TrafficPolicies with NextToken


resp = client.list_traffic_policies({
  next_token: "nextToken", 
})

resp.to_h outputs the following:
{
  traffic_policies: [
    {
      default_action: "DENY", 
      traffic_policy_id: "tp-12345", 
      traffic_policy_name: "trafficPolicyName", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_traffic_policies({
  page_size: 1,
  next_token: "PaginationToken",
})

Response structure


resp.traffic_policies #=> Array
resp.traffic_policies[0].traffic_policy_name #=> String
resp.traffic_policies[0].traffic_policy_id #=> String
resp.traffic_policies[0].default_action #=> String, one of "ALLOW", "DENY"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :page_size (Integer) —

    The maximum number of traffic policy resources that are returned per call. You can use NextToken to obtain further traffic policies.

  • :next_token (String) —

    If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

Returns:

See Also:



3128
3129
3130
3131
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 3128

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

#register_member_to_address_list(params = {}) ⇒ Struct

Adds a member to an address list.

Examples:

Request syntax with placeholder values


resp = client.register_member_to_address_list({
  address_list_id: "AddressListId", # required
  address: "Address", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :address_list_id (required, String) —

    The unique identifier of the address list where the address should be added.

  • :address (required, String) —

    The address to be added to the address list.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3155
3156
3157
3158
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 3155

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

#start_address_list_import_job(params = {}) ⇒ Struct

Starts an import job for an address list.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The identifier of the import job that needs to be started.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3177
3178
3179
3180
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 3177

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

#start_archive_export(params = {}) ⇒ Types::StartArchiveExportResponse

Initiates an export of emails from the specified archive.

Examples:

Request syntax with placeholder values


resp = client.start_archive_export({
  archive_id: "ArchiveId", # required
  filters: {
    include: [
      {
        string_expression: {
          evaluate: { # required
            attribute: "TO", # accepts TO, FROM, CC, SUBJECT, ENVELOPE_TO, ENVELOPE_FROM
          },
          operator: "CONTAINS", # required, accepts CONTAINS
          values: ["StringValue"], # required
        },
        boolean_expression: {
          evaluate: { # required
            attribute: "HAS_ATTACHMENTS", # accepts HAS_ATTACHMENTS
          },
          operator: "IS_TRUE", # required, accepts IS_TRUE, IS_FALSE
        },
      },
    ],
    unless: [
      {
        string_expression: {
          evaluate: { # required
            attribute: "TO", # accepts TO, FROM, CC, SUBJECT, ENVELOPE_TO, ENVELOPE_FROM
          },
          operator: "CONTAINS", # required, accepts CONTAINS
          values: ["StringValue"], # required
        },
        boolean_expression: {
          evaluate: { # required
            attribute: "HAS_ATTACHMENTS", # accepts HAS_ATTACHMENTS
          },
          operator: "IS_TRUE", # required, accepts IS_TRUE, IS_FALSE
        },
      },
    ],
  },
  from_timestamp: Time.now, # required
  to_timestamp: Time.now, # required
  max_results: 1,
  export_destination_configuration: { # required
    s3: {
      s3_location: "S3Location",
    },
  },
  include_metadata: false,
})

Response structure


resp.export_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :archive_id (required, String) —

    The identifier of the archive to export emails from.

  • :filters (Types::ArchiveFilters) —

    Criteria to filter which emails are included in the export.

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

    The start of the timestamp range to include emails from.

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

    The end of the timestamp range to include emails from.

  • :max_results (Integer) —

    The maximum number of email items to include in the export.

  • :export_destination_configuration (required, Types::ExportDestinationConfiguration) —

    Details on where to deliver the exported email data.

  • :include_metadata (Boolean) —

    Whether to include message metadata as JSON files in the export.

Returns:

See Also:



3268
3269
3270
3271
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 3268

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

#start_archive_search(params = {}) ⇒ Types::StartArchiveSearchResponse

Initiates a search across emails in the specified archive.

Examples:

Request syntax with placeholder values


resp = client.start_archive_search({
  archive_id: "ArchiveId", # required
  filters: {
    include: [
      {
        string_expression: {
          evaluate: { # required
            attribute: "TO", # accepts TO, FROM, CC, SUBJECT, ENVELOPE_TO, ENVELOPE_FROM
          },
          operator: "CONTAINS", # required, accepts CONTAINS
          values: ["StringValue"], # required
        },
        boolean_expression: {
          evaluate: { # required
            attribute: "HAS_ATTACHMENTS", # accepts HAS_ATTACHMENTS
          },
          operator: "IS_TRUE", # required, accepts IS_TRUE, IS_FALSE
        },
      },
    ],
    unless: [
      {
        string_expression: {
          evaluate: { # required
            attribute: "TO", # accepts TO, FROM, CC, SUBJECT, ENVELOPE_TO, ENVELOPE_FROM
          },
          operator: "CONTAINS", # required, accepts CONTAINS
          values: ["StringValue"], # required
        },
        boolean_expression: {
          evaluate: { # required
            attribute: "HAS_ATTACHMENTS", # accepts HAS_ATTACHMENTS
          },
          operator: "IS_TRUE", # required, accepts IS_TRUE, IS_FALSE
        },
      },
    ],
  },
  from_timestamp: Time.now, # required
  to_timestamp: Time.now, # required
  max_results: 1, # required
})

Response structure


resp.search_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :archive_id (required, String) —

    The identifier of the archive to search emails in.

  • :filters (Types::ArchiveFilters) —

    Criteria to filter which emails are included in the search results.

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

    The start timestamp of the range to search emails from.

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

    The end timestamp of the range to search emails from.

  • :max_results (required, Integer) —

    The maximum number of search results to return.

Returns:

See Also:



3347
3348
3349
3350
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 3347

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

#stop_address_list_import_job(params = {}) ⇒ Struct

Stops an ongoing import job for an address list.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The identifier of the import job that needs to be stopped.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3369
3370
3371
3372
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 3369

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

#stop_archive_export(params = {}) ⇒ Struct

Stops an in-progress export of emails from an archive.

Examples:

Request syntax with placeholder values


resp = client.stop_archive_export({
  export_id: "ExportId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :export_id (required, String) —

    The identifier of the export job to stop.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3391
3392
3393
3394
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 3391

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

#stop_archive_search(params = {}) ⇒ Struct

Stops an in-progress archive search job.

Examples:

Request syntax with placeholder values


resp = client.stop_archive_search({
  search_id: "SearchId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :search_id (required, String) —

    The identifier of the search job to stop.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3413
3414
3415
3416
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 3413

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

#tag_resource(params = {}) ⇒ Struct

Adds one or more tags (keys and values) to a specified resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "TaggableResourceArn", # 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 tag.

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

    The tags used to organize, track, or control access for the resource. For example, { "tags": "key2":"value2" }.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3446
3447
3448
3449
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 3446

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, 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: "TaggableResourceArn", # 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 untag.

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

    The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3473
3474
3475
3476
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 3473

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

#update_archive(params = {}) ⇒ Struct

Updates the attributes of an existing email archive.

Examples:

Request syntax with placeholder values


resp = client.update_archive({
  archive_id: "ArchiveIdString", # required
  archive_name: "ArchiveNameString",
  retention: {
    retention_period: "THREE_MONTHS", # accepts THREE_MONTHS, SIX_MONTHS, NINE_MONTHS, ONE_YEAR, EIGHTEEN_MONTHS, TWO_YEARS, THIRTY_MONTHS, THREE_YEARS, FOUR_YEARS, FIVE_YEARS, SIX_YEARS, SEVEN_YEARS, EIGHT_YEARS, NINE_YEARS, TEN_YEARS, PERMANENT
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :archive_id (required, String) —

    The identifier of the archive to update.

  • :archive_name (String) —

    A new, unique name for the archive.

  • :retention (Types::ArchiveRetention) —

    A new retention period for emails in the archive.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3505
3506
3507
3508
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 3505

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

#update_ingress_point(params = {}) ⇒ Struct

Update attributes of a provisioned ingress endpoint resource.

Examples:

Example: Update Open/Auth IngressPoint with new Name


resp = client.update_ingress_point({
  ingress_point_id: "inp-12345", 
  ingress_point_name: "ingressPointNewName", 
})

resp.to_h outputs the following:
{
}

Example: Update Open/Auth IngressPoint with new RuleSetId / TrafficPolicyId


resp = client.update_ingress_point({
  ingress_point_id: "inp-12345", 
  rule_set_id: "rs-12345", 
  traffic_policy_id: "tp-12345", 
})

resp.to_h outputs the following:
{
}

Example: Update Auth IngressPoint with new SmtpPassword


resp = client.update_ingress_point({
  ingress_point_configuration: {
    smtp_password: "newSmtpPassword", 
  }, 
  ingress_point_id: "inp-12345", 
})

resp.to_h outputs the following:
{
}

Example: Update Auth IngressPoint with new SecretArn


resp = client.update_ingress_point({
  ingress_point_configuration: {
    secret_arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:abcde", 
  }, 
  ingress_point_id: "inp-12345", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.update_ingress_point({
  ingress_point_id: "IngressPointId", # required
  ingress_point_name: "IngressPointName",
  status_to_update: "ACTIVE", # accepts ACTIVE, CLOSED
  rule_set_id: "RuleSetId",
  traffic_policy_id: "TrafficPolicyId",
  ingress_point_configuration: {
    smtp_password: "SmtpPassword",
    secret_arn: "SecretArn",
    tls_auth_configuration: {
      trust_store: {
        ca_content: "CAContent", # required
        crl_content: "CrlContent",
        kms_key_arn: "KmsKeyArn",
      },
    },
  },
  tls_policy: "REQUIRED", # accepts REQUIRED, OPTIONAL, FIPS
})

Parameters:

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

    ({})

Options Hash (params):

  • :ingress_point_id (required, String) —

    The identifier for the ingress endpoint you want to update.

  • :ingress_point_name (String) —

    A user friendly name for the ingress endpoint resource.

  • :status_to_update (String) —

    The update status of an ingress endpoint.

  • :rule_set_id (String) —

    The identifier of an existing rule set that you attach to an ingress endpoint resource.

  • :traffic_policy_id (String) —

    The identifier of an existing traffic policy that you attach to an ingress endpoint resource.

  • :ingress_point_configuration (Types::IngressPointConfiguration) —

    If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.

  • :tls_policy (String) —

    The Transport Layer Security (TLS) policy for the ingress point. Valid values are REQUIRED, OPTIONAL. Only ingress endpoints using REQUIRED or OPTIONAL as TlsPolicy can be updated.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3616
3617
3618
3619
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 3616

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

#update_relay(params = {}) ⇒ Struct

Updates the attributes of an existing relay resource.

Examples:

Request syntax with placeholder values


resp = client.update_relay({
  relay_id: "RelayId", # required
  relay_name: "RelayName",
  server_name: "RelayServerName",
  server_port: 1,
  authentication: {
    secret_arn: "SecretArn",
    no_authentication: {
    },
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :relay_id (required, String) —

    The unique relay identifier.

  • :relay_name (String) —

    The name of the relay resource.

  • :server_name (String) —

    The destination relay server address.

  • :server_port (Integer) —

    The destination relay server port.

  • :authentication (Types::RelayAuthentication) —

    Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3659
3660
3661
3662
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 3659

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

#update_rule_set(params = {}) ⇒ Struct

Update attributes of an already provisioned rule set.

Examples:

Request syntax with placeholder values


resp = client.update_rule_set({
  rule_set_id: "RuleSetId", # required
  rule_set_name: "RuleSetName",
  rules: [
    {
      name: "RuleName",
      conditions: [
        {
          boolean_expression: {
            evaluate: { # required
              attribute: "READ_RECEIPT_REQUESTED", # accepts READ_RECEIPT_REQUESTED, TLS, TLS_WRAPPED
              analysis: {
                analyzer: "AnalyzerArn", # required
                result_field: "ResultField", # required
              },
              is_in_address_list: {
                attribute: "RECIPIENT", # required, accepts RECIPIENT, MAIL_FROM, SENDER, FROM, TO, CC
                address_lists: ["AddressListArn"], # required
              },
            },
            operator: "IS_TRUE", # required, accepts IS_TRUE, IS_FALSE
          },
          string_expression: {
            evaluate: { # required
              attribute: "MAIL_FROM", # accepts MAIL_FROM, HELO, RECIPIENT, SENDER, FROM, SUBJECT, TO, CC
              mime_header_attribute: "MimeHeaderAttribute",
              analysis: {
                analyzer: "AnalyzerArn", # required
                result_field: "ResultField", # required
              },
              client_certificate_attribute: "CN", # accepts CN, SAN_RFC822_NAME, SAN_DNS_NAME, SAN_DIRECTORY_NAME, SAN_UNIFORM_RESOURCE_IDENTIFIER, SAN_IP_ADDRESS, SAN_REGISTERED_ID, SERIAL_NUMBER
            },
            operator: "EQUALS", # required, accepts EQUALS, NOT_EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS
            values: ["RuleStringValue"], # required
          },
          number_expression: {
            evaluate: { # required
              attribute: "MESSAGE_SIZE", # accepts MESSAGE_SIZE
            },
            operator: "EQUALS", # required, accepts EQUALS, NOT_EQUALS, LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUAL, GREATER_THAN_OR_EQUAL
            value: 1.0, # required
          },
          ip_expression: {
            evaluate: { # required
              attribute: "SOURCE_IP", # accepts SOURCE_IP
            },
            operator: "CIDR_MATCHES", # required, accepts CIDR_MATCHES, NOT_CIDR_MATCHES
            values: ["RuleIpStringValue"], # required
          },
          verdict_expression: {
            evaluate: { # required
              attribute: "SPF", # accepts SPF, DKIM
              analysis: {
                analyzer: "AnalyzerArn", # required
                result_field: "ResultField", # required
              },
            },
            operator: "EQUALS", # required, accepts EQUALS, NOT_EQUALS
            values: ["PASS"], # required, accepts PASS, FAIL, GRAY, PROCESSING_FAILED
          },
          dmarc_expression: {
            operator: "EQUALS", # required, accepts EQUALS, NOT_EQUALS
            values: ["NONE"], # required, accepts NONE, QUARANTINE, REJECT
          },
        },
      ],
      unless: [
        {
          boolean_expression: {
            evaluate: { # required
              attribute: "READ_RECEIPT_REQUESTED", # accepts READ_RECEIPT_REQUESTED, TLS, TLS_WRAPPED
              analysis: {
                analyzer: "AnalyzerArn", # required
                result_field: "ResultField", # required
              },
              is_in_address_list: {
                attribute: "RECIPIENT", # required, accepts RECIPIENT, MAIL_FROM, SENDER, FROM, TO, CC
                address_lists: ["AddressListArn"], # required
              },
            },
            operator: "IS_TRUE", # required, accepts IS_TRUE, IS_FALSE
          },
          string_expression: {
            evaluate: { # required
              attribute: "MAIL_FROM", # accepts MAIL_FROM, HELO, RECIPIENT, SENDER, FROM, SUBJECT, TO, CC
              mime_header_attribute: "MimeHeaderAttribute",
              analysis: {
                analyzer: "AnalyzerArn", # required
                result_field: "ResultField", # required
              },
              client_certificate_attribute: "CN", # accepts CN, SAN_RFC822_NAME, SAN_DNS_NAME, SAN_DIRECTORY_NAME, SAN_UNIFORM_RESOURCE_IDENTIFIER, SAN_IP_ADDRESS, SAN_REGISTERED_ID, SERIAL_NUMBER
            },
            operator: "EQUALS", # required, accepts EQUALS, NOT_EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS
            values: ["RuleStringValue"], # required
          },
          number_expression: {
            evaluate: { # required
              attribute: "MESSAGE_SIZE", # accepts MESSAGE_SIZE
            },
            operator: "EQUALS", # required, accepts EQUALS, NOT_EQUALS, LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUAL, GREATER_THAN_OR_EQUAL
            value: 1.0, # required
          },
          ip_expression: {
            evaluate: { # required
              attribute: "SOURCE_IP", # accepts SOURCE_IP
            },
            operator: "CIDR_MATCHES", # required, accepts CIDR_MATCHES, NOT_CIDR_MATCHES
            values: ["RuleIpStringValue"], # required
          },
          verdict_expression: {
            evaluate: { # required
              attribute: "SPF", # accepts SPF, DKIM
              analysis: {
                analyzer: "AnalyzerArn", # required
                result_field: "ResultField", # required
              },
            },
            operator: "EQUALS", # required, accepts EQUALS, NOT_EQUALS
            values: ["PASS"], # required, accepts PASS, FAIL, GRAY, PROCESSING_FAILED
          },
          dmarc_expression: {
            operator: "EQUALS", # required, accepts EQUALS, NOT_EQUALS
            values: ["NONE"], # required, accepts NONE, QUARANTINE, REJECT
          },
        },
      ],
      actions: [ # required
        {
          drop: {
          },
          relay: {
            action_failure_policy: "CONTINUE", # accepts CONTINUE, DROP
            relay: "IdOrArn", # required
            mail_from: "REPLACE", # accepts REPLACE, PRESERVE
          },
          archive: {
            action_failure_policy: "CONTINUE", # accepts CONTINUE, DROP
            target_archive: "NameOrArn", # required
          },
          write_to_s3: {
            action_failure_policy: "CONTINUE", # accepts CONTINUE, DROP
            role_arn: "IamRoleArn", # required
            s3_bucket: "S3Bucket", # required
            s3_prefix: "S3Prefix",
            s3_sse_kms_key_id: "KmsKeyId",
          },
          send: {
            action_failure_policy: "CONTINUE", # accepts CONTINUE, DROP
            role_arn: "IamRoleArn", # required
          },
          add_header: {
            header_name: "HeaderName", # required
            header_value: "HeaderValue", # required
          },
          replace_recipient: {
            replace_with: ["EmailAddress"],
          },
          deliver_to_mailbox: {
            action_failure_policy: "CONTINUE", # accepts CONTINUE, DROP
            mailbox_arn: "NameOrArn", # required
            role_arn: "IamRoleArn", # required
          },
          deliver_to_q_business: {
            action_failure_policy: "CONTINUE", # accepts CONTINUE, DROP
            application_id: "QBusinessApplicationId", # required
            index_id: "QBusinessIndexId", # required
            role_arn: "IamRoleArn", # required
          },
          publish_to_sns: {
            action_failure_policy: "CONTINUE", # accepts CONTINUE, DROP
            topic_arn: "SnsTopicArn", # required
            role_arn: "IamRoleArn", # required
            encoding: "UTF-8", # accepts UTF-8, BASE64
            payload_type: "HEADERS", # accepts HEADERS, CONTENT
          },
          bounce: {
            action_failure_policy: "CONTINUE", # accepts CONTINUE, DROP
            role_arn: "IamRoleArn", # required
            sender: "EmailAddress", # required
            status_code: "StatusCode", # required
            smtp_reply_code: "SmtpReplyCode", # required
            diagnostic_message: "DiagnosticMessage", # required
            message: "BounceMessage",
          },
          invoke_lambda: {
            action_failure_policy: "CONTINUE", # accepts CONTINUE, DROP
            function_arn: "LambdaFunctionArn", # required
            invocation_type: "EVENT", # required, accepts EVENT, REQUEST_RESPONSE
            role_arn: "IamRoleArn", # required
            retry_time_minutes: 1,
          },
        },
      ],
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :rule_set_id (required, String) —

    The identifier of a rule set you want to update.

  • :rule_set_name (String) —

    A user-friendly name for the rule set resource.

  • :rules (Array<Types::Rule>) —

    A new set of rules to replace the current rules of the rule set—these rules will override all the rules of the rule set.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3881
3882
3883
3884
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 3881

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

#update_traffic_policy(params = {}) ⇒ Struct

Update attributes of an already provisioned traffic policy resource.

Examples:

Example: Update TrafficPolicy with new Name


resp = client.update_traffic_policy({
  traffic_policy_id: "tp-12345", 
  traffic_policy_name: "trafficPolicyNewName", 
})

resp.to_h outputs the following:
{
}

Example: Update TrafficPolicy with new PolicyStatements


resp = client.update_traffic_policy({
  policy_statements: [
    {
      action: "ALLOW", 
      conditions: [
        {
          string_expression: {
            evaluate: {
              attribute: "RECIPIENT", 
            }, 
            operator: "EQUALS", 
            values: [
              "example@amazon.com", 
              "example@gmail.com", 
            ], 
          }, 
        }, 
      ], 
    }, 
  ], 
  traffic_policy_id: "tp-12345", 
})

resp.to_h outputs the following:
{
}

Example: Update TrafficPolicy with new DefaultAction


resp = client.update_traffic_policy({
  default_action: "ALLOW", 
  traffic_policy_id: "tp-12345", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.update_traffic_policy({
  traffic_policy_id: "TrafficPolicyId", # required
  traffic_policy_name: "TrafficPolicyName",
  policy_statements: [
    {
      conditions: [ # required
        {
          string_expression: {
            evaluate: { # required
              attribute: "RECIPIENT", # accepts RECIPIENT
              analysis: {
                analyzer: "AnalyzerArn", # required
                result_field: "ResultField", # required
              },
            },
            operator: "EQUALS", # required, accepts EQUALS, NOT_EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS
            values: ["String"], # required
          },
          ip_expression: {
            evaluate: { # required
              attribute: "SENDER_IP", # accepts SENDER_IP
            },
            operator: "CIDR_MATCHES", # required, accepts CIDR_MATCHES, NOT_CIDR_MATCHES
            values: ["Ipv4Cidr"], # required
          },
          ipv_6_expression: {
            evaluate: { # required
              attribute: "SENDER_IPV6", # accepts SENDER_IPV6
            },
            operator: "CIDR_MATCHES", # required, accepts CIDR_MATCHES, NOT_CIDR_MATCHES
            values: ["Ipv6Cidr"], # required
          },
          tls_expression: {
            evaluate: { # required
              attribute: "TLS_PROTOCOL", # accepts TLS_PROTOCOL
            },
            operator: "MINIMUM_TLS_VERSION", # required, accepts MINIMUM_TLS_VERSION, IS
            value: "TLS1_2", # required, accepts TLS1_2, TLS1_3
          },
          boolean_expression: {
            evaluate: { # required
              analysis: {
                analyzer: "AnalyzerArn", # required
                result_field: "ResultField", # required
              },
              is_in_address_list: {
                attribute: "RECIPIENT", # required, accepts RECIPIENT
                address_lists: ["AddressListArn"], # required
              },
            },
            operator: "IS_TRUE", # required, accepts IS_TRUE, IS_FALSE
          },
        },
      ],
      action: "ALLOW", # required, accepts ALLOW, DENY
    },
  ],
  default_action: "ALLOW", # accepts ALLOW, DENY
  max_message_size_bytes: 1,
})

Parameters:

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

    ({})

Options Hash (params):

  • :traffic_policy_id (required, String) —

    The identifier of the traffic policy that you want to update.

  • :traffic_policy_name (String) —

    A user-friendly name for the traffic policy resource.

  • :policy_statements (Array<Types::PolicyStatement>) —

    The list of conditions to be updated for filtering email traffic.

  • :default_action (String) —

    Default action instructs the traffic policy to either Allow or Deny (block) messages that fall outside of (or not addressed by) the conditions of your policy statements

  • :max_message_size_bytes (Integer) —

    The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4027
4028
4029
4030
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/client.rb', line 4027

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