com.amazonaws.services.simpleemailv2.AmazonSimpleEmailServiceV2 Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sesv2 Show documentation
/*
* Copyright 2017-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.simpleemailv2;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.simpleemailv2.model.*;
/**
* Interface for accessing Amazon SES V2.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.simpleemailv2.AbstractAmazonSimpleEmailServiceV2} instead.
*
*
* Amazon SES API v2
*
* Amazon SES is an Amazon Web Services service that you can use to send email
* messages to your customers.
*
*
* If you're new to Amazon SES API v2, you might find it helpful to review the Amazon Simple Email Service Developer Guide. The
* Amazon SES Developer Guide provides information and code samples that demonstrate how to use Amazon SES API v2
* features programmatically.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonSimpleEmailServiceV2 {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "email";
/**
*
* Create a configuration set. Configuration sets are groups of rules that you can apply to the emails that
* you send. You apply a configuration set to an email by specifying the name of the configuration set when you call
* the Amazon SES API v2. When you apply a configuration set to an email, all of the rules in that configuration set
* are applied to the email.
*
*
* @param createConfigurationSetRequest
* A request to create a configuration set.
* @return Result of the CreateConfigurationSet operation returned by the service.
* @throws AlreadyExistsException
* The resource specified in your request already exists.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @sample AmazonSimpleEmailServiceV2.CreateConfigurationSet
* @see AWS
* API Documentation
*/
CreateConfigurationSetResult createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest);
/**
*
* Create an event destination. Events include message sends, deliveries, opens, clicks, bounces, and
* complaints. Event destinations are places that you can send information about these events to. For
* example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints,
* or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
*
*
* A single configuration set can include more than one event destination.
*
*
* @param createConfigurationSetEventDestinationRequest
* A request to add an event destination to a configuration set.
* @return Result of the CreateConfigurationSetEventDestination operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws AlreadyExistsException
* The resource specified in your request already exists.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.CreateConfigurationSetEventDestination
* @see AWS API Documentation
*/
CreateConfigurationSetEventDestinationResult createConfigurationSetEventDestination(
CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest);
/**
*
* Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list.
*
*
* @param createContactRequest
* @return Result of the CreateContact operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws AlreadyExistsException
* The resource specified in your request already exists.
* @sample AmazonSimpleEmailServiceV2.CreateContact
* @see AWS API
* Documentation
*/
CreateContactResult createContact(CreateContactRequest createContactRequest);
/**
*
* Creates a contact list.
*
*
* @param createContactListRequest
* @return Result of the CreateContactList operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws AlreadyExistsException
* The resource specified in your request already exists.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @sample AmazonSimpleEmailServiceV2.CreateContactList
* @see AWS API
* Documentation
*/
CreateContactListResult createContactList(CreateContactListRequest createContactListRequest);
/**
*
* Creates a new custom verification email template.
*
*
* For more information about custom verification email templates, see Using Custom
* Verification Email Templates in the Amazon SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param createCustomVerificationEmailTemplateRequest
* Represents a request to create a custom verification email template.
* @return Result of the CreateCustomVerificationEmailTemplate operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws AlreadyExistsException
* The resource specified in your request already exists.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @sample AmazonSimpleEmailServiceV2.CreateCustomVerificationEmailTemplate
* @see AWS API Documentation
*/
CreateCustomVerificationEmailTemplateResult createCustomVerificationEmailTemplate(
CreateCustomVerificationEmailTemplateRequest createCustomVerificationEmailTemplateRequest);
/**
*
* Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are
* associated with your Amazon Web Services account. You can associate a pool with a configuration set. When you
* send an email that uses that configuration set, the message is sent from one of the addresses in the associated
* pool.
*
*
* @param createDedicatedIpPoolRequest
* A request to create a new dedicated IP pool.
* @return Result of the CreateDedicatedIpPool operation returned by the service.
* @throws AlreadyExistsException
* The resource specified in your request already exists.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @sample AmazonSimpleEmailServiceV2.CreateDedicatedIpPool
* @see AWS
* API Documentation
*/
CreateDedicatedIpPoolResult createDedicatedIpPool(CreateDedicatedIpPoolRequest createDedicatedIpPoolRequest);
/**
*
* Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your
* messages will be handled by various email providers around the world. When you perform a predictive inbox
* placement test, you provide a sample message that contains the content that you plan to send to your customers.
* Amazon SES then sends that message to special email addresses spread across several major email providers. After
* about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to
* view the results of the test.
*
*
* @param createDeliverabilityTestReportRequest
* A request to perform a predictive inbox placement test. Predictive inbox placement tests can help you
* predict how your messages will be handled by various email providers around the world. When you perform a
* predictive inbox placement test, you provide a sample message that contains the content that you plan to
* send to your customers. We send that message to special email addresses spread across several major email
* providers around the world. The test takes about 24 hours to complete. When the test is complete, you can
* use the GetDeliverabilityTestReport operation to view the results of the test.
* @return Result of the CreateDeliverabilityTestReport operation returned by the service.
* @throws AccountSuspendedException
* The message can't be sent because the account's ability to send email has been permanently restricted.
* @throws SendingPausedException
* The message can't be sent because the account's ability to send email is currently paused.
* @throws MessageRejectedException
* The message can't be sent because it contains invalid content.
* @throws MailFromDomainNotVerifiedException
* The message can't be sent because the sending domain isn't verified.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @sample AmazonSimpleEmailServiceV2.CreateDeliverabilityTestReport
* @see AWS API Documentation
*/
CreateDeliverabilityTestReportResult createDeliverabilityTestReport(CreateDeliverabilityTestReportRequest createDeliverabilityTestReportRequest);
/**
*
* Starts the process of verifying an email identity. An identity is an email address or domain that you use
* when you send email. Before you can use an identity to send email, you first have to verify it. By verifying an
* identity, you demonstrate that you're the owner of the identity, and that you've given Amazon SES API v2
* permission to send email from the identity.
*
*
* When you verify an email address, Amazon SES sends an email to the address. Your email address is verified as
* soon as you follow the link in the verification email.
*
*
* When you verify a domain without specifying the DkimSigningAttributes object, this operation
* provides a set of DKIM tokens. You can convert these tokens into CNAME records, which you then add to the DNS
* configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS
* configuration for your domain. This verification method is known as Easy DKIM.
*
*
* Alternatively, you can perform the verification process by providing your own public-private key pair. This
* verification method is known as Bring Your Own DKIM (BYODKIM). To use BYODKIM, your call to the
* CreateEmailIdentity operation has to include the DkimSigningAttributes object. When you
* specify this object, you provide a selector (a component of the DNS record name that identifies the public key to
* use for DKIM authentication) and a private key.
*
*
* When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens.
* You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon SES
* detects these records in the DNS configuration for your domain. For some DNS providers, it can take 72 hours or
* more to complete the domain verification process.
*
*
* Additionally, you can associate an existing configuration set with the email identity that you're verifying.
*
*
* @param createEmailIdentityRequest
* A request to begin the verification process for an email identity (an email address or domain).
* @return Result of the CreateEmailIdentity operation returned by the service.
* @throws AlreadyExistsException
* The resource specified in your request already exists.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @sample AmazonSimpleEmailServiceV2.CreateEmailIdentity
* @see AWS API
* Documentation
*/
CreateEmailIdentityResult createEmailIdentity(CreateEmailIdentityRequest createEmailIdentityRequest);
/**
*
* Creates the specified sending authorization policy for the given identity (an email address or a domain).
*
*
*
* This API is for the identity owner only. If you have not verified the identity, this API will return an error.
*
*
*
* Sending authorization is a feature that enables an identity owner to authorize other senders to use its
* identities. For information about using sending authorization, see the Amazon SES Developer
* Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param createEmailIdentityPolicyRequest
* Represents a request to create a sending authorization policy for an identity. Sending authorization is an
* Amazon SES feature that enables you to authorize other senders to use your identities. For information,
* see the Amazon SES Developer Guide.
* @return Result of the CreateEmailIdentityPolicy operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws AlreadyExistsException
* The resource specified in your request already exists.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.CreateEmailIdentityPolicy
* @see AWS API Documentation
*/
CreateEmailIdentityPolicyResult createEmailIdentityPolicy(CreateEmailIdentityPolicyRequest createEmailIdentityPolicyRequest);
/**
*
* Creates an email template. Email templates enable you to send personalized email to one or more destinations in a
* single API operation. For more information, see the Amazon SES
* Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param createEmailTemplateRequest
* Represents a request to create an email template. For more information, see the Amazon SES
* Developer Guide.
* @return Result of the CreateEmailTemplate operation returned by the service.
* @throws AlreadyExistsException
* The resource specified in your request already exists.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @sample AmazonSimpleEmailServiceV2.CreateEmailTemplate
* @see AWS API
* Documentation
*/
CreateEmailTemplateResult createEmailTemplate(CreateEmailTemplateRequest createEmailTemplateRequest);
/**
*
* Creates an import job for a data destination.
*
*
* @param createImportJobRequest
* Represents a request to create an import job from a data source for a data destination.
* @return Result of the CreateImportJob operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @sample AmazonSimpleEmailServiceV2.CreateImportJob
* @see AWS API
* Documentation
*/
CreateImportJobResult createImportJob(CreateImportJobRequest createImportJobRequest);
/**
*
* Delete an existing configuration set.
*
*
* Configuration sets are groups of rules that you can apply to the emails you send. You apply a
* configuration set to an email by including a reference to the configuration set in the headers of the email. When
* you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
*
*
* @param deleteConfigurationSetRequest
* A request to delete a configuration set.
* @return Result of the DeleteConfigurationSet operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @sample AmazonSimpleEmailServiceV2.DeleteConfigurationSet
* @see AWS
* API Documentation
*/
DeleteConfigurationSetResult deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest);
/**
*
* Delete an event destination.
*
*
* Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event
* destinations are places that you can send information about these events to. For example, you can send event
* data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis
* Data Firehose to stream data to Amazon S3 for long-term storage.
*
*
* @param deleteConfigurationSetEventDestinationRequest
* A request to delete an event destination from a configuration set.
* @return Result of the DeleteConfigurationSetEventDestination operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.DeleteConfigurationSetEventDestination
* @see AWS API Documentation
*/
DeleteConfigurationSetEventDestinationResult deleteConfigurationSetEventDestination(
DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest);
/**
*
* Removes a contact from a contact list.
*
*
* @param deleteContactRequest
* @return Result of the DeleteContact operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @sample AmazonSimpleEmailServiceV2.DeleteContact
* @see AWS API
* Documentation
*/
DeleteContactResult deleteContact(DeleteContactRequest deleteContactRequest);
/**
*
* Deletes a contact list and all of the contacts on that list.
*
*
* @param deleteContactListRequest
* @return Result of the DeleteContactList operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @sample AmazonSimpleEmailServiceV2.DeleteContactList
* @see AWS API
* Documentation
*/
DeleteContactListResult deleteContactList(DeleteContactListRequest deleteContactListRequest);
/**
*
* Deletes an existing custom verification email template.
*
*
* For more information about custom verification email templates, see Using Custom
* Verification Email Templates in the Amazon SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param deleteCustomVerificationEmailTemplateRequest
* Represents a request to delete an existing custom verification email template.
* @return Result of the DeleteCustomVerificationEmailTemplate operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.DeleteCustomVerificationEmailTemplate
* @see AWS API Documentation
*/
DeleteCustomVerificationEmailTemplateResult deleteCustomVerificationEmailTemplate(
DeleteCustomVerificationEmailTemplateRequest deleteCustomVerificationEmailTemplateRequest);
/**
*
* Delete a dedicated IP pool.
*
*
* @param deleteDedicatedIpPoolRequest
* A request to delete a dedicated IP pool.
* @return Result of the DeleteDedicatedIpPool operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @sample AmazonSimpleEmailServiceV2.DeleteDedicatedIpPool
* @see AWS
* API Documentation
*/
DeleteDedicatedIpPoolResult deleteDedicatedIpPool(DeleteDedicatedIpPoolRequest deleteDedicatedIpPoolRequest);
/**
*
* Deletes an email identity. An identity can be either an email address or a domain name.
*
*
* @param deleteEmailIdentityRequest
* A request to delete an existing email identity. When you delete an identity, you lose the ability to send
* email from that identity. You can restore your ability to send email by completing the verification
* process for the identity again.
* @return Result of the DeleteEmailIdentity operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @sample AmazonSimpleEmailServiceV2.DeleteEmailIdentity
* @see AWS API
* Documentation
*/
DeleteEmailIdentityResult deleteEmailIdentity(DeleteEmailIdentityRequest deleteEmailIdentityRequest);
/**
*
* Deletes the specified sending authorization policy for the given identity (an email address or a domain). This
* API returns successfully even if a policy with the specified name does not exist.
*
*
*
* This API is for the identity owner only. If you have not verified the identity, this API will return an error.
*
*
*
* Sending authorization is a feature that enables an identity owner to authorize other senders to use its
* identities. For information about using sending authorization, see the Amazon SES Developer
* Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param deleteEmailIdentityPolicyRequest
* Represents a request to delete a sending authorization policy for an identity. Sending authorization is an
* Amazon SES feature that enables you to authorize other senders to use your identities. For information,
* see the Amazon SES Developer Guide.
* @return Result of the DeleteEmailIdentityPolicy operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.DeleteEmailIdentityPolicy
* @see AWS API Documentation
*/
DeleteEmailIdentityPolicyResult deleteEmailIdentityPolicy(DeleteEmailIdentityPolicyRequest deleteEmailIdentityPolicyRequest);
/**
*
* Deletes an email template.
*
*
* You can execute this operation no more than once per second.
*
*
* @param deleteEmailTemplateRequest
* Represents a request to delete an email template. For more information, see the Amazon SES
* Developer Guide.
* @return Result of the DeleteEmailTemplate operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.DeleteEmailTemplate
* @see AWS API
* Documentation
*/
DeleteEmailTemplateResult deleteEmailTemplate(DeleteEmailTemplateRequest deleteEmailTemplateRequest);
/**
*
* Removes an email address from the suppression list for your account.
*
*
* @param deleteSuppressedDestinationRequest
* A request to remove an email address from the suppression list for your account.
* @return Result of the DeleteSuppressedDestination operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @sample AmazonSimpleEmailServiceV2.DeleteSuppressedDestination
* @see AWS API Documentation
*/
DeleteSuppressedDestinationResult deleteSuppressedDestination(DeleteSuppressedDestinationRequest deleteSuppressedDestinationRequest);
/**
*
* Obtain information about the email-sending status and capabilities of your Amazon SES account in the current
* Amazon Web Services Region.
*
*
* @param getAccountRequest
* A request to obtain information about the email-sending capabilities of your Amazon SES account.
* @return Result of the GetAccount operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.GetAccount
* @see AWS API
* Documentation
*/
GetAccountResult getAccount(GetAccountRequest getAccountRequest);
/**
*
* Retrieve a list of the blacklists that your dedicated IP addresses appear on.
*
*
* @param getBlacklistReportsRequest
* A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.
* @return Result of the GetBlacklistReports operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.GetBlacklistReports
* @see AWS API
* Documentation
*/
GetBlacklistReportsResult getBlacklistReports(GetBlacklistReportsRequest getBlacklistReportsRequest);
/**
*
* Get information about an existing configuration set, including the dedicated IP pool that it's associated with,
* whether or not it's enabled for sending email, and more.
*
*
* Configuration sets are groups of rules that you can apply to the emails you send. You apply a
* configuration set to an email by including a reference to the configuration set in the headers of the email. When
* you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
*
*
* @param getConfigurationSetRequest
* A request to obtain information about a configuration set.
* @return Result of the GetConfigurationSet operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.GetConfigurationSet
* @see AWS API
* Documentation
*/
GetConfigurationSetResult getConfigurationSet(GetConfigurationSetRequest getConfigurationSetRequest);
/**
*
* Retrieve a list of event destinations that are associated with a configuration set.
*
*
* Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event
* destinations are places that you can send information about these events to. For example, you can send event
* data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis
* Data Firehose to stream data to Amazon S3 for long-term storage.
*
*
* @param getConfigurationSetEventDestinationsRequest
* A request to obtain information about the event destinations for a configuration set.
* @return Result of the GetConfigurationSetEventDestinations operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.GetConfigurationSetEventDestinations
* @see AWS API Documentation
*/
GetConfigurationSetEventDestinationsResult getConfigurationSetEventDestinations(
GetConfigurationSetEventDestinationsRequest getConfigurationSetEventDestinationsRequest);
/**
*
* Returns a contact from a contact list.
*
*
* @param getContactRequest
* @return Result of the GetContact operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @sample AmazonSimpleEmailServiceV2.GetContact
* @see AWS API
* Documentation
*/
GetContactResult getContact(GetContactRequest getContactRequest);
/**
*
* Returns contact list metadata. It does not return any information about the contacts present in the list.
*
*
* @param getContactListRequest
* @return Result of the GetContactList operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.GetContactList
* @see AWS API
* Documentation
*/
GetContactListResult getContactList(GetContactListRequest getContactListRequest);
/**
*
* Returns the custom email verification template for the template name you specify.
*
*
* For more information about custom verification email templates, see Using Custom
* Verification Email Templates in the Amazon SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param getCustomVerificationEmailTemplateRequest
* Represents a request to retrieve an existing custom verification email template.
* @return Result of the GetCustomVerificationEmailTemplate operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.GetCustomVerificationEmailTemplate
* @see AWS API Documentation
*/
GetCustomVerificationEmailTemplateResult getCustomVerificationEmailTemplate(
GetCustomVerificationEmailTemplateRequest getCustomVerificationEmailTemplateRequest);
/**
*
* Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated
* with, as well information about the automatic warm-up process for the address.
*
*
* @param getDedicatedIpRequest
* A request to obtain more information about a dedicated IP address.
* @return Result of the GetDedicatedIp operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.GetDedicatedIp
* @see AWS API
* Documentation
*/
GetDedicatedIpResult getDedicatedIp(GetDedicatedIpRequest getDedicatedIpRequest);
/**
*
* List the dedicated IP addresses that are associated with your Amazon Web Services account.
*
*
* @param getDedicatedIpsRequest
* A request to obtain more information about dedicated IP pools.
* @return Result of the GetDedicatedIps operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.GetDedicatedIps
* @see AWS API
* Documentation
*/
GetDedicatedIpsResult getDedicatedIps(GetDedicatedIpsRequest getDedicatedIpsRequest);
/**
*
* Retrieve information about the status of the Deliverability dashboard for your account. When the Deliverability
* dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you
* use to send email. You also gain the ability to perform predictive inbox placement tests.
*
*
* When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees
* that you accrue by using Amazon SES and other Amazon Web Services services. For more information about the
* features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing.
*
*
* @param getDeliverabilityDashboardOptionsRequest
* Retrieve information about the status of the Deliverability dashboard for your Amazon Web Services
* account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and
* other metrics for your domains. You also gain the ability to perform predictive inbox placement tests.
*
* When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other
* fees that you accrue by using Amazon SES and other Amazon Web Services services. For more information
* about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
* @return Result of the GetDeliverabilityDashboardOptions operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.GetDeliverabilityDashboardOptions
* @see AWS API Documentation
*/
GetDeliverabilityDashboardOptionsResult getDeliverabilityDashboardOptions(GetDeliverabilityDashboardOptionsRequest getDeliverabilityDashboardOptionsRequest);
/**
*
* Retrieve the results of a predictive inbox placement test.
*
*
* @param getDeliverabilityTestReportRequest
* A request to retrieve the results of a predictive inbox placement test.
* @return Result of the GetDeliverabilityTestReport operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.GetDeliverabilityTestReport
* @see AWS API Documentation
*/
GetDeliverabilityTestReportResult getDeliverabilityTestReport(GetDeliverabilityTestReportRequest getDeliverabilityTestReportRequest);
/**
*
* Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the
* campaign sent email by using a domain that the Deliverability dashboard is enabled for.
*
*
* @param getDomainDeliverabilityCampaignRequest
* Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only
* if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (
* PutDeliverabilityDashboardOption operation).
* @return Result of the GetDomainDeliverabilityCampaign operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @sample AmazonSimpleEmailServiceV2.GetDomainDeliverabilityCampaign
* @see AWS API Documentation
*/
GetDomainDeliverabilityCampaignResult getDomainDeliverabilityCampaign(GetDomainDeliverabilityCampaignRequest getDomainDeliverabilityCampaignRequest);
/**
*
* Retrieve inbox placement and engagement rates for the domains that you use to send email.
*
*
* @param getDomainStatisticsReportRequest
* A request to obtain deliverability metrics for a domain.
* @return Result of the GetDomainStatisticsReport operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.GetDomainStatisticsReport
* @see AWS API Documentation
*/
GetDomainStatisticsReportResult getDomainStatisticsReport(GetDomainStatisticsReportRequest getDomainStatisticsReportRequest);
/**
*
* Provides information about a specific identity, including the identity's verification status, sending
* authorization policies, its DKIM authentication status, and its custom Mail-From settings.
*
*
* @param getEmailIdentityRequest
* A request to return details about an email identity.
* @return Result of the GetEmailIdentity operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.GetEmailIdentity
* @see AWS API
* Documentation
*/
GetEmailIdentityResult getEmailIdentity(GetEmailIdentityRequest getEmailIdentityRequest);
/**
*
* Returns the requested sending authorization policies for the given identity (an email address or a domain). The
* policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a
* time.
*
*
*
* This API is for the identity owner only. If you have not verified the identity, this API will return an error.
*
*
*
* Sending authorization is a feature that enables an identity owner to authorize other senders to use its
* identities. For information about using sending authorization, see the Amazon SES Developer
* Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param getEmailIdentityPoliciesRequest
* A request to return the policies of an email identity.
* @return Result of the GetEmailIdentityPolicies operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.GetEmailIdentityPolicies
* @see AWS
* API Documentation
*/
GetEmailIdentityPoliciesResult getEmailIdentityPolicies(GetEmailIdentityPoliciesRequest getEmailIdentityPoliciesRequest);
/**
*
* Displays the template object (which includes the subject line, HTML part and text part) for the template you
* specify.
*
*
* You can execute this operation no more than once per second.
*
*
* @param getEmailTemplateRequest
* Represents a request to display the template object (which includes the subject line, HTML part and text
* part) for the template you specify.
* @return Result of the GetEmailTemplate operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.GetEmailTemplate
* @see AWS API
* Documentation
*/
GetEmailTemplateResult getEmailTemplate(GetEmailTemplateRequest getEmailTemplateRequest);
/**
*
* Provides information about an import job.
*
*
* @param getImportJobRequest
* Represents a request for information about an import job using the import job ID.
* @return Result of the GetImportJob operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @sample AmazonSimpleEmailServiceV2.GetImportJob
* @see AWS API
* Documentation
*/
GetImportJobResult getImportJob(GetImportJobRequest getImportJobRequest);
/**
*
* Retrieves information about a specific email address that's on the suppression list for your account.
*
*
* @param getSuppressedDestinationRequest
* A request to retrieve information about an email address that's on the suppression list for your account.
* @return Result of the GetSuppressedDestination operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @sample AmazonSimpleEmailServiceV2.GetSuppressedDestination
* @see AWS
* API Documentation
*/
GetSuppressedDestinationResult getSuppressedDestination(GetSuppressedDestinationRequest getSuppressedDestinationRequest);
/**
*
* List all of the configuration sets associated with your account in the current region.
*
*
* Configuration sets are groups of rules that you can apply to the emails you send. You apply a
* configuration set to an email by including a reference to the configuration set in the headers of the email. When
* you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
*
*
* @param listConfigurationSetsRequest
* A request to obtain a list of configuration sets for your Amazon SES account in the current Amazon Web
* Services Region.
* @return Result of the ListConfigurationSets operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.ListConfigurationSets
* @see AWS
* API Documentation
*/
ListConfigurationSetsResult listConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest);
/**
*
* Lists all of the contact lists available.
*
*
* @param listContactListsRequest
* @return Result of the ListContactLists operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @sample AmazonSimpleEmailServiceV2.ListContactLists
* @see AWS API
* Documentation
*/
ListContactListsResult listContactLists(ListContactListsRequest listContactListsRequest);
/**
*
* Lists the contacts present in a specific contact list.
*
*
* @param listContactsRequest
* @return Result of the ListContacts operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @sample AmazonSimpleEmailServiceV2.ListContacts
* @see AWS API
* Documentation
*/
ListContactsResult listContacts(ListContactsRequest listContactsRequest);
/**
*
* Lists the existing custom verification email templates for your account in the current Amazon Web Services
* Region.
*
*
* For more information about custom verification email templates, see Using Custom
* Verification Email Templates in the Amazon SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param listCustomVerificationEmailTemplatesRequest
* Represents a request to list the existing custom verification email templates for your account.
* @return Result of the ListCustomVerificationEmailTemplates operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.ListCustomVerificationEmailTemplates
* @see AWS API Documentation
*/
ListCustomVerificationEmailTemplatesResult listCustomVerificationEmailTemplates(
ListCustomVerificationEmailTemplatesRequest listCustomVerificationEmailTemplatesRequest);
/**
*
* List all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region.
*
*
* @param listDedicatedIpPoolsRequest
* A request to obtain a list of dedicated IP pools.
* @return Result of the ListDedicatedIpPools operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.ListDedicatedIpPools
* @see AWS API
* Documentation
*/
ListDedicatedIpPoolsResult listDedicatedIpPools(ListDedicatedIpPoolsRequest listDedicatedIpPoolsRequest);
/**
*
* Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For
* predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport
* operation to view the results.
*
*
* @param listDeliverabilityTestReportsRequest
* A request to list all of the predictive inbox placement tests that you've performed.
* @return Result of the ListDeliverabilityTestReports operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.ListDeliverabilityTestReports
* @see AWS API Documentation
*/
ListDeliverabilityTestReportsResult listDeliverabilityTestReports(ListDeliverabilityTestReportsRequest listDeliverabilityTestReportsRequest);
/**
*
* Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified
* time range. This data is available for a domain only if you enabled the Deliverability dashboard for the domain.
*
*
* @param listDomainDeliverabilityCampaignsRequest
* Retrieve deliverability data for all the campaigns that used a specific domain to send email during a
* specified time range. This data is available for a domain only if you enabled the Deliverability
* dashboard.
* @return Result of the ListDomainDeliverabilityCampaigns operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @sample AmazonSimpleEmailServiceV2.ListDomainDeliverabilityCampaigns
* @see AWS API Documentation
*/
ListDomainDeliverabilityCampaignsResult listDomainDeliverabilityCampaigns(ListDomainDeliverabilityCampaignsRequest listDomainDeliverabilityCampaignsRequest);
/**
*
* Returns a list of all of the email identities that are associated with your Amazon Web Services account. An
* identity can be either an email address or a domain. This operation returns identities that are verified as well
* as those that aren't. This operation returns identities that are associated with Amazon SES and Amazon Pinpoint.
*
*
* @param listEmailIdentitiesRequest
* A request to list all of the email identities associated with your Amazon Web Services account. This list
* includes identities that you've already verified, identities that are unverified, and identities that were
* verified in the past, but are no longer verified.
* @return Result of the ListEmailIdentities operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.ListEmailIdentities
* @see AWS API
* Documentation
*/
ListEmailIdentitiesResult listEmailIdentities(ListEmailIdentitiesRequest listEmailIdentitiesRequest);
/**
*
* Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region.
*
*
* You can execute this operation no more than once per second.
*
*
* @param listEmailTemplatesRequest
* Represents a request to list the email templates present in your Amazon SES account in the current Amazon
* Web Services Region. For more information, see the Amazon SES
* Developer Guide.
* @return Result of the ListEmailTemplates operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.ListEmailTemplates
* @see AWS API
* Documentation
*/
ListEmailTemplatesResult listEmailTemplates(ListEmailTemplatesRequest listEmailTemplatesRequest);
/**
*
* Lists all of the import jobs.
*
*
* @param listImportJobsRequest
* Represents a request to list all of the import jobs for a data destination within the specified maximum
* number of import jobs.
* @return Result of the ListImportJobs operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.ListImportJobs
* @see AWS API
* Documentation
*/
ListImportJobsResult listImportJobs(ListImportJobsRequest listImportJobsRequest);
/**
*
* Retrieves a list of email addresses that are on the suppression list for your account.
*
*
* @param listSuppressedDestinationsRequest
* A request to obtain a list of email destinations that are on the suppression list for your account.
* @return Result of the ListSuppressedDestinations operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws InvalidNextTokenException
* The specified request includes an invalid or expired token.
* @sample AmazonSimpleEmailServiceV2.ListSuppressedDestinations
* @see AWS API Documentation
*/
ListSuppressedDestinationsResult listSuppressedDestinations(ListSuppressedDestinationsRequest listSuppressedDestinationsRequest);
/**
*
* Retrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a
* label that you optionally define and associate with a resource. Each tag consists of a required tag
* key and an optional associated tag value. A tag key is a general label that acts as a category for
* more specific tag values. A tag value acts as a descriptor within a tag key.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @sample AmazonSimpleEmailServiceV2.ListTagsForResource
* @see AWS API
* Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Enable or disable the automatic warm-up feature for dedicated IP addresses.
*
*
* @param putAccountDedicatedIpWarmupAttributesRequest
* A request to enable or disable the automatic IP address warm-up feature.
* @return Result of the PutAccountDedicatedIpWarmupAttributes operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.PutAccountDedicatedIpWarmupAttributes
* @see AWS API Documentation
*/
PutAccountDedicatedIpWarmupAttributesResult putAccountDedicatedIpWarmupAttributes(
PutAccountDedicatedIpWarmupAttributesRequest putAccountDedicatedIpWarmupAttributesRequest);
/**
*
* Update your Amazon SES account details.
*
*
* @param putAccountDetailsRequest
* A request to submit new account details.
* @return Result of the PutAccountDetails operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConflictException
* If there is already an ongoing account details update under review.
* @sample AmazonSimpleEmailServiceV2.PutAccountDetails
* @see AWS API
* Documentation
*/
PutAccountDetailsResult putAccountDetails(PutAccountDetailsRequest putAccountDetailsRequest);
/**
*
* Enable or disable the ability of your account to send email.
*
*
* @param putAccountSendingAttributesRequest
* A request to change the ability of your account to send email.
* @return Result of the PutAccountSendingAttributes operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.PutAccountSendingAttributes
* @see AWS API Documentation
*/
PutAccountSendingAttributesResult putAccountSendingAttributes(PutAccountSendingAttributesRequest putAccountSendingAttributesRequest);
/**
*
* Change the settings for the account-level suppression list.
*
*
* @param putAccountSuppressionAttributesRequest
* A request to change your account's suppression preferences.
* @return Result of the PutAccountSuppressionAttributes operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.PutAccountSuppressionAttributes
* @see AWS API Documentation
*/
PutAccountSuppressionAttributesResult putAccountSuppressionAttributes(PutAccountSuppressionAttributesRequest putAccountSuppressionAttributesRequest);
/**
*
* Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of
* dedicated IP addresses for sending specific types of email.
*
*
* @param putConfigurationSetDeliveryOptionsRequest
* A request to associate a configuration set with a dedicated IP pool.
* @return Result of the PutConfigurationSetDeliveryOptions operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.PutConfigurationSetDeliveryOptions
* @see AWS API Documentation
*/
PutConfigurationSetDeliveryOptionsResult putConfigurationSetDeliveryOptions(
PutConfigurationSetDeliveryOptionsRequest putConfigurationSetDeliveryOptionsRequest);
/**
*
* Enable or disable collection of reputation metrics for emails that you send using a particular configuration set
* in a specific Amazon Web Services Region.
*
*
* @param putConfigurationSetReputationOptionsRequest
* A request to enable or disable tracking of reputation metrics for a configuration set.
* @return Result of the PutConfigurationSetReputationOptions operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.PutConfigurationSetReputationOptions
* @see AWS API Documentation
*/
PutConfigurationSetReputationOptionsResult putConfigurationSetReputationOptions(
PutConfigurationSetReputationOptionsRequest putConfigurationSetReputationOptionsRequest);
/**
*
* Enable or disable email sending for messages that use a particular configuration set in a specific Amazon Web
* Services Region.
*
*
* @param putConfigurationSetSendingOptionsRequest
* A request to enable or disable the ability of Amazon SES to send emails that use a specific configuration
* set.
* @return Result of the PutConfigurationSetSendingOptions operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.PutConfigurationSetSendingOptions
* @see AWS API Documentation
*/
PutConfigurationSetSendingOptionsResult putConfigurationSetSendingOptions(PutConfigurationSetSendingOptionsRequest putConfigurationSetSendingOptionsRequest);
/**
*
* Specify the account suppression list preferences for a configuration set.
*
*
* @param putConfigurationSetSuppressionOptionsRequest
* A request to change the account suppression list preferences for a specific configuration set.
* @return Result of the PutConfigurationSetSuppressionOptions operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.PutConfigurationSetSuppressionOptions
* @see AWS API Documentation
*/
PutConfigurationSetSuppressionOptionsResult putConfigurationSetSuppressionOptions(
PutConfigurationSetSuppressionOptionsRequest putConfigurationSetSuppressionOptionsRequest);
/**
*
* Specify a custom domain to use for open and click tracking elements in email that you send.
*
*
* @param putConfigurationSetTrackingOptionsRequest
* A request to add a custom domain for tracking open and click events to a configuration set.
* @return Result of the PutConfigurationSetTrackingOptions operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.PutConfigurationSetTrackingOptions
* @see AWS API Documentation
*/
PutConfigurationSetTrackingOptionsResult putConfigurationSetTrackingOptions(
PutConfigurationSetTrackingOptionsRequest putConfigurationSetTrackingOptionsRequest);
/**
*
* Move a dedicated IP address to an existing dedicated IP pool.
*
*
*
* The dedicated IP address that you specify must already exist, and must be associated with your Amazon Web
* Services account.
*
*
* The dedicated IP pool you specify must already exist. You can create a new pool by using the
* CreateDedicatedIpPool operation.
*
*
*
* @param putDedicatedIpInPoolRequest
* A request to move a dedicated IP address to a dedicated IP pool.
* @return Result of the PutDedicatedIpInPool operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.PutDedicatedIpInPool
* @see AWS API
* Documentation
*/
PutDedicatedIpInPoolResult putDedicatedIpInPool(PutDedicatedIpInPoolRequest putDedicatedIpInPoolRequest);
/**
*
*
* @param putDedicatedIpWarmupAttributesRequest
* A request to change the warm-up attributes for a dedicated IP address. This operation is useful when you
* want to resume the warm-up process for an existing IP address.
* @return Result of the PutDedicatedIpWarmupAttributes operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.PutDedicatedIpWarmupAttributes
* @see AWS API Documentation
*/
PutDedicatedIpWarmupAttributesResult putDedicatedIpWarmupAttributes(PutDedicatedIpWarmupAttributesRequest putDedicatedIpWarmupAttributesRequest);
/**
*
* Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to
* reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the
* ability to perform predictive inbox placement tests.
*
*
* When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees
* that you accrue by using Amazon SES and other Amazon Web Services services. For more information about the
* features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing.
*
*
* @param putDeliverabilityDashboardOptionRequest
* Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain
* access to reputation, deliverability, and other metrics for the domains that you use to send email using
* Amazon SES API v2. You also gain the ability to perform predictive inbox placement tests.
*
* When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other
* fees that you accrue by using Amazon SES and other Amazon Web Services services. For more information
* about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
* @return Result of the PutDeliverabilityDashboardOption operation returned by the service.
* @throws AlreadyExistsException
* The resource specified in your request already exists.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.PutDeliverabilityDashboardOption
* @see AWS API Documentation
*/
PutDeliverabilityDashboardOptionResult putDeliverabilityDashboardOption(PutDeliverabilityDashboardOptionRequest putDeliverabilityDashboardOptionRequest);
/**
*
* Used to associate a configuration set with an email identity.
*
*
* @param putEmailIdentityConfigurationSetAttributesRequest
* A request to associate a configuration set with an email identity.
* @return Result of the PutEmailIdentityConfigurationSetAttributes operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.PutEmailIdentityConfigurationSetAttributes
* @see AWS API Documentation
*/
PutEmailIdentityConfigurationSetAttributesResult putEmailIdentityConfigurationSetAttributes(
PutEmailIdentityConfigurationSetAttributesRequest putEmailIdentityConfigurationSetAttributesRequest);
/**
*
* Used to enable or disable DKIM authentication for an email identity.
*
*
* @param putEmailIdentityDkimAttributesRequest
* A request to enable or disable DKIM signing of email that you send from an email identity.
* @return Result of the PutEmailIdentityDkimAttributes operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.PutEmailIdentityDkimAttributes
* @see AWS API Documentation
*/
PutEmailIdentityDkimAttributesResult putEmailIdentityDkimAttributes(PutEmailIdentityDkimAttributesRequest putEmailIdentityDkimAttributesRequest);
/**
*
* Used to configure or change the DKIM authentication settings for an email domain identity. You can use this
* operation to do any of the following:
*
*
* -
*
* Update the signing attributes for an identity that uses Bring Your Own DKIM (BYODKIM).
*
*
* -
*
* Update the key length that should be used for Easy DKIM.
*
*
* -
*
* Change from using no DKIM authentication to using Easy DKIM.
*
*
* -
*
* Change from using no DKIM authentication to using BYODKIM.
*
*
* -
*
* Change from using Easy DKIM to using BYODKIM.
*
*
* -
*
* Change from using BYODKIM to using Easy DKIM.
*
*
*
*
* @param putEmailIdentityDkimSigningAttributesRequest
* A request to change the DKIM attributes for an email identity.
* @return Result of the PutEmailIdentityDkimSigningAttributes operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.PutEmailIdentityDkimSigningAttributes
* @see AWS API Documentation
*/
PutEmailIdentityDkimSigningAttributesResult putEmailIdentityDkimSigningAttributes(
PutEmailIdentityDkimSigningAttributesRequest putEmailIdentityDkimSigningAttributesRequest);
/**
*
* Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an
* identity is used to send an email that results in a bounce or complaint event.
*
*
* If the value is true, you receive email notifications when bounce or complaint events occur. These
* notifications are sent to the address that you specified in the Return-Path header of the original
* email.
*
*
* You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for
* receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an
* email notification when these events occur (even if this setting is disabled).
*
*
* @param putEmailIdentityFeedbackAttributesRequest
* A request to set the attributes that control how bounce and complaint events are processed.
* @return Result of the PutEmailIdentityFeedbackAttributes operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.PutEmailIdentityFeedbackAttributes
* @see AWS API Documentation
*/
PutEmailIdentityFeedbackAttributesResult putEmailIdentityFeedbackAttributes(
PutEmailIdentityFeedbackAttributesRequest putEmailIdentityFeedbackAttributesRequest);
/**
*
* Used to enable or disable the custom Mail-From domain configuration for an email identity.
*
*
* @param putEmailIdentityMailFromAttributesRequest
* A request to configure the custom MAIL FROM domain for a verified identity.
* @return Result of the PutEmailIdentityMailFromAttributes operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.PutEmailIdentityMailFromAttributes
* @see AWS API Documentation
*/
PutEmailIdentityMailFromAttributesResult putEmailIdentityMailFromAttributes(
PutEmailIdentityMailFromAttributesRequest putEmailIdentityMailFromAttributesRequest);
/**
*
* Adds an email address to the suppression list for your account.
*
*
* @param putSuppressedDestinationRequest
* A request to add an email destination to the suppression list for your account.
* @return Result of the PutSuppressedDestination operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @sample AmazonSimpleEmailServiceV2.PutSuppressedDestination
* @see AWS
* API Documentation
*/
PutSuppressedDestinationResult putSuppressedDestination(PutSuppressedDestinationRequest putSuppressedDestinationRequest);
/**
*
* Composes an email message to multiple destinations.
*
*
* @param sendBulkEmailRequest
* Represents a request to send email messages to multiple destinations using Amazon SES. For more
* information, see the Amazon SES
* Developer Guide.
* @return Result of the SendBulkEmail operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws AccountSuspendedException
* The message can't be sent because the account's ability to send email has been permanently restricted.
* @throws SendingPausedException
* The message can't be sent because the account's ability to send email is currently paused.
* @throws MessageRejectedException
* The message can't be sent because it contains invalid content.
* @throws MailFromDomainNotVerifiedException
* The message can't be sent because the sending domain isn't verified.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.SendBulkEmail
* @see AWS API
* Documentation
*/
SendBulkEmailResult sendBulkEmail(SendBulkEmailRequest sendBulkEmailRequest);
/**
*
* Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services
* Region and attempts to verify it. As a result of executing this operation, a customized verification email is
* sent to the specified address.
*
*
* To use this operation, you must first create a custom verification email template. For more information about
* creating and using custom verification email templates, see Using Custom
* Verification Email Templates in the Amazon SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param sendCustomVerificationEmailRequest
* Represents a request to send a custom verification email to a specified recipient.
* @return Result of the SendCustomVerificationEmail operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws MessageRejectedException
* The message can't be sent because it contains invalid content.
* @throws SendingPausedException
* The message can't be sent because the account's ability to send email is currently paused.
* @throws MailFromDomainNotVerifiedException
* The message can't be sent because the sending domain isn't verified.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.SendCustomVerificationEmail
* @see AWS API Documentation
*/
SendCustomVerificationEmailResult sendCustomVerificationEmail(SendCustomVerificationEmailRequest sendCustomVerificationEmailRequest);
/**
*
* Sends an email message. You can use the Amazon SES API v2 to send the following types of messages:
*
*
* -
*
* Simple – A standard email message. When you create this type of message, you specify the sender, the
* recipient, and the message body, and Amazon SES assembles the message for you.
*
*
* -
*
* Raw – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of
* the message headers, as well as the message body. You can use this message type to send messages that contain
* attachments. The message that you specify has to be a valid MIME message.
*
*
* -
*
* Templated – A message that contains personalization tags. When you send this type of email, Amazon SES API
* v2 automatically replaces the tags with values that you specify.
*
*
*
*
* @param sendEmailRequest
* Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES
* Developer Guide.
* @return Result of the SendEmail operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws AccountSuspendedException
* The message can't be sent because the account's ability to send email has been permanently restricted.
* @throws SendingPausedException
* The message can't be sent because the account's ability to send email is currently paused.
* @throws MessageRejectedException
* The message can't be sent because it contains invalid content.
* @throws MailFromDomainNotVerifiedException
* The message can't be sent because the sending domain isn't verified.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.SendEmail
* @see AWS API
* Documentation
*/
SendEmailResult sendEmail(SendEmailRequest sendEmailRequest);
/**
*
* Add one or more tags (keys and values) to a specified resource. A tag is a label that you optionally
* define and associate with a resource. Tags can help you categorize and manage resources in different ways, such
* as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.
*
*
* Each tag consists of a required tag key and an associated tag value, both of which you define. A
* tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor
* within a tag key.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @sample AmazonSimpleEmailServiceV2.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.
*
*
* You can execute this operation no more than once per second.
*
*
* @param testRenderEmailTemplateRequest
* >Represents a request to create a preview of the MIME content of an email when provided with a template
* and a set of replacement data.
* @return Result of the TestRenderEmailTemplate operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.TestRenderEmailTemplate
* @see AWS
* API Documentation
*/
TestRenderEmailTemplateResult testRenderEmailTemplate(TestRenderEmailTemplateRequest testRenderEmailTemplateRequest);
/**
*
* Remove one or more tags (keys and values) from a specified resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @sample AmazonSimpleEmailServiceV2.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Update the configuration of an event destination for a configuration set.
*
*
* Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event
* destinations are places that you can send information about these events to. For example, you can send event
* data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis
* Data Firehose to stream data to Amazon S3 for long-term storage.
*
*
* @param updateConfigurationSetEventDestinationRequest
* A request to change the settings for an event destination for a configuration set.
* @return Result of the UpdateConfigurationSetEventDestination operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.UpdateConfigurationSetEventDestination
* @see AWS API Documentation
*/
UpdateConfigurationSetEventDestinationResult updateConfigurationSetEventDestination(
UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest);
/**
*
* Updates a contact's preferences for a list. It is not necessary to specify all existing topic preferences in the
* TopicPreferences object, just the ones that need updating.
*
*
* @param updateContactRequest
* @return Result of the UpdateContact operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @sample AmazonSimpleEmailServiceV2.UpdateContact
* @see AWS API
* Documentation
*/
UpdateContactResult updateContact(UpdateContactRequest updateContactRequest);
/**
*
* Updates contact list metadata. This operation does a complete replacement.
*
*
* @param updateContactListRequest
* @return Result of the UpdateContactList operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @sample AmazonSimpleEmailServiceV2.UpdateContactList
* @see AWS API
* Documentation
*/
UpdateContactListResult updateContactList(UpdateContactListRequest updateContactListRequest);
/**
*
* Updates an existing custom verification email template.
*
*
* For more information about custom verification email templates, see Using Custom
* Verification Email Templates in the Amazon SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param updateCustomVerificationEmailTemplateRequest
* Represents a request to update an existing custom verification email template.
* @return Result of the UpdateCustomVerificationEmailTemplate operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @sample AmazonSimpleEmailServiceV2.UpdateCustomVerificationEmailTemplate
* @see AWS API Documentation
*/
UpdateCustomVerificationEmailTemplateResult updateCustomVerificationEmailTemplate(
UpdateCustomVerificationEmailTemplateRequest updateCustomVerificationEmailTemplateRequest);
/**
*
* Updates the specified sending authorization policy for the given identity (an email address or a domain). This
* API returns successfully even if a policy with the specified name does not exist.
*
*
*
* This API is for the identity owner only. If you have not verified the identity, this API will return an error.
*
*
*
* Sending authorization is a feature that enables an identity owner to authorize other senders to use its
* identities. For information about using sending authorization, see the Amazon SES Developer
* Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param updateEmailIdentityPolicyRequest
* Represents a request to update a sending authorization policy for an identity. Sending authorization is an
* Amazon SES feature that enables you to authorize other senders to use your identities. For information,
* see the Amazon SES Developer Guide.
* @return Result of the UpdateEmailIdentityPolicy operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.UpdateEmailIdentityPolicy
* @see AWS API Documentation
*/
UpdateEmailIdentityPolicyResult updateEmailIdentityPolicy(UpdateEmailIdentityPolicyRequest updateEmailIdentityPolicyRequest);
/**
*
* Updates an email template. Email templates enable you to send personalized email to one or more destinations in a
* single API operation. For more information, see the Amazon SES
* Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param updateEmailTemplateRequest
* Represents a request to update an email template. For more information, see the Amazon SES
* Developer Guide.
* @return Result of the UpdateEmailTemplate operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @sample AmazonSimpleEmailServiceV2.UpdateEmailTemplate
* @see AWS API
* Documentation
*/
UpdateEmailTemplateResult updateEmailTemplate(UpdateEmailTemplateRequest updateEmailTemplateRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}