openapi: 3.2.0 info: version: 2019-09-27 x-release: v4 title: Amazon Simple Service Email API description: 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.

x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: sesv2 x-aws-signingName: ses x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/sesv2-2019-09-27.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://email.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon SES V2 multi-region endpoint - url: https://email.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon SES V2 multi-region endpoint - url: http://email.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon SES V2 endpoint for China (Beijing) and China (Ningxia) - url: https://email.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon SES V2 endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Email paths: /v2/email/metrics/batch: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: BatchGetMetricData description:

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

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

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BatchGetMetricDataResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - Queries properties: Queries: description: A list of queries for metrics to be retrieved. type: array items: $ref: '#/components/schemas/BatchGetMetricDataQuery' minItems: 1 maxItems: 10 tags: - Email /v2/email/configuration-sets: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateConfigurationSet description: '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. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateConfigurationSetResponse' '480': description: AlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/AlreadyExistsException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '483': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '484': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '485': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - ConfigurationSetName properties: ConfigurationSetName: description:

The name of a 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.

type: string TrackingOptions: description:

An object that defines the tracking options for a configuration set. When you use the Amazon SES API v2 to send an email, it contains an invisible image that's used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them.

These images and links include references to a domain operated by Amazon Web Services. You can optionally configure the Amazon SES to use a domain that you operate for these images and links.

type: object properties: CustomRedirectDomain: allOf: - $ref: '#/components/schemas/CustomRedirectDomain' - description: The domain to use for tracking open and click events. DeliveryOptions: description: Used to associate a configuration set with a dedicated IP pool. type: object properties: TlsPolicy: allOf: - $ref: '#/components/schemas/TlsPolicy' - description: Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established. SendingPoolName: allOf: - $ref: '#/components/schemas/PoolName' - description: The name of the dedicated IP pool to associate with the configuration set. ReputationOptions: description: 'Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current Amazon Web Services Region. ' type: object properties: ReputationMetricsEnabled: allOf: - $ref: '#/components/schemas/Enabled' - description: If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set. LastFreshStart: allOf: - $ref: '#/components/schemas/LastFreshStart' - description: The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start. SendingOptions: description: Used to enable or disable email sending for messages that use this configuration set in the current Amazon Web Services Region. type: object properties: SendingEnabled: allOf: - $ref: '#/components/schemas/Enabled' - description: If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set. Tags: description: An array of objects that define the tags (keys and values) to associate with the configuration set. type: array items: $ref: '#/components/schemas/Tag' SuppressionOptions: description: An object that contains information about the suppression list preferences for your account. type: object properties: SuppressedReasons: allOf: - $ref: '#/components/schemas/SuppressionListReasons' - description:

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

VdmOptions: description: An object that defines the VDM settings that apply to emails that you send using the configuration set. type: object properties: DashboardOptions: allOf: - $ref: '#/components/schemas/DashboardOptions' - description: Specifies additional settings for your VDM configuration as applicable to the Dashboard. GuardianOptions: allOf: - $ref: '#/components/schemas/GuardianOptions' - description: Specifies additional settings for your VDM configuration as applicable to the Guardian. tags: - Email get: operationId: ListConfigurationSets description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListConfigurationSetsResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: NextToken in: query required: false description: A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets. schema: type: string - name: PageSize in: query required: false description: The number of results to show in a single call to ListConfigurationSets. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results. schema: type: integer tags: - Email /v2/email/configuration-sets/{ConfigurationSetName}/event-destinations: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateConfigurationSetEventDestination description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateConfigurationSetEventDestinationResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: AlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/AlreadyExistsException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '484': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: ConfigurationSetName in: path required: true description: The name of the configuration set . schema: type: string description:

The name of a 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.

requestBody: required: true content: application/json: schema: type: object required: - EventDestinationName - EventDestination properties: EventDestinationName: description:

The name of 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.

type: string EventDestination: description: An object that defines the event destination. Specifically, it defines which services receive events from emails sent using the configuration set that the event destination is associated with. Also defines the types of events that are sent to the event destination. type: object properties: Enabled: allOf: - $ref: '#/components/schemas/Enabled' - description:

If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition.

If false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.

MatchingEventTypes: allOf: - $ref: '#/components/schemas/EventTypes' - description: An array that specifies which events the Amazon SES API v2 should send to the destinations in this EventDestinationDefinition. KinesisFirehoseDestination: allOf: - $ref: '#/components/schemas/KinesisFirehoseDestination' - description: An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift. CloudWatchDestination: allOf: - $ref: '#/components/schemas/CloudWatchDestination' - description: An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics. SnsDestination: allOf: - $ref: '#/components/schemas/SnsDestination' - description: An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur. PinpointDestination: allOf: - $ref: '#/components/schemas/PinpointDestination' - description: An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide. tags: - Email get: operationId: GetConfigurationSetEventDestinations description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetConfigurationSetEventDestinationsResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: ConfigurationSetName in: path required: true description: The name of the configuration set that contains the event destination. schema: type: string description:

The name of a 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.

tags: - Email /v2/email/contact-lists/{ContactListName}/contacts: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateContact description: Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateContactResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: AlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/AlreadyExistsException' parameters: - name: ContactListName in: path required: true description: The name of the contact list to which the contact should be added. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - EmailAddress properties: EmailAddress: description: The contact's email address. type: string TopicPreferences: description: The contact's preferences for being opted-in to or opted-out of topics. type: array items: $ref: '#/components/schemas/TopicPreference' UnsubscribeAll: description: A boolean value status noting if the contact is unsubscribed from all contact list topics. type: boolean AttributesData: description: The attribute data attached to a contact. type: string tags: - Email get: operationId: ListContacts description: Lists the contacts present in a specific contact list. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListContactsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' parameters: - name: ContactListName in: path required: true description: The name of the contact list. schema: type: string - name: PageSize in: query required: false description: The number of contacts that may be returned at once, which is dependent on if there are more or less contacts than the value of the PageSize. Use this parameter to paginate results. If additional contacts exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional contacts. schema: type: integer - name: NextToken in: query required: false description: A string token indicating that there might be additional contacts available to be listed. Use the token provided in the Response to use in the subsequent call to ListContacts with the same parameters to retrieve the next page of contacts. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: Filter: description: A filter that can be applied to a list of contacts. type: object properties: FilteredStatus: allOf: - $ref: '#/components/schemas/SubscriptionStatus' - description: 'The status by which you are filtering: OPT_IN or OPT_OUT.' TopicFilter: allOf: - $ref: '#/components/schemas/TopicFilter' - description: Used for filtering by a specific topic preference. tags: - Email /v2/email/contact-lists: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateContactList description: Creates a contact list. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateContactListResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: AlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/AlreadyExistsException' '483': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - ContactListName properties: ContactListName: description: The name of the contact list. type: string Topics: description: An interest group, theme, or label within a list. A contact list can have multiple topics. type: array items: $ref: '#/components/schemas/Topic' Description: description: A description of what the contact list is about. type: string Tags: description: The tags associated with a contact list. type: array items: $ref: '#/components/schemas/Tag' tags: - Email get: operationId: ListContactLists description: Lists all of the contact lists available. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListContactListsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: PageSize in: query required: false description: Maximum number of contact lists to return at once. Use this parameter to paginate results. If additional contact lists exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional lists. schema: type: integer - name: NextToken in: query required: false description: A string token indicating that there might be additional contact lists available to be listed. Use the token provided in the Response to use in the subsequent call to ListContactLists with the same parameters to retrieve the next page of contact lists. schema: type: string tags: - Email /v2/email/custom-verification-email-templates: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateCustomVerificationEmailTemplate description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateCustomVerificationEmailTemplateResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: AlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/AlreadyExistsException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '484': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - TemplateName - FromEmailAddress - TemplateSubject - TemplateContent - SuccessRedirectionURL - FailureRedirectionURL properties: TemplateName: description: The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations. type: string minLength: 1 FromEmailAddress: description: The email address that the custom verification email is sent from. type: string TemplateSubject: description: The subject line of the email. type: string TemplateContent: description: The content of the custom verification email template. type: string SuccessRedirectionURL: description: The URL that the recipient of the verification email is sent to if his or her address is successfully verified. type: string FailureRedirectionURL: description: The URL that the recipient of the verification email is sent to if his or her address is not successfully verified. type: string tags: - Email get: operationId: ListCustomVerificationEmailTemplates description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListCustomVerificationEmailTemplatesResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: NextToken in: query required: false description: A token returned from a previous call to ListCustomVerificationEmailTemplates to indicate the position in the list of custom verification email templates. schema: type: string - name: PageSize in: query required: false description:

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

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

schema: type: integer tags: - Email /v2/email/dedicated-ip-pools: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateDedicatedIpPool description: 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. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateDedicatedIpPoolResponse' '480': description: AlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/AlreadyExistsException' '481': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '483': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '484': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - PoolName properties: PoolName: description: The name of a dedicated IP pool. type: string Tags: description: An object that defines the tags (keys and values) that you want to associate with the pool. type: array items: $ref: '#/components/schemas/Tag' ScalingMode: description: The type of scaling mode. type: string enum: - STANDARD - MANAGED tags: - Email get: operationId: ListDedicatedIpPools description: List all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListDedicatedIpPoolsResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: NextToken in: query required: false description: A token returned from a previous call to ListDedicatedIpPools to indicate the position in the list of dedicated IP pools. schema: type: string - name: PageSize in: query required: false description: The number of results to show in a single call to ListDedicatedIpPools. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results. schema: type: integer tags: - Email /v2/email/deliverability-dashboard/test: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateDeliverabilityTestReport description: 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. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateDeliverabilityTestReportResponse' '480': description: AccountSuspendedException content: application/json: schema: $ref: '#/components/schemas/AccountSuspendedException' '481': description: SendingPausedException content: application/json: schema: $ref: '#/components/schemas/SendingPausedException' '482': description: MessageRejected content: application/json: schema: $ref: '#/components/schemas/MessageRejected' '483': description: MailFromDomainNotVerifiedException content: application/json: schema: $ref: '#/components/schemas/MailFromDomainNotVerifiedException' '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '486': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '487': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '488': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - FromEmailAddress - Content properties: ReportName: description: A name that helps you identify a report generated by the Deliverability dashboard. type: string FromEmailAddress: description: The email address that the predictive inbox placement test email was sent from. type: string Content: description: An object that defines the entire content of the email, including the message headers and the body content. You can create a simple email message, in which you specify the subject and the text and HTML versions of the message body. You can also create raw messages, in which you specify a complete MIME-formatted message. Raw messages can include attachments and custom headers. type: object properties: Simple: allOf: - $ref: '#/components/schemas/Message' - description: The simple email message. The message consists of a subject and a message body. Raw: allOf: - $ref: '#/components/schemas/RawMessage' - description:

The raw email message. The message has to meet the following criteria:

Template: allOf: - $ref: '#/components/schemas/Template' - description: The template to use for the email message. Tags: description: An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test. type: array items: $ref: '#/components/schemas/Tag' tags: - Email /v2/email/identities: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateEmailIdentity description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateEmailIdentityResponse' '480': description: AlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/AlreadyExistsException' '481': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '483': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '484': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' '485': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - EmailIdentity properties: EmailIdentity: description: The email address or domain to verify. type: string minLength: 1 Tags: description: An array of objects that define the tags (keys and values) to associate with the email identity. type: array items: $ref: '#/components/schemas/Tag' DkimSigningAttributes: description: An object that contains configuration for Bring Your Own DKIM (BYODKIM), or, for Easy DKIM type: object properties: DomainSigningSelector: allOf: - $ref: '#/components/schemas/Selector' - description: '[Bring Your Own DKIM] A string that''s used to identify a public key in the DNS configuration for a domain.' DomainSigningPrivateKey: allOf: - $ref: '#/components/schemas/PrivateKey' - description:

[Bring Your Own DKIM] A private key that's used to generate a DKIM signature.

The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding.

NextSigningKeyLength: allOf: - $ref: '#/components/schemas/DkimSigningKeyLength' - description: '[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.' ConfigurationSetName: description:

The name of a 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.

type: string tags: - Email get: operationId: ListEmailIdentities description: 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. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListEmailIdentitiesResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: NextToken in: query required: false description: A token returned from a previous call to ListEmailIdentities to indicate the position in the list of identities. schema: type: string - name: PageSize in: query required: false description:

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

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

schema: type: integer tags: - Email /v2/email/identities/{EmailIdentity}/policies/{PolicyName}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateEmailIdentityPolicy description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateEmailIdentityPolicyResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: AlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/AlreadyExistsException' '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '483': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '484': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: EmailIdentity in: path required: true description: The email identity. schema: type: string minLength: 1 - name: PolicyName in: path required: true description:

The name of the policy.

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

schema: type: string description:

The name of the policy.

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

minLength: 1 maxLength: 64 requestBody: required: true content: application/json: schema: type: object required: - Policy properties: Policy: description:

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

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

type: string minLength: 1 tags: - Email delete: operationId: DeleteEmailIdentityPolicy description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteEmailIdentityPolicyResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: EmailIdentity in: path required: true description: The email identity. schema: type: string minLength: 1 - name: PolicyName in: path required: true description:

The name of the policy.

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

schema: type: string description:

The name of the policy.

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

minLength: 1 maxLength: 64 tags: - Email put: operationId: UpdateEmailIdentityPolicy description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateEmailIdentityPolicyResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: EmailIdentity in: path required: true description: The email identity. schema: type: string minLength: 1 - name: PolicyName in: path required: true description:

The name of the policy.

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

schema: type: string description:

The name of the policy.

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

minLength: 1 maxLength: 64 requestBody: required: true content: application/json: schema: type: object required: - Policy properties: Policy: description:

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

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

type: string minLength: 1 tags: - Email /v2/email/templates: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateEmailTemplate description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateEmailTemplateResponse' '480': description: AlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/AlreadyExistsException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '483': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - TemplateName - TemplateContent properties: TemplateName: description: The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations. type: string minLength: 1 TemplateContent: description: The content of the email, composed of a subject line, an HTML part, and a text-only part. type: object properties: Subject: allOf: - $ref: '#/components/schemas/EmailTemplateSubject' - description: The subject line of the email. Text: allOf: - $ref: '#/components/schemas/EmailTemplateText' - description: The email body that will be visible to recipients whose email clients do not display HTML. Html: allOf: - $ref: '#/components/schemas/EmailTemplateHtml' - description: The HTML body of the email. tags: - Email get: operationId: ListEmailTemplates description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListEmailTemplatesResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: NextToken in: query required: false description: A token returned from a previous call to ListEmailTemplates to indicate the position in the list of email templates. schema: type: string - name: PageSize in: query required: false description:

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

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

schema: type: integer tags: - Email /v2/email/import-jobs: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateImportJob description: Creates an import job for a data destination. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateImportJobResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - ImportDestination - ImportDataSource properties: ImportDestination: description: An object that contains details about the resource destination the import job is going to target. type: object properties: SuppressionListDestination: allOf: - $ref: '#/components/schemas/SuppressionListDestination' - description: An object that contains the action of the import job towards suppression list. ContactListDestination: allOf: - $ref: '#/components/schemas/ContactListDestination' - description: An object that contains the action of the import job towards a contact list. ImportDataSource: description: An object that contains details about the data source of the import job. type: object properties: S3Url: allOf: - $ref: '#/components/schemas/S3Url' - description: An Amazon S3 URL in the format s3://<bucket_name>/<object>. DataFormat: allOf: - $ref: '#/components/schemas/DataFormat' - description: The data format of the import job's data source. tags: - Email get: operationId: ListImportJobs description: Lists all of the import jobs. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListImportJobsResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: NextToken in: query required: false description: A string token indicating that there might be additional import jobs available to be listed. Copy this token to a subsequent call to ListImportJobs with the same parameters to retrieve the next page of import jobs. schema: type: string - name: PageSize in: query required: false description: Maximum number of import jobs to return at once. Use this parameter to paginate results. If additional import jobs exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional addresses. schema: type: integer requestBody: required: true content: application/json: schema: type: object properties: ImportDestinationType: description: The destination of the import job, which can be used to list import jobs that have a certain ImportDestinationType. type: string enum: - SUPPRESSION_LIST - CONTACT_LIST tags: - Email /v2/email/configuration-sets/{ConfigurationSetName}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteConfigurationSet description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteConfigurationSetResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '483': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' parameters: - name: ConfigurationSetName in: path required: true description: The name of the configuration set. schema: type: string description:

The name of a 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.

tags: - Email get: operationId: GetConfigurationSet description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetConfigurationSetResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: ConfigurationSetName in: path required: true description: The name of the configuration set. schema: type: string description:

The name of a 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.

tags: - Email /v2/email/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteConfigurationSetEventDestination description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteConfigurationSetEventDestinationResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: ConfigurationSetName in: path required: true description: The name of the configuration set that contains the event destination to delete. schema: type: string description:

The name of a 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.

- name: EventDestinationName in: path required: true description: The name of the event destination to delete. schema: type: string description:

The name of 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.

tags: - Email put: operationId: UpdateConfigurationSetEventDestination description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateConfigurationSetEventDestinationResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: ConfigurationSetName in: path required: true description: The name of the configuration set that contains the event destination to modify. schema: type: string description:

The name of a 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.

- name: EventDestinationName in: path required: true description: The name of the event destination. schema: type: string description:

The name of 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.

requestBody: required: true content: application/json: schema: type: object required: - EventDestination properties: EventDestination: description: An object that defines the event destination. Specifically, it defines which services receive events from emails sent using the configuration set that the event destination is associated with. Also defines the types of events that are sent to the event destination. type: object properties: Enabled: allOf: - $ref: '#/components/schemas/Enabled' - description:

If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition.

If false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.

MatchingEventTypes: allOf: - $ref: '#/components/schemas/EventTypes' - description: An array that specifies which events the Amazon SES API v2 should send to the destinations in this EventDestinationDefinition. KinesisFirehoseDestination: allOf: - $ref: '#/components/schemas/KinesisFirehoseDestination' - description: An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift. CloudWatchDestination: allOf: - $ref: '#/components/schemas/CloudWatchDestination' - description: An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics. SnsDestination: allOf: - $ref: '#/components/schemas/SnsDestination' - description: An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur. PinpointDestination: allOf: - $ref: '#/components/schemas/PinpointDestination' - description: An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide. tags: - Email /v2/email/contact-lists/{ContactListName}/contacts/{EmailAddress}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteContact description: Removes a contact from a contact list. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteContactResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' parameters: - name: ContactListName in: path required: true description: The name of the contact list from which the contact should be removed. schema: type: string - name: EmailAddress in: path required: true description: The contact's email address. schema: type: string tags: - Email get: operationId: GetContact description: Returns a contact from a contact list. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetContactResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' parameters: - name: ContactListName in: path required: true description: The name of the contact list to which the contact belongs. schema: type: string - name: EmailAddress in: path required: true description: The contact's email addres. schema: type: string tags: - Email put: operationId: UpdateContact description: 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. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateContactResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' parameters: - name: ContactListName in: path required: true description: The name of the contact list. schema: type: string - name: EmailAddress in: path required: true description: The contact's email addres. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: TopicPreferences: description: The contact's preference for being opted-in to or opted-out of a topic. type: array items: $ref: '#/components/schemas/TopicPreference' UnsubscribeAll: description: A boolean value status noting if the contact is unsubscribed from all contact list topics. type: boolean AttributesData: description: The attribute data attached to a contact. type: string tags: - Email /v2/email/contact-lists/{ContactListName}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteContactList description: Deletes a contact list and all of the contacts on that list. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteContactListResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '483': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' parameters: - name: ContactListName in: path required: true description: The name of the contact list. schema: type: string tags: - Email get: operationId: GetContactList description: Returns contact list metadata. It does not return any information about the contacts present in the list. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetContactListResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: ContactListName in: path required: true description: The name of the contact list. schema: type: string tags: - Email put: operationId: UpdateContactList description: Updates contact list metadata. This operation does a complete replacement. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateContactListResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' parameters: - name: ContactListName in: path required: true description: The name of the contact list. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: Topics: description: An interest group, theme, or label within a list. A contact list can have multiple topics. type: array items: $ref: '#/components/schemas/Topic' Description: description: A description of what the contact list is about. type: string tags: - Email /v2/email/custom-verification-email-templates/{TemplateName}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteCustomVerificationEmailTemplate description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteCustomVerificationEmailTemplateResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: TemplateName in: path required: true description: The name of the custom verification email template that you want to delete. schema: type: string description: The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations. minLength: 1 tags: - Email get: operationId: GetCustomVerificationEmailTemplate description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetCustomVerificationEmailTemplateResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: TemplateName in: path required: true description: The name of the custom verification email template that you want to retrieve. schema: type: string description: The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations. minLength: 1 tags: - Email put: operationId: UpdateCustomVerificationEmailTemplate description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateCustomVerificationEmailTemplateResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: TemplateName in: path required: true description: The name of the custom verification email template that you want to update. schema: type: string description: The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations. minLength: 1 requestBody: required: true content: application/json: schema: type: object required: - FromEmailAddress - TemplateSubject - TemplateContent - SuccessRedirectionURL - FailureRedirectionURL properties: FromEmailAddress: description: The email address that the custom verification email is sent from. type: string TemplateSubject: description: The subject line of the email. type: string TemplateContent: description: The content of the custom verification email template. type: string SuccessRedirectionURL: description: The URL that the recipient of the verification email is sent to if his or her address is successfully verified. type: string FailureRedirectionURL: description: The URL that the recipient of the verification email is sent to if his or her address is not successfully verified. type: string tags: - Email /v2/email/dedicated-ip-pools/{PoolName}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteDedicatedIpPool description: Delete a dedicated IP pool. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteDedicatedIpPoolResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '483': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' parameters: - name: PoolName in: path required: true description: The name of the dedicated IP pool that you want to delete. schema: type: string description: The name of a dedicated IP pool. tags: - Email get: operationId: GetDedicatedIpPool description: Retrieve information about the dedicated pool. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetDedicatedIpPoolResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: PoolName in: path required: true description: The name of the dedicated IP pool to retrieve. schema: type: string description: The name of a dedicated IP pool. tags: - Email /v2/email/identities/{EmailIdentity}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteEmailIdentity description: Deletes an email identity. An identity can be either an email address or a domain name. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteEmailIdentityResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '483': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' parameters: - name: EmailIdentity in: path required: true description: The identity (that is, the email address or domain) to delete. schema: type: string minLength: 1 tags: - Email get: operationId: GetEmailIdentity description: 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. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetEmailIdentityResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: EmailIdentity in: path required: true description: The email identity. schema: type: string minLength: 1 tags: - Email /v2/email/templates/{TemplateName}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteEmailTemplate description:

Deletes an email template.

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

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteEmailTemplateResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: TemplateName in: path required: true description: The name of the template to be deleted. schema: type: string description: The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations. minLength: 1 tags: - Email get: operationId: GetEmailTemplate description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetEmailTemplateResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: TemplateName in: path required: true description: The name of the template. schema: type: string description: The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations. minLength: 1 tags: - Email put: operationId: UpdateEmailTemplate description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateEmailTemplateResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: TemplateName in: path required: true description: The name of the template. schema: type: string description: The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations. minLength: 1 requestBody: required: true content: application/json: schema: type: object required: - TemplateContent properties: TemplateContent: description: The content of the email, composed of a subject line, an HTML part, and a text-only part. type: object properties: Subject: allOf: - $ref: '#/components/schemas/EmailTemplateSubject' - description: The subject line of the email. Text: allOf: - $ref: '#/components/schemas/EmailTemplateText' - description: The email body that will be visible to recipients whose email clients do not display HTML. Html: allOf: - $ref: '#/components/schemas/EmailTemplateHtml' - description: The HTML body of the email. tags: - Email /v2/email/suppression/addresses/{EmailAddress}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteSuppressedDestination description: Removes an email address from the suppression list for your account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteSuppressedDestinationResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: EmailAddress in: path required: true description: The suppressed email destination to remove from the account suppression list. schema: type: string tags: - Email get: operationId: GetSuppressedDestination description: Retrieves information about a specific email address that's on the suppression list for your account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSuppressedDestinationResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' parameters: - name: EmailAddress in: path required: true description: The email address that's on the account suppression list. schema: type: string tags: - Email /v2/email/account: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetAccount description: Obtain information about the email-sending status and capabilities of your Amazon SES account in the current Amazon Web Services Region. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetAccountResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: [] tags: - Email /v2/email/deliverability-dashboard/blacklist-report#BlacklistItemNames: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetBlacklistReports description: Retrieve a list of the blacklists that your dedicated IP addresses appear on. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetBlacklistReportsResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: BlacklistItemNames in: query required: true description: A list of IP addresses that you want to retrieve blacklist information about. You can only specify the dedicated IP addresses that you use to send email using Amazon SES or Amazon Pinpoint. schema: type: array items: $ref: '#/components/schemas/BlacklistItemName' tags: - Email /v2/email/dedicated-ips/{IP}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetDedicatedIp description: 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. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetDedicatedIpResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: IP in: path required: true description: The IP address that you want to obtain more information about. The value you specify has to be a dedicated IP address that's assocaited with your Amazon Web Services account. schema: type: string description: An IPv4 address. tags: - Email /v2/email/dedicated-ips: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetDedicatedIps description: List the dedicated IP addresses that are associated with your Amazon Web Services account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetDedicatedIpsResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: PoolName in: query required: false description: The name of the IP pool that the dedicated IP address is associated with. schema: type: string description: The name of a dedicated IP pool. - name: NextToken in: query required: false description: A token returned from a previous call to GetDedicatedIps to indicate the position of the dedicated IP pool in the list of IP pools. schema: type: string - name: PageSize in: query required: false description: The number of results to show in a single call to GetDedicatedIpsRequest. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results. schema: type: integer tags: - Email /v2/email/deliverability-dashboard: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetDeliverabilityDashboardOptions description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetDeliverabilityDashboardOptionsResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: [] tags: - Email put: operationId: PutDeliverabilityDashboardOption description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutDeliverabilityDashboardOptionResponse' '480': description: AlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/AlreadyExistsException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '483': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '484': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - DashboardEnabled properties: DashboardEnabled: description: Specifies whether to enable the Deliverability dashboard. To enable the dashboard, set this value to true. type: boolean SubscribedDomains: description: An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an active Deliverability dashboard subscription. If a Deliverability dashboard subscription is active for a domain, you gain access to reputation, inbox placement, and other metrics for the domain. type: array items: $ref: '#/components/schemas/DomainDeliverabilityTrackingOption' tags: - Email /v2/email/deliverability-dashboard/test-reports/{ReportId}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetDeliverabilityTestReport description: Retrieve the results of a predictive inbox placement test. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetDeliverabilityTestReportResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: ReportId in: path required: true description: A unique string that identifies the predictive inbox placement test. schema: type: string description: A unique string that identifies a Deliverability dashboard report. tags: - Email /v2/email/deliverability-dashboard/campaigns/{CampaignId}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetDomainDeliverabilityCampaign description: 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. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetDomainDeliverabilityCampaignResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' parameters: - name: CampaignId in: path required: true description: The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign. schema: type: string tags: - Email /v2/email/deliverability-dashboard/statistics-report/{Domain}#StartDate&EndDate: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetDomainStatisticsReport description: Retrieve inbox placement and engagement rates for the domains that you use to send email. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetDomainStatisticsReportResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: Domain in: path required: true description: The domain that you want to obtain deliverability metrics for. schema: type: string minLength: 1 - name: StartDate in: query required: true description: The first day (in Unix time) that you want to obtain domain deliverability metrics for. schema: type: string format: date-time - name: EndDate in: query required: true description: The last day (in Unix time) that you want to obtain domain deliverability metrics for. The EndDate that you specify has to be less than or equal to 30 days after the StartDate. schema: type: string format: date-time tags: - Email /v2/email/identities/{EmailIdentity}/policies: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetEmailIdentityPolicies description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetEmailIdentityPoliciesResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: EmailIdentity in: path required: true description: The email identity. schema: type: string minLength: 1 tags: - Email /v2/email/import-jobs/{JobId}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetImportJob description: Provides information about an import job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetImportJobResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: JobId in: path required: true description: The ID of the import job. schema: type: string description: A string that represents the import job ID. minLength: 1 tags: - Email /v2/email/deliverability-dashboard/test-reports: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: ListDeliverabilityTestReports description: 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. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListDeliverabilityTestReportsResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: NextToken in: query required: false description: A token returned from a previous call to ListDeliverabilityTestReports to indicate the position in the list of predictive inbox placement tests. schema: type: string - name: PageSize in: query required: false description:

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

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

schema: type: integer tags: - Email /v2/email/deliverability-dashboard/domains/{SubscribedDomain}/campaigns#StartDate&EndDate: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: ListDomainDeliverabilityCampaigns description: 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. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListDomainDeliverabilityCampaignsResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' parameters: - name: StartDate in: query required: true description: The first day that you want to obtain deliverability data for. schema: type: string format: date-time - name: EndDate in: query required: true description: The last day that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the StartDate parameter. schema: type: string format: date-time - name: SubscribedDomain in: path required: true description: The domain to obtain deliverability data for. schema: type: string - name: NextToken in: query required: false description: A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of a campaign in the list of campaigns. schema: type: string - name: PageSize in: query required: false description: The maximum number of results to include in response to a single call to the ListDomainDeliverabilityCampaigns operation. If the number of results is larger than the number that you specify in this parameter, the response includes a NextToken element, which you can use to obtain additional results. schema: type: integer tags: - Email /v2/email/vdm/recommendations: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListRecommendations description:

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

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

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListRecommendationsResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' parameters: - name: PageSize in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: Filter: description: An object that contains mapping between ListRecommendationsFilterKey and ListRecommendationFilterValue to filter by. type: object minProperties: 1 maxProperties: 2 additionalProperties: $ref: '#/components/schemas/ListRecommendationFilterValue' NextToken: description: A token returned from a previous call to ListRecommendations to indicate the position in the list of recommendations. type: string PageSize: description:

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

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

type: integer tags: - Email /v2/email/suppression/addresses: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: ListSuppressedDestinations description: Retrieves a list of email addresses that are on the suppression list for your account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListSuppressedDestinationsResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' parameters: - name: Reason in: query required: false description: The factors that caused the email address to be added to . schema: type: array items: $ref: '#/components/schemas/SuppressionListReason' - name: StartDate in: query required: false description: Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list after a specific date. schema: type: string format: date-time - name: EndDate in: query required: false description: Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list before a specific date. schema: type: string format: date-time - name: NextToken in: query required: false description: A token returned from a previous call to ListSuppressedDestinations to indicate the position in the list of suppressed email addresses. schema: type: string - name: PageSize in: query required: false description: The number of results to show in a single call to ListSuppressedDestinations. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results. schema: type: integer tags: - Email put: operationId: PutSuppressedDestination description: Adds an email address to the suppression list for your account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutSuppressedDestinationResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - EmailAddress - Reason properties: EmailAddress: description: The email address that should be added to the suppression list for your account. type: string Reason: description:

The reason that the address was added to the suppression list for your account. The value can be one of the following:

type: string enum: - BOUNCE - COMPLAINT tags: - Email /v2/email/tags#ResourceArn: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: ListTagsForResource description: 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. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListTagsForResourceResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: ResourceArn in: query required: true description: The Amazon Resource Name (ARN) of the resource that you want to retrieve tag information for. schema: type: string tags: - Email /v2/email/account/dedicated-ips/warmup: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: PutAccountDedicatedIpWarmupAttributes description: Enable or disable the automatic warm-up feature for dedicated IP addresses. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutAccountDedicatedIpWarmupAttributesResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: [] requestBody: required: true content: application/json: schema: type: object properties: AutoWarmupEnabled: description: Enables or disables the automatic warm-up feature for dedicated IP addresses that are associated with your Amazon SES account in the current Amazon Web Services Region. Set to true to enable the automatic warm-up feature, or set to false to disable it. type: boolean tags: - Email /v2/email/account/details: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: PutAccountDetails description: Update your Amazon SES account details. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutAccountDetailsResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - MailType - WebsiteURL - UseCaseDescription properties: MailType: description: The type of email your account will send. type: string enum: - MARKETING - TRANSACTIONAL WebsiteURL: description: The URL of your website. This information helps us better understand the type of content that you plan to send. type: string pattern: ^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))? minLength: 1 maxLength: 1000 format: password ContactLanguage: description: The language you would prefer to be contacted with. type: string enum: - EN - JA UseCaseDescription: description: A description of the types of email that you plan to send. type: string minLength: 1 maxLength: 5000 format: password AdditionalContactEmailAddresses: description: Additional email addresses that you would like to be notified regarding Amazon SES matters. type: array items: $ref: '#/components/schemas/AdditionalContactEmailAddress' minItems: 1 maxItems: 4 ProductionAccessEnabled: description:

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

If the value is false, then your account is in the sandbox. When your account is in the sandbox, you can only send email to verified identities. Additionally, the maximum number of emails you can send in a 24-hour period (your sending quota) is 200, and the maximum number of emails you can send per second (your maximum sending rate) is 1.

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

type: boolean tags: - Email /v2/email/account/sending: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: PutAccountSendingAttributes description: Enable or disable the ability of your account to send email. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutAccountSendingAttributesResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: [] requestBody: required: true content: application/json: schema: type: object properties: SendingEnabled: description:

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

If Amazon Web Services paused your account's ability to send email, you can't use this operation to resume your account's ability to send email.

type: boolean tags: - Email /v2/email/account/suppression: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: PutAccountSuppressionAttributes description: Change the settings for the account-level suppression list. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutAccountSuppressionAttributesResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: [] requestBody: required: true content: application/json: schema: type: object properties: SuppressedReasons: description:

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

type: array items: $ref: '#/components/schemas/SuppressionListReason' tags: - Email /v2/email/account/vdm: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: PutAccountVdmAttributes description:

Update your Amazon SES account VDM attributes.

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

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutAccountVdmAttributesResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - VdmAttributes properties: VdmAttributes: description: The VDM attributes that apply to your Amazon SES account. type: object properties: VdmEnabled: allOf: - $ref: '#/components/schemas/FeatureStatus' - description:

Specifies the status of your VDM configuration. Can be one of the following:

DashboardAttributes: allOf: - $ref: '#/components/schemas/DashboardAttributes' - description: Specifies additional settings for your VDM configuration as applicable to the Dashboard. GuardianAttributes: allOf: - $ref: '#/components/schemas/GuardianAttributes' - description: Specifies additional settings for your VDM configuration as applicable to the Guardian. tags: - Email /v2/email/configuration-sets/{ConfigurationSetName}/delivery-options: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: PutConfigurationSetDeliveryOptions description: 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. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutConfigurationSetDeliveryOptionsResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: ConfigurationSetName in: path required: true description: The name of the configuration set to associate with a dedicated IP pool. schema: type: string description:

The name of a 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.

requestBody: required: true content: application/json: schema: type: object properties: TlsPolicy: description: Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established. type: string enum: - REQUIRE - OPTIONAL SendingPoolName: description: The name of the dedicated IP pool to associate with the configuration set. type: string tags: - Email /v2/email/configuration-sets/{ConfigurationSetName}/reputation-options: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: PutConfigurationSetReputationOptions description: Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific Amazon Web Services Region. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutConfigurationSetReputationOptionsResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: ConfigurationSetName in: path required: true description: The name of the configuration set. schema: type: string description:

The name of a 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.

requestBody: required: true content: application/json: schema: type: object properties: ReputationMetricsEnabled: description: If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set. type: boolean tags: - Email /v2/email/configuration-sets/{ConfigurationSetName}/sending: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: PutConfigurationSetSendingOptions description: Enable or disable email sending for messages that use a particular configuration set in a specific Amazon Web Services Region. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutConfigurationSetSendingOptionsResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: ConfigurationSetName in: path required: true description: The name of the configuration set to enable or disable email sending for. schema: type: string description:

The name of a 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.

requestBody: required: true content: application/json: schema: type: object properties: SendingEnabled: description: If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set. type: boolean tags: - Email /v2/email/configuration-sets/{ConfigurationSetName}/suppression-options: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: PutConfigurationSetSuppressionOptions description: Specify the account suppression list preferences for a configuration set. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutConfigurationSetSuppressionOptionsResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: ConfigurationSetName in: path required: true description: The name of the configuration set to change the suppression list preferences for. schema: type: string description:

The name of a 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.

requestBody: required: true content: application/json: schema: type: object properties: SuppressedReasons: description:

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

type: array items: $ref: '#/components/schemas/SuppressionListReason' tags: - Email /v2/email/configuration-sets/{ConfigurationSetName}/tracking-options: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: PutConfigurationSetTrackingOptions description: Specify a custom domain to use for open and click tracking elements in email that you send. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutConfigurationSetTrackingOptionsResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: ConfigurationSetName in: path required: true description: The name of the configuration set. schema: type: string description:

The name of a 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.

requestBody: required: true content: application/json: schema: type: object properties: CustomRedirectDomain: description: The domain to use for tracking open and click events. type: string tags: - Email /v2/email/configuration-sets/{ConfigurationSetName}/vdm-options: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: PutConfigurationSetVdmOptions description:

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

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

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutConfigurationSetVdmOptionsResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: ConfigurationSetName in: path required: true description: The name of the configuration set. schema: type: string description:

The name of a 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.

requestBody: required: true content: application/json: schema: type: object properties: VdmOptions: description: An object that defines the VDM settings that apply to emails that you send using the configuration set. type: object properties: DashboardOptions: allOf: - $ref: '#/components/schemas/DashboardOptions' - description: Specifies additional settings for your VDM configuration as applicable to the Dashboard. GuardianOptions: allOf: - $ref: '#/components/schemas/GuardianOptions' - description: Specifies additional settings for your VDM configuration as applicable to the Guardian. tags: - Email /v2/email/dedicated-ips/{IP}/pool: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: PutDedicatedIpInPool description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutDedicatedIpInPoolResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: IP in: path required: true description: The IP address that you want to move to the dedicated IP pool. The value you specify has to be a dedicated IP address that's associated with your Amazon Web Services account. schema: type: string description: An IPv4 address. requestBody: required: true content: application/json: schema: type: object required: - DestinationPoolName properties: DestinationPoolName: description: The name of a dedicated IP pool. type: string tags: - Email /v2/email/dedicated-ips/{IP}/warmup: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: PutDedicatedIpWarmupAttributes description:

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutDedicatedIpWarmupAttributesResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: IP in: path required: true description: The dedicated IP address that you want to update the warm-up attributes for. schema: type: string description: An IPv4 address. requestBody: required: true content: application/json: schema: type: object required: - WarmupPercentage properties: WarmupPercentage: description: The warm-up percentage that you want to associate with the dedicated IP address. type: integer tags: - Email /v2/email/identities/{EmailIdentity}/configuration-set: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: PutEmailIdentityConfigurationSetAttributes description: Used to associate a configuration set with an email identity. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutEmailIdentityConfigurationSetAttributesResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: EmailIdentity in: path required: true description: The email address or domain to associate with a configuration set. schema: type: string minLength: 1 requestBody: required: true content: application/json: schema: type: object properties: ConfigurationSetName: description:

The name of a 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.

type: string tags: - Email /v2/email/identities/{EmailIdentity}/dkim: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: PutEmailIdentityDkimAttributes description: Used to enable or disable DKIM authentication for an email identity. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutEmailIdentityDkimAttributesResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: EmailIdentity in: path required: true description: The email identity. schema: type: string minLength: 1 requestBody: required: true content: application/json: schema: type: object properties: SigningEnabled: description:

Sets the DKIM signing configuration for the identity.

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

type: boolean tags: - Email /v1/email/identities/{EmailIdentity}/dkim/signing: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: PutEmailIdentityDkimSigningAttributes description:

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:

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutEmailIdentityDkimSigningAttributesResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: EmailIdentity in: path required: true description: The email identity. schema: type: string minLength: 1 requestBody: required: true content: application/json: schema: type: object required: - SigningAttributesOrigin properties: SigningAttributesOrigin: description:

The method to use to configure DKIM for the identity. There are the following possible values:

type: string enum: - AWS_SES - EXTERNAL SigningAttributes: description: An object that contains configuration for Bring Your Own DKIM (BYODKIM), or, for Easy DKIM type: object properties: DomainSigningSelector: allOf: - $ref: '#/components/schemas/Selector' - description: '[Bring Your Own DKIM] A string that''s used to identify a public key in the DNS configuration for a domain.' DomainSigningPrivateKey: allOf: - $ref: '#/components/schemas/PrivateKey' - description:

[Bring Your Own DKIM] A private key that's used to generate a DKIM signature.

The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding.

NextSigningKeyLength: allOf: - $ref: '#/components/schemas/DkimSigningKeyLength' - description: '[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.' tags: - Email /v2/email/identities/{EmailIdentity}/feedback: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: PutEmailIdentityFeedbackAttributes description:

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).

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutEmailIdentityFeedbackAttributesResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: EmailIdentity in: path required: true description: The email identity. schema: type: string minLength: 1 requestBody: required: true content: application/json: schema: type: object properties: EmailForwardingEnabled: description:

Sets the feedback forwarding configuration for the identity.

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

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

type: boolean tags: - Email /v2/email/identities/{EmailIdentity}/mail-from: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: PutEmailIdentityMailFromAttributes description: Used to enable or disable the custom Mail-From domain configuration for an email identity. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutEmailIdentityMailFromAttributesResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: EmailIdentity in: path required: true description: The verified email identity. schema: type: string minLength: 1 requestBody: required: true content: application/json: schema: type: object properties: MailFromDomain: description: The domain to use as a MAIL FROM domain. type: string BehaviorOnMxFailure: description:

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

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

type: string enum: - USE_DEFAULT_VALUE - REJECT_MESSAGE tags: - Email /v2/email/outbound-bulk-emails: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: SendBulkEmail description: Composes an email message to multiple destinations. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/SendBulkEmailResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '482': description: AccountSuspendedException content: application/json: schema: $ref: '#/components/schemas/AccountSuspendedException' '483': description: SendingPausedException content: application/json: schema: $ref: '#/components/schemas/SendingPausedException' '484': description: MessageRejected content: application/json: schema: $ref: '#/components/schemas/MessageRejected' '485': description: MailFromDomainNotVerifiedException content: application/json: schema: $ref: '#/components/schemas/MailFromDomainNotVerifiedException' '486': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '487': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - DefaultContent - BulkEmailEntries properties: FromEmailAddress: description: The email address to use as the "From" address for the email. The address that you specify has to be verified. type: string FromEmailAddressIdentityArn: description:

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FromEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

type: string ReplyToAddresses: description: The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply. type: array items: $ref: '#/components/schemas/EmailAddress' FeedbackForwardingEmailAddress: description: The address that you want bounce and complaint notifications to be sent to. type: string FeedbackForwardingEmailAddressIdentityArn: description:

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FeedbackForwardingEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

type: string DefaultEmailTags: description: A list of message tags. type: array items: $ref: '#/components/schemas/MessageTag' DefaultContent: description: An object that contains the body of the message. You can specify a template message. type: object properties: Template: allOf: - $ref: '#/components/schemas/Template' - description: The template to use for the bulk email message. BulkEmailEntries: description: A list of BulkEmailEntry objects. type: array items: $ref: '#/components/schemas/BulkEmailEntry' ConfigurationSetName: description:

The name of a 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.

type: string tags: - Email /v2/email/outbound-custom-verification-emails: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: SendCustomVerificationEmail description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/SendCustomVerificationEmailResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '482': description: MessageRejected content: application/json: schema: $ref: '#/components/schemas/MessageRejected' '483': description: SendingPausedException content: application/json: schema: $ref: '#/components/schemas/SendingPausedException' '484': description: MailFromDomainNotVerifiedException content: application/json: schema: $ref: '#/components/schemas/MailFromDomainNotVerifiedException' '485': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '486': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - EmailAddress - TemplateName properties: EmailAddress: description: The email address to verify. type: string TemplateName: description: The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations. type: string minLength: 1 ConfigurationSetName: description:

The name of a 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.

type: string tags: - Email /v2/email/outbound-emails: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: SendEmail description:

Sends an email message. You can use the Amazon SES API v2 to send the following types of messages:

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/SendEmailResponse' '480': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '481': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '482': description: AccountSuspendedException content: application/json: schema: $ref: '#/components/schemas/AccountSuspendedException' '483': description: SendingPausedException content: application/json: schema: $ref: '#/components/schemas/SendingPausedException' '484': description: MessageRejected content: application/json: schema: $ref: '#/components/schemas/MessageRejected' '485': description: MailFromDomainNotVerifiedException content: application/json: schema: $ref: '#/components/schemas/MailFromDomainNotVerifiedException' '486': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '487': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - Content properties: FromEmailAddress: description: 'The email address to use as the "From" address for the email. The address that you specify has to be verified. ' type: string FromEmailAddressIdentityArn: description:

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FromEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

For Raw emails, the FromEmailAddressIdentityArn value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.

type: string Destination: description:

An object that describes the recipients for an email.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a destination email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492.

type: object properties: ToAddresses: allOf: - $ref: '#/components/schemas/EmailAddressList' - description: An array that contains the email addresses of the "To" recipients for the email. CcAddresses: allOf: - $ref: '#/components/schemas/EmailAddressList' - description: An array that contains the email addresses of the "CC" (carbon copy) recipients for the email. BccAddresses: allOf: - $ref: '#/components/schemas/EmailAddressList' - description: An array that contains the email addresses of the "BCC" (blind carbon copy) recipients for the email. ReplyToAddresses: description: The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply. type: array items: $ref: '#/components/schemas/EmailAddress' FeedbackForwardingEmailAddress: description: The address that you want bounce and complaint notifications to be sent to. type: string FeedbackForwardingEmailAddressIdentityArn: description:

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FeedbackForwardingEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

type: string Content: description: An object that defines the entire content of the email, including the message headers and the body content. You can create a simple email message, in which you specify the subject and the text and HTML versions of the message body. You can also create raw messages, in which you specify a complete MIME-formatted message. Raw messages can include attachments and custom headers. type: object properties: Simple: allOf: - $ref: '#/components/schemas/Message' - description: The simple email message. The message consists of a subject and a message body. Raw: allOf: - $ref: '#/components/schemas/RawMessage' - description:

The raw email message. The message has to meet the following criteria:

Template: allOf: - $ref: '#/components/schemas/Template' - description: The template to use for the email message. EmailTags: description: A list of message tags. type: array items: $ref: '#/components/schemas/MessageTag' ConfigurationSetName: description:

The name of a 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.

type: string ListManagementOptions: description: An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe. type: object properties: ContactListName: allOf: - $ref: '#/components/schemas/ContactListName' - description: The name of the contact list. TopicName: allOf: - $ref: '#/components/schemas/TopicName' - description: The name of the topic. tags: - Email /v2/email/tags: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: TagResource description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TagResourceResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - ResourceArn - Tags properties: ResourceArn: description: The Amazon Resource Name (ARN) of the resource that you want to add one or more tags to. type: string Tags: description: A list of the tags that you want to add to the resource. A tag consists of a required tag key (Key) and an associated tag value (Value). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters. type: array items: $ref: '#/components/schemas/Tag' tags: - Email /v2/email/templates/{TemplateName}/render: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: TestRenderEmailTemplate description:

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TestRenderEmailTemplateResponse' '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' parameters: - name: TemplateName in: path required: true description: The name of the template. schema: type: string description: The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations. minLength: 1 requestBody: required: true content: application/json: schema: type: object required: - TemplateData properties: TemplateData: description: An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable. type: string maxLength: 262144 tags: - Email /v2/email/tags#ResourceArn&TagKeys: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: UntagResource description: Remove one or more tags (keys and values) from a specified resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UntagResourceResponse' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConcurrentModificationException content: application/json: schema: $ref: '#/components/schemas/ConcurrentModificationException' '482': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: ResourceArn in: query required: true description: The Amazon Resource Name (ARN) of the resource that you want to remove one or more tags from. schema: type: string - name: TagKeys in: query required: true description: '

The tags (tag keys) that you want to remove from the resource. When you specify a tag key, the action removes both that key and its associated tag value.

To remove more than one tag from the resource, append the TagKeys parameter and argument for each additional tag to remove, separated by an ampersand. For example: /v2/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2

' schema: type: array items: $ref: '#/components/schemas/TagKey' tags: - Email components: schemas: ListEmailIdentitiesResponse: type: object properties: EmailIdentities: allOf: - $ref: '#/components/schemas/IdentityInfoList' - description: An array that includes all of the email identities associated with your Amazon Web Services account. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListEmailIdentities, and pass this token in the NextToken parameter. description: A list of all of the identities that you've attempted to verify, regardless of whether or not those identities were successfully verified. SuppressionListReasons: type: array items: $ref: '#/components/schemas/SuppressionListReason' DefaultDimensionValue: type: string description:

The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:

UpdateConfigurationSetEventDestinationResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. FailedRecordsS3Url: type: string DimensionName: type: string description:

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:

Ip: type: string description: An IPv4 address. PutConfigurationSetDeliveryOptionsResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. SendEmailResponse: type: object properties: MessageId: allOf: - $ref: '#/components/schemas/OutboundMessageId' - description:

A unique identifier for the message that is generated when the message is accepted.

It's possible for Amazon SES to accept a message without sending it. This can happen when the message that you're trying to send has an attachment contains a virus, or when you send a templated email that contains invalid personalization content, for example.

description: A unique message ID that you receive when an email is accepted for sending. IspPlacement: type: object properties: IspName: allOf: - $ref: '#/components/schemas/IspName' - description: The name of the email provider that the inbox placement data applies to. PlacementStatistics: allOf: - $ref: '#/components/schemas/PlacementStatistics' - description: An object that contains inbox placement metrics for a specific email provider. description: An object that describes how email sent during the predictive inbox placement test was handled by a certain email provider. DkimAttributes: type: object properties: SigningEnabled: allOf: - $ref: '#/components/schemas/Enabled' - description: If the value is true, then the messages that you send from the identity are signed using DKIM. If the value is false, then the messages that you send from the identity aren't DKIM-signed. Status: allOf: - $ref: '#/components/schemas/DkimStatus' - description:

Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:

Tokens: allOf: - $ref: '#/components/schemas/DnsTokenList' - description:

If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete.

If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.

Regardless of the DKIM authentication method you use, Amazon SES searches for the appropriate records in the DNS configuration of the domain for up to 72 hours.

SigningAttributesOrigin: allOf: - $ref: '#/components/schemas/DkimSigningAttributesOrigin' - description:

A string that indicates how DKIM was configured for the identity. These are the possible values:

NextSigningKeyLength: allOf: - $ref: '#/components/schemas/DkimSigningKeyLength' - description: '[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.' CurrentSigningKeyLength: allOf: - $ref: '#/components/schemas/DkimSigningKeyLength' - description: '[Easy DKIM] The key length of the DKIM key pair in use.' LastKeyGenerationTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: '[Easy DKIM] The last time a key pair was generated for this identity.' description:

An object that contains information about the DKIM authentication status for an email identity.

Amazon SES determines the authentication status by searching for specific records in the DNS configuration for the domain. If you used Easy DKIM to set up DKIM authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration for your domain. If you provided a public key to perform DKIM authentication, Amazon SES tries to find a TXT record that uses the selector that you specified. The value of the TXT record must be a public key that's paired with the private key that you specified in the process of creating the identity

ReviewStatus: type: string enum: - PENDING - FAILED - GRANTED - DENIED Esp: type: string DkimSigningKeyLength: type: string enum: - RSA_1024_BIT - RSA_2048_BIT ImportDataSource: type: object required: - S3Url - DataFormat properties: S3Url: allOf: - $ref: '#/components/schemas/S3Url' - description: An Amazon S3 URL in the format s3://<bucket_name>/<object>. DataFormat: allOf: - $ref: '#/components/schemas/DataFormat' - description: The data format of the import job's data source. description: An object that contains details about the data source of the import job. ListDeliverabilityTestReportsResponse: type: object required: - DeliverabilityTestReports properties: DeliverabilityTestReports: allOf: - $ref: '#/components/schemas/DeliverabilityTestReports' - description: An object that contains a lists of predictive inbox placement tests that you've performed. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: A token that indicates that there are additional predictive inbox placement tests to list. To view additional predictive inbox placement tests, issue another request to ListDeliverabilityTestReports, and pass this token in the NextToken parameter. description: A list of the predictive inbox placement test reports that are available for your account, regardless of whether or not those tests are complete. Tag: type: object required: - Key - Value properties: Key: allOf: - $ref: '#/components/schemas/TagKey' - description: One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character. Value: allOf: - $ref: '#/components/schemas/TagValue' - description: The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don't want a resource to have a specific tag value, don't specify a value for this parameter. If you don't specify a value, Amazon SES sets the value to an empty string. description: '

An object that defines the tags that are associated with a 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 a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:

' GetSuppressedDestinationResponse: type: object required: - SuppressedDestination properties: SuppressedDestination: allOf: - $ref: '#/components/schemas/SuppressedDestination' - description: An object containing information about the suppressed email address. description: Information about the suppressed email address. IdentityInfo: type: object properties: IdentityType: allOf: - $ref: '#/components/schemas/IdentityType' - description: 'The email identity type. Note: the MANAGED_DOMAIN type is not supported for email identity types.' IdentityName: allOf: - $ref: '#/components/schemas/Identity' - description: The address or domain of the identity. SendingEnabled: allOf: - $ref: '#/components/schemas/Enabled' - description:

Indicates whether or not you can send email from the identity.

An identity is an email address or domain that you send email from. Before you can send email from an identity, you have to demostrate that you own the identity, and that you authorize Amazon SES to send email from that identity.

VerificationStatus: allOf: - $ref: '#/components/schemas/VerificationStatus' - description:

The verification status of the identity. The status can be one of the following:

description: Information about an email identity. ReportId: type: string description: A unique string that identifies a Deliverability dashboard report. TagList: type: array items: $ref: '#/components/schemas/Tag' Timestamp: type: string format: date-time IspName: type: string description: The name of an email provider. GetDedicatedIpResponse: type: object properties: DedicatedIp: allOf: - $ref: '#/components/schemas/DedicatedIp' - description: An object that contains information about a dedicated IP address. description: Information about a dedicated IP address. UpdateEmailIdentityPolicyResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. PutAccountSendingAttributesResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. ConflictException: {} EmailTemplateMetadata: type: object properties: TemplateName: allOf: - $ref: '#/components/schemas/EmailTemplateName' - description: The name of the template. CreatedTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time and date the template was created. description: Contains information about an email template. Selector: type: string pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9]))$ minLength: 1 maxLength: 63 GetConfigurationSetEventDestinationsResponse: type: object properties: EventDestinations: allOf: - $ref: '#/components/schemas/EventDestinations' - description: An array that includes all of the events destinations that have been configured for the configuration set. description: Information about an event destination for a configuration set. CreateEmailTemplateResponse: type: object properties: {} description: If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. PutAccountSuppressionAttributesResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. BlacklistReport: type: object additionalProperties: $ref: '#/components/schemas/BlacklistEntries' PutDeliverabilityDashboardOptionResponse: type: object properties: {} description: A response that indicates whether the Deliverability dashboard is enabled. AdditionalContactEmailAddress: type: string pattern: ^(.+)@(.+)$ minLength: 6 maxLength: 254 format: password ReputationOptions: type: object properties: ReputationMetricsEnabled: allOf: - $ref: '#/components/schemas/Enabled' - description: If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set. LastFreshStart: allOf: - $ref: '#/components/schemas/LastFreshStart' - description: The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start. description: 'Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current Amazon Web Services Region. ' TopicPreference: type: object required: - TopicName - SubscriptionStatus properties: TopicName: allOf: - $ref: '#/components/schemas/TopicName' - description: The name of the topic. SubscriptionStatus: allOf: - $ref: '#/components/schemas/SubscriptionStatus' - description: The contact's subscription status to a topic which is either OPT_IN or OPT_OUT. description: The contact's preference for being opted-in to or opted-out of a topic. TagValue: type: string ListCustomVerificationEmailTemplatesResponse: type: object properties: CustomVerificationEmailTemplates: allOf: - $ref: '#/components/schemas/CustomVerificationEmailTemplatesList' - description: A list of the custom verification email templates that exist in your account. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: A token indicating that there are additional custom verification email templates available to be listed. Pass this token to a subsequent call to ListCustomVerificationEmailTemplates to retrieve the next 50 custom verification email templates. description: The following elements are returned by the service. SendBulkEmailResponse: type: object required: - BulkEmailEntryResults properties: BulkEmailEntryResults: allOf: - $ref: '#/components/schemas/BulkEmailEntryResultList' - description: One object per intended recipient. Check each response object and retry any messages with a failure status. description: The following data is returned in JSON format by the service. Template: type: object properties: TemplateName: allOf: - $ref: '#/components/schemas/EmailTemplateName' - description: 'The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations. ' TemplateArn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The Amazon Resource Name (ARN) of the template. TemplateData: allOf: - $ref: '#/components/schemas/EmailTemplateData' - description: An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable. description: An object that defines the email template to use for an email message, and the values to use for any message variables in that template. An email template is a type of message template that contains content that you want to define, save, and reuse in email messages that you send. Esps: type: array items: $ref: '#/components/schemas/Esp' SuppressionListDestination: type: object required: - SuppressionListImportAction properties: SuppressionListImportAction: allOf: - $ref: '#/components/schemas/SuppressionListImportAction' - description: '

The type of action to perform on the address. The following are possible values:

' description: An object that contains details about the action of suppression list. SuppressionListReason: type: string enum: - BOUNCE - COMPLAINT description:

The reason that the address was added to the suppression list for your account. The value can be one of the following:

BatchGetMetricDataResponse: type: object properties: Results: allOf: - $ref: '#/components/schemas/MetricDataResultList' - description: A list of successfully retrieved MetricDataResult. Errors: allOf: - $ref: '#/components/schemas/MetricDataErrorList' - description: A list of MetricDataError encountered while processing your metric data batch request. description: Represents the result of processing your metric data batch request OverallVolume: type: object properties: VolumeStatistics: allOf: - $ref: '#/components/schemas/VolumeStatistics' - description: An object that contains information about the numbers of messages that arrived in recipients' inboxes and junk mail folders. ReadRatePercent: allOf: - $ref: '#/components/schemas/Percentage' - description: The percentage of emails that were sent from the domain that were read by their recipients. DomainIspPlacements: allOf: - $ref: '#/components/schemas/DomainIspPlacements' - description: An object that contains inbox and junk mail placement metrics for individual email providers. description: An object that contains information about email that was sent from the selected domain. ListDedicatedIpPoolsResponse: type: object properties: DedicatedIpPools: allOf: - $ref: '#/components/schemas/ListOfDedicatedIpPools' - description: A list of all of the dedicated IP pools that are associated with your Amazon Web Services account in the current Region. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: A token that indicates that there are additional IP pools to list. To view additional IP pools, issue another request to ListDedicatedIpPools, passing this token in the NextToken parameter. description: A list of dedicated IP pools. MetricDimensionValue: type: string MessageData: type: string FailureInfo: type: object properties: FailedRecordsS3Url: allOf: - $ref: '#/components/schemas/FailedRecordsS3Url' - description: An Amazon S3 presigned URL that contains all the failed records and related information. ErrorMessage: allOf: - $ref: '#/components/schemas/ErrorMessage' - description: A message about why the import job failed. description: An object that contains the failure details about an import job. SuppressedDestinationSummary: type: object required: - EmailAddress - Reason - LastUpdateTime properties: EmailAddress: allOf: - $ref: '#/components/schemas/EmailAddress' - description: The email address that's on the suppression list for your account. Reason: allOf: - $ref: '#/components/schemas/SuppressionListReason' - description: The reason that the address was added to the suppression list for your account. LastUpdateTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date and time when the suppressed destination was last updated, shown in Unix time format. description: A summary that describes the suppressed email address. ConfigurationSetName: type: string description:

The name of a 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.

UseDefaultIfPreferenceUnavailable: type: boolean GuardianAttributes: type: object properties: OptimizedSharedDelivery: allOf: - $ref: '#/components/schemas/FeatureStatus' - description:

Specifies the status of your VDM optimized shared delivery. Can be one of the following:

description: An object containing additional settings for your VDM configuration as applicable to the Guardian. PutAccountDetailsResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. Percentage100Wrapper: type: integer RawMessageData: type: string description:

The raw email message. The message has to meet the following criteria:

CloudWatchDimensionConfiguration: type: object required: - DimensionName - DimensionValueSource - DefaultDimensionValue properties: DimensionName: allOf: - $ref: '#/components/schemas/DimensionName' - description:

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:

DimensionValueSource: allOf: - $ref: '#/components/schemas/DimensionValueSource' - description: The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or SendRawEmail API, choose messageTag. To use your own email headers, choose emailHeader. To use link tags, choose linkTags. DefaultDimensionValue: allOf: - $ref: '#/components/schemas/DefaultDimensionValue' - description:

The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:

description: An object that defines the dimension configuration to use when you send email events to Amazon CloudWatch. ContactListImportAction: type: string enum: - DELETE - PUT DeleteContactListResponse: type: object properties: {} TemplateContent: type: string description: The content of the custom verification email template. ContactListName: type: string EventDestination: type: object required: - Name - MatchingEventTypes properties: Name: allOf: - $ref: '#/components/schemas/EventDestinationName' - description: A name that identifies the event destination. Enabled: allOf: - $ref: '#/components/schemas/Enabled' - description:

If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition.

If false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.

MatchingEventTypes: allOf: - $ref: '#/components/schemas/EventTypes' - description:

The types of events that Amazon SES sends to the specified event destinations.

KinesisFirehoseDestination: allOf: - $ref: '#/components/schemas/KinesisFirehoseDestination' - description: An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift. CloudWatchDestination: allOf: - $ref: '#/components/schemas/CloudWatchDestination' - description: An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics. SnsDestination: allOf: - $ref: '#/components/schemas/SnsDestination' - description: An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur. PinpointDestination: allOf: - $ref: '#/components/schemas/PinpointDestination' - description: An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide. description: In the Amazon SES API v2, events include message sends, deliveries, opens, clicks, bounces, complaints and delivery delays. 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. EmailTemplateText: type: string description: The email body that will be visible to recipients whose email clients do not display HTML. TlsPolicy: type: string enum: - REQUIRE - OPTIONAL description: Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established. InvalidNextTokenException: {} SuppressedDestination: type: object required: - EmailAddress - Reason - LastUpdateTime properties: EmailAddress: allOf: - $ref: '#/components/schemas/EmailAddress' - description: The email address that is on the suppression list for your account. Reason: allOf: - $ref: '#/components/schemas/SuppressionListReason' - description: The reason that the address was added to the suppression list for your account. LastUpdateTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date and time when the suppressed destination was last updated, shown in Unix time format. Attributes: allOf: - $ref: '#/components/schemas/SuppressedDestinationAttributes' - description: An optional value that can contain additional information about the reasons that the address was added to the suppression list for your account. description: An object that contains information about an email address that is on the suppression list for your account. SuppressedDestinationSummaries: type: array items: $ref: '#/components/schemas/SuppressedDestinationSummary' WebsiteURL: type: string pattern: ^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))? minLength: 1 maxLength: 1000 format: password GetEmailTemplateResponse: type: object required: - TemplateName - TemplateContent properties: TemplateName: allOf: - $ref: '#/components/schemas/EmailTemplateName' - description: The name of the template. TemplateContent: allOf: - $ref: '#/components/schemas/EmailTemplateContent' - description: The content of the email template, composed of a subject line, an HTML part, and a text-only part. description: The following element is returned by the service. CustomVerificationEmailTemplatesList: type: array description: A list of the custom verification email templates that exist in your account. items: $ref: '#/components/schemas/CustomVerificationEmailTemplateMetadata' IpList: type: array items: $ref: '#/components/schemas/Ip' Volume: type: integer description: An object that contains information about inbox placement volume. MetricNamespace: type: string enum: - VDM PutConfigurationSetTrackingOptionsResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. DomainDeliverabilityTrackingOptions: type: array description: An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an active Deliverability dashboard subscription. If a Deliverability dashboard subscription is active for a domain, you gain access to reputation, inbox placement, and other metrics for the domain. items: $ref: '#/components/schemas/DomainDeliverabilityTrackingOption' SuppressionAttributes: type: object properties: SuppressedReasons: allOf: - $ref: '#/components/schemas/SuppressionListReasons' - description:

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

description: An object that contains information about the email address suppression preferences for your account in the current Amazon Web Services Region. ListRecommendationFilterValue: type: string minLength: 1 maxLength: 512 ImportJobSummary: type: object properties: JobId: $ref: '#/components/schemas/JobId' ImportDestination: $ref: '#/components/schemas/ImportDestination' JobStatus: $ref: '#/components/schemas/JobStatus' CreatedTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date and time when the import job was created. ProcessedRecordsCount: allOf: - $ref: '#/components/schemas/ProcessedRecordsCount' - description: The current number of records processed. FailedRecordsCount: allOf: - $ref: '#/components/schemas/FailedRecordsCount' - description: The number of records that failed processing because of invalid input or other reasons. description: A summary of the import job. UpdateEmailTemplateResponse: type: object properties: {} description: If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. DailyVolume: type: object properties: StartDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date that the DailyVolume metrics apply to, in Unix time. VolumeStatistics: allOf: - $ref: '#/components/schemas/VolumeStatistics' - description: An object that contains inbox placement metrics for a specific day in the analysis period. DomainIspPlacements: allOf: - $ref: '#/components/schemas/DomainIspPlacements' - description: An object that contains inbox placement metrics for a specified day in the analysis period, broken out by the recipient's email provider. description: An object that contains information about the volume of email sent on each day of the analysis period. Message: type: object required: - Subject - Body properties: Subject: allOf: - $ref: '#/components/schemas/Content' - description: The subject line of the email. The subject line can only contain 7-bit ASCII characters. However, you can specify non-ASCII characters in the subject line by using encoded-word syntax, as described in RFC 2047. Body: allOf: - $ref: '#/components/schemas/Body' - description: The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both. description: Represents the email message that you're sending. The Message object consists of a subject line and a message body. EventDestinations: type: array items: $ref: '#/components/schemas/EventDestination' GetDomainStatisticsReportResponse: type: object required: - OverallVolume - DailyVolumes properties: OverallVolume: allOf: - $ref: '#/components/schemas/OverallVolume' - description: An object that contains deliverability metrics for the domain that you specified. The data in this object is a summary of all of the data that was collected from the StartDate to the EndDate. DailyVolumes: allOf: - $ref: '#/components/schemas/DailyVolumes' - description: An object that contains deliverability metrics for the domain that you specified. This object contains data for each day, starting on the StartDate and ending on the EndDate. description: An object that includes statistics that are related to the domain that you specified. TimestampList: type: array items: $ref: '#/components/schemas/Timestamp' BlacklistEntries: type: array items: $ref: '#/components/schemas/BlacklistEntry' DashboardAttributes: type: object properties: EngagementMetrics: allOf: - $ref: '#/components/schemas/FeatureStatus' - description:

Specifies the status of your VDM engagement metrics collection. Can be one of the following:

description: An object containing additional settings for your VDM configuration as applicable to the Dashboard. ListOfContactLists: type: array items: $ref: '#/components/schemas/ContactList' ListRecommendationsResponse: type: object properties: Recommendations: allOf: - $ref: '#/components/schemas/RecommendationsList' - description: The recommendations applicable to your account. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: A string token indicating that there might be additional recommendations available to be listed. Use the token provided in the ListRecommendationsResponse to use in the subsequent call to ListRecommendations with the same parameters to retrieve the next page of recommendations. description: Contains the response to your request to retrieve the list of recommendations for your account. DeleteDedicatedIpPoolResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. GetDeliverabilityTestReportResponse: type: object required: - DeliverabilityTestReport - OverallPlacement - IspPlacements properties: DeliverabilityTestReport: allOf: - $ref: '#/components/schemas/DeliverabilityTestReport' - description: An object that contains the results of the predictive inbox placement test. OverallPlacement: allOf: - $ref: '#/components/schemas/PlacementStatistics' - description: An object that specifies how many test messages that were sent during the predictive inbox placement test were delivered to recipients' inboxes, how many were sent to recipients' spam folders, and how many weren't delivered. IspPlacements: allOf: - $ref: '#/components/schemas/IspPlacements' - description: An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others. Message: allOf: - $ref: '#/components/schemas/MessageContent' - description: An object that contains the message that you sent when you performed this predictive inbox placement test. Tags: allOf: - $ref: '#/components/schemas/TagList' - description: An array of objects that define the tags (keys and values) that are associated with the predictive inbox placement test. description: The results of the predictive inbox placement test. ListTagsForResourceResponse: type: object required: - Tags properties: Tags: allOf: - $ref: '#/components/schemas/TagList' - description: An array that lists all the tags that are associated with the resource. Each tag consists of a required tag key (Key) and an associated tag value (Value) LastFreshStart: type: string description: The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start. format: date-time GeneralEnforcementStatus: type: string DataFormat: type: string enum: - CSV - JSON description: The data format of the import job's data source. DeleteCustomVerificationEmailTemplateResponse: type: object properties: {} description: If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. PoolName: type: string description: The name of a dedicated IP pool. SendCustomVerificationEmailResponse: type: object properties: MessageId: allOf: - $ref: '#/components/schemas/OutboundMessageId' - description: The unique message identifier returned from the SendCustomVerificationEmail operation. description: The following element is returned by the service. PutSuppressedDestinationResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. DomainIspPlacement: type: object properties: IspName: allOf: - $ref: '#/components/schemas/IspName' - description: The name of the email provider that the inbox placement data applies to. InboxRawCount: allOf: - $ref: '#/components/schemas/Volume' - description: The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes. SpamRawCount: allOf: - $ref: '#/components/schemas/Volume' - description: The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders. InboxPercentage: allOf: - $ref: '#/components/schemas/Percentage' - description: The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes. SpamPercentage: allOf: - $ref: '#/components/schemas/Percentage' - description: The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders. description: An object that contains inbox placement data for email sent from one of your email domains to a specific email provider. MessageTagName: type: string description:

The name of the message tag. The message tag name has to meet the following criteria:

PolicyMap: type: object description: An object that contains mapping between PolicyName and Policy text. additionalProperties: $ref: '#/components/schemas/Policy' DkimStatus: type: string enum: - PENDING - SUCCESS - FAILED - TEMPORARY_FAILURE - NOT_STARTED description:

The DKIM authentication status of the identity. The status can be one of the following:

CreateCustomVerificationEmailTemplateResponse: type: object properties: {} description: If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ReplacementTemplate: type: object properties: ReplacementTemplateData: allOf: - $ref: '#/components/schemas/EmailTemplateData' - description: A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template. description: An object which contains ReplacementTemplateData to be used for a specific BulkEmailEntry. JobId: type: string description: A string that represents the import job ID. minLength: 1 DedicatedIpList: type: array description: A list of dedicated IP addresses that are associated with your Amazon Web Services account. items: $ref: '#/components/schemas/DedicatedIp' DomainDeliverabilityCampaignList: type: array description:

items: $ref: '#/components/schemas/DomainDeliverabilityCampaign' GetContactResponse: type: object properties: ContactListName: allOf: - $ref: '#/components/schemas/ContactListName' - description: The name of the contact list to which the contact belongs. EmailAddress: allOf: - $ref: '#/components/schemas/EmailAddress' - description: The contact's email addres. TopicPreferences: allOf: - $ref: '#/components/schemas/TopicPreferenceList' - description: The contact's preference for being opted-in to or opted-out of a topic.> TopicDefaultPreferences: allOf: - $ref: '#/components/schemas/TopicPreferenceList' - description: The default topic preferences applied to the contact. UnsubscribeAll: allOf: - $ref: '#/components/schemas/UnsubscribeAll' - description: A boolean value status noting if the contact is unsubscribed from all contact list topics. AttributesData: allOf: - $ref: '#/components/schemas/AttributesData' - description: The attribute data attached to a contact. CreatedTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: A timestamp noting when the contact was created. LastUpdatedTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: A timestamp noting the last time the contact's information was updated. Body: type: object properties: Text: allOf: - $ref: '#/components/schemas/Content' - description: An object that represents the version of the message that is displayed in email clients that don't support HTML, or clients where the recipient has disabled HTML rendering. Html: allOf: - $ref: '#/components/schemas/Content' - description: 'An object that represents the version of the message that is displayed in email clients that support HTML. HTML messages can include formatted text, hyperlinks, images, and more. ' description: Represents the body of the email message. BehaviorOnMxFailure: type: string enum: - USE_DEFAULT_VALUE - REJECT_MESSAGE description:

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

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

DailyVolumes: type: array items: $ref: '#/components/schemas/DailyVolume' BlacklistEntry: type: object properties: RblName: allOf: - $ref: '#/components/schemas/RblName' - description: The name of the blacklist that the IP address appears on. ListingTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the blacklisting event occurred. Description: allOf: - $ref: '#/components/schemas/BlacklistingDescription' - description: Additional information about the blacklisting event, as provided by the blacklist maintainer. description: An object that contains information about a blacklisting event that impacts one of the dedicated IP addresses that is associated with your account. ListConfigurationSetsResponse: type: object properties: ConfigurationSets: allOf: - $ref: '#/components/schemas/ConfigurationSetNameList' - description: An array that contains all of the configuration sets in your Amazon SES account in the current Amazon Web Services Region. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListConfigurationSets, and pass this token in the NextToken parameter. description: A list of configuration sets in your Amazon SES account in the current Amazon Web Services Region. MetricDataError: type: object properties: Id: allOf: - $ref: '#/components/schemas/QueryIdentifier' - description: The query identifier. Code: allOf: - $ref: '#/components/schemas/QueryErrorCode' - description:

The query error code. Can be one of:

Message: allOf: - $ref: '#/components/schemas/QueryErrorMessage' - description: The error message associated with the current query error. description: An error corresponding to the unsuccessful processing of a single metric data query. EmailTemplateData: type: string description: An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable. maxLength: 262144 EventDestinationName: type: string description:

The name of 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.

ConfigurationSetNameList: type: array items: $ref: '#/components/schemas/ConfigurationSetName' DnsToken: type: string BulkEmailEntryResult: type: object properties: Status: allOf: - $ref: '#/components/schemas/BulkEmailStatus' - description: '

The status of a message sent using the SendBulkTemplatedEmail operation.

Possible values for this parameter include:

' Error: allOf: - $ref: '#/components/schemas/ErrorMessage' - description: A description of an error that prevented a message being sent using the SendBulkTemplatedEmail operation. MessageId: allOf: - $ref: '#/components/schemas/OutboundMessageId' - description: The unique message identifier returned from the SendBulkTemplatedEmail operation. description: The result of the SendBulkEmail operation of each specified BulkEmailEntry. GetContactListResponse: type: object properties: ContactListName: allOf: - $ref: '#/components/schemas/ContactListName' - description: The name of the contact list. Topics: allOf: - $ref: '#/components/schemas/Topics' - description: An interest group, theme, or label within a list. A contact list can have multiple topics. Description: allOf: - $ref: '#/components/schemas/Description' - description: A description of what the contact list is about. CreatedTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: A timestamp noting when the contact list was created. LastUpdatedTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: A timestamp noting the last time the contact list was updated. Tags: allOf: - $ref: '#/components/schemas/TagList' - description: The tags associated with a contact list. EmailTemplateMetadataList: type: array description: A list of the EmailTemplateMetadata object. items: $ref: '#/components/schemas/EmailTemplateMetadata' EmailTemplateContent: type: object properties: Subject: allOf: - $ref: '#/components/schemas/EmailTemplateSubject' - description: The subject line of the email. Text: allOf: - $ref: '#/components/schemas/EmailTemplateText' - description: The email body that will be visible to recipients whose email clients do not display HTML. Html: allOf: - $ref: '#/components/schemas/EmailTemplateHtml' - description: The HTML body of the email. description: The content of the email, composed of a subject line, an HTML part, and a text-only part. RecommendationType: type: string enum: - DKIM - DMARC - SPF - BIMI MessageRejected: {} Topics: type: array items: $ref: '#/components/schemas/Topic' InboxPlacementTrackingOption: type: object properties: Global: allOf: - $ref: '#/components/schemas/Enabled' - description: Specifies whether inbox placement data is being tracked for the domain. TrackedIsps: allOf: - $ref: '#/components/schemas/IspNameList' - description: An array of strings, one for each major email provider that the inbox placement data applies to. description: An object that contains information about the inbox placement data settings for a verified domain that’s associated with your Amazon Web Services account. This data is available only if you enabled the Deliverability dashboard for the domain. UpdateContactResponse: type: object properties: {} ReplacementEmailContent: type: object properties: ReplacementTemplate: allOf: - $ref: '#/components/schemas/ReplacementTemplate' - description: The ReplacementTemplate associated with ReplacementEmailContent. description: The ReplaceEmailContent object to be used for a specific BulkEmailEntry. The ReplacementTemplate can be specified within this object. TestRenderEmailTemplateResponse: type: object required: - RenderedTemplate properties: RenderedTemplate: allOf: - $ref: '#/components/schemas/RenderedEmailTemplate' - description: The complete MIME message rendered by applying the data in the TemplateData parameter to the template specified in the TemplateName parameter. description: The following element is returned by the service. RenderedEmailTemplate: type: string description: The complete MIME message rendered by applying the data in the TemplateData parameter to the template specified in the TemplateName parameter. MessageTagList: type: array description: A list of message tags. items: $ref: '#/components/schemas/MessageTag' Charset: type: string VerificationStatus: type: string enum: - PENDING - SUCCESS - FAILED - TEMPORARY_FAILURE - NOT_STARTED ListImportJobsResponse: type: object properties: ImportJobs: allOf: - $ref: '#/components/schemas/ImportJobSummaryList' - description: A list of the import job summaries. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: A string token indicating that there might be additional import jobs available to be listed. Copy this token to a subsequent call to ListImportJobs with the same parameters to retrieve the next page of import jobs. description: An HTTP 200 response if the request succeeds, or an error message if the request fails. Max24HourSend: type: number format: double DeliverabilityTestSubject: type: string description: The subject line for an email that you submitted in a predictive inbox placement test. NextToken: type: string PutEmailIdentityDkimSigningAttributesResponse: type: object properties: DkimStatus: allOf: - $ref: '#/components/schemas/DkimStatus' - description:

The DKIM authentication status of the identity. Amazon SES determines the authentication status by searching for specific records in the DNS configuration for your domain. If you used Easy DKIM to set up DKIM authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration for your domain.

If you provided a public key to perform DKIM authentication, Amazon SES tries to find a TXT record that uses the selector that you specified. The value of the TXT record must be a public key that's paired with the private key that you specified in the process of creating the identity.

The status can be one of the following:

DkimTokens: allOf: - $ref: '#/components/schemas/DnsTokenList' - description:

If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete.

If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector that's associated with your public key.

Regardless of the DKIM authentication method you use, Amazon SES searches for the appropriate records in the DNS configuration of the domain for up to 72 hours.

description:

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PutDedicatedIpInPoolResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. CreateDeliverabilityTestReportResponse: type: object required: - ReportId - DeliverabilityTestStatus properties: ReportId: allOf: - $ref: '#/components/schemas/ReportId' - description: A unique string that identifies the predictive inbox placement test. DeliverabilityTestStatus: allOf: - $ref: '#/components/schemas/DeliverabilityTestStatus' - description: The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test. description: Information about the predictive inbox placement test that you created. RblName: type: string description: The name of a blacklist that an IP address was found on. DisplayName: type: string BulkEmailEntryResultList: type: array description: A list of BulkMailEntry objects. items: $ref: '#/components/schemas/BulkEmailEntryResult' ReviewDetails: type: object properties: Status: allOf: - $ref: '#/components/schemas/ReviewStatus' - description:

The status of the latest review of your account. The status can be one of the following:

CaseId: allOf: - $ref: '#/components/schemas/CaseId' - description: The associated support center case ID (if any). description: An object that contains information about your account details review. MailFromAttributes: type: object required: - MailFromDomain - MailFromDomainStatus - BehaviorOnMxFailure properties: MailFromDomain: allOf: - $ref: '#/components/schemas/MailFromDomainName' - description: The name of a domain that an email identity uses as a custom MAIL FROM domain. MailFromDomainStatus: allOf: - $ref: '#/components/schemas/MailFromDomainStatus' - description:

The status of the MAIL FROM domain. This status can have the following values:

BehaviorOnMxFailure: allOf: - $ref: '#/components/schemas/BehaviorOnMxFailure' - description:

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

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

description: A list of attributes that are associated with a MAIL FROM domain. GetDeliverabilityDashboardOptionsResponse: type: object required: - DashboardEnabled properties: DashboardEnabled: allOf: - $ref: '#/components/schemas/Enabled' - description: Specifies whether the Deliverability dashboard is enabled. If this value is true, the dashboard is enabled. SubscriptionExpiryDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date when your current subscription to the Deliverability dashboard is scheduled to expire, if your subscription is scheduled to expire at the end of the current calendar month. This value is null if you have an active subscription that isn’t due to expire at the end of the month. AccountStatus: allOf: - $ref: '#/components/schemas/DeliverabilityDashboardAccountStatus' - description: The current status of your Deliverability dashboard subscription. If this value is PENDING_EXPIRATION, your subscription is scheduled to expire at the end of the current calendar month. ActiveSubscribedDomains: allOf: - $ref: '#/components/schemas/DomainDeliverabilityTrackingOptions' - description: An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at the end of the current calendar month. PendingExpirationSubscribedDomains: allOf: - $ref: '#/components/schemas/DomainDeliverabilityTrackingOptions' - description: An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that's scheduled to expire at the end of the current calendar month. description: An object that shows the status of the Deliverability dashboard. CaseId: type: string Counter: type: integer DeliverabilityTestReports: type: array items: $ref: '#/components/schemas/DeliverabilityTestReport' TagKey: type: string BulkEmailEntry: type: object required: - Destination properties: Destination: allOf: - $ref: '#/components/schemas/Destination' - description: '

Represents the destination of the message, consisting of To:, CC:, and BCC: fields.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a destination email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492.

' ReplacementTags: allOf: - $ref: '#/components/schemas/MessageTagList' - description: A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendBulkTemplatedEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events. ReplacementEmailContent: allOf: - $ref: '#/components/schemas/ReplacementEmailContent' - description: The ReplacementEmailContent associated with a BulkEmailEntry. PutConfigurationSetVdmOptionsResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. PlacementStatistics: type: object properties: InboxPercentage: allOf: - $ref: '#/components/schemas/Percentage' - description: The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test. SpamPercentage: allOf: - $ref: '#/components/schemas/Percentage' - description: The percentage of emails that arrived in recipients' spam or junk mail folders during the predictive inbox placement test. MissingPercentage: allOf: - $ref: '#/components/schemas/Percentage' - description: The percentage of emails that didn't arrive in recipients' inboxes at all during the predictive inbox placement test. SpfPercentage: allOf: - $ref: '#/components/schemas/Percentage' - description: The percentage of emails that were authenticated by using Sender Policy Framework (SPF) during the predictive inbox placement test. DkimPercentage: allOf: - $ref: '#/components/schemas/Percentage' - description: The percentage of emails that were authenticated by using DomainKeys Identified Mail (DKIM) during the predictive inbox placement test. description: An object that contains inbox placement data for an email provider. MetricDataResultList: type: array items: $ref: '#/components/schemas/MetricDataResult' QueryErrorCode: type: string enum: - INTERNAL_FAILURE - ACCESS_DENIED RecommendationDescription: type: string Policy: type: string description:

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

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

minLength: 1 VolumeStatistics: type: object properties: InboxRawCount: allOf: - $ref: '#/components/schemas/Volume' - description: The total number of emails that arrived in recipients' inboxes. SpamRawCount: allOf: - $ref: '#/components/schemas/Volume' - description: The total number of emails that arrived in recipients' spam or junk mail folders. ProjectedInbox: allOf: - $ref: '#/components/schemas/Volume' - description: An estimate of the percentage of emails sent from the current domain that will arrive in recipients' inboxes. ProjectedSpam: allOf: - $ref: '#/components/schemas/Volume' - description: An estimate of the percentage of emails sent from the current domain that will arrive in recipients' spam or junk mail folders. description: An object that contains information about the amount of email that was delivered to recipients. CreateContactResponse: type: object properties: {} ErrorMessage: type: string QueryIdentifier: type: string minLength: 1 maxLength: 255 AttributesData: type: string CreateImportJobResponse: type: object properties: JobId: allOf: - $ref: '#/components/schemas/JobId' - description: A string that represents the import job ID. description: An HTTP 200 response if the request succeeds, or an error message if the request fails. GetImportJobResponse: type: object properties: JobId: allOf: - $ref: '#/components/schemas/JobId' - description: A string that represents the import job ID. ImportDestination: allOf: - $ref: '#/components/schemas/ImportDestination' - description: The destination of the import job. ImportDataSource: allOf: - $ref: '#/components/schemas/ImportDataSource' - description: The data source of the import job. FailureInfo: allOf: - $ref: '#/components/schemas/FailureInfo' - description: The failure details about an import job. JobStatus: allOf: - $ref: '#/components/schemas/JobStatus' - description: The status of the import job. CreatedTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time stamp of when the import job was created. CompletedTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time stamp of when the import job was completed. ProcessedRecordsCount: allOf: - $ref: '#/components/schemas/ProcessedRecordsCount' - description: The current number of records processed. FailedRecordsCount: allOf: - $ref: '#/components/schemas/FailedRecordsCount' - description: The number of records that failed processing because of invalid input or other reasons. description: An HTTP 200 response if the request succeeds, or an error message if the request fails. TopicFilter: type: object properties: TopicName: allOf: - $ref: '#/components/schemas/TopicName' - description: The name of a topic on which you wish to apply the filter. UseDefaultIfPreferenceUnavailable: allOf: - $ref: '#/components/schemas/UseDefaultIfPreferenceUnavailable' - description: Notes that the default subscription status should be applied to a contact because the contact has not noted their preference for subscribing to a topic. description: Used for filtering by a specific topic preference. SubscriptionStatus: type: string enum: - OPT_IN - OPT_OUT Metric: type: string enum: - SEND - COMPLAINT - PERMANENT_BOUNCE - TRANSIENT_BOUNCE - OPEN - CLICK - DELIVERY - DELIVERY_OPEN - DELIVERY_CLICK - DELIVERY_COMPLAINT AmazonResourceName: type: string EmailTemplateName: type: string description: The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations. minLength: 1 MailFromDomainStatus: type: string enum: - PENDING - SUCCESS - FAILED - TEMPORARY_FAILURE description:

The status of the MAIL FROM domain. This status can have the following values:

JobStatus: type: string enum: - CREATED - PROCESSING - COMPLETED - FAILED description: The status of the import job. ContactListDestination: type: object required: - ContactListName - ContactListImportAction properties: ContactListName: allOf: - $ref: '#/components/schemas/ContactListName' - description: The name of the contact list. ContactListImportAction: allOf: - $ref: '#/components/schemas/ContactListImportAction' - description: '

>The type of action to perform on the addresses. The following are the possible values:

' description: An object that contains details about the action of a contact list. Topic: type: object required: - TopicName - DisplayName - DefaultSubscriptionStatus properties: TopicName: allOf: - $ref: '#/components/schemas/TopicName' - description: The name of the topic. DisplayName: allOf: - $ref: '#/components/schemas/DisplayName' - description: The name of the topic the contact will see. Description: allOf: - $ref: '#/components/schemas/Description' - description: A description of what the topic is about, which the contact will see. DefaultSubscriptionStatus: allOf: - $ref: '#/components/schemas/SubscriptionStatus' - description: The default subscription status to be applied to a contact if the contact has not noted their preference for subscribing to a topic. description: An interest group, theme, or label within a list. Lists can have multiple topics. Dimensions: type: object minProperties: 1 maxProperties: 3 additionalProperties: $ref: '#/components/schemas/MetricDimensionValue' CloudWatchDimensionConfigurations: type: array items: $ref: '#/components/schemas/CloudWatchDimensionConfiguration' RecommendationsList: type: array items: $ref: '#/components/schemas/Recommendation' ContactList: type: object properties: ContactListName: allOf: - $ref: '#/components/schemas/ContactListName' - description: The name of the contact list. LastUpdatedTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: A timestamp noting the last time the contact list was updated. description: A list that contains contacts that have subscribed to a particular topic or topics. WarmupStatus: type: string enum: - IN_PROGRESS - DONE description: The warmup status of a dedicated IP. DomainIspPlacements: type: array items: $ref: '#/components/schemas/DomainIspPlacement' GetDedicatedIpsResponse: type: object properties: DedicatedIps: allOf: - $ref: '#/components/schemas/DedicatedIpList' - description: A list of dedicated IP addresses that are associated with your Amazon Web Services account. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: A token that indicates that there are additional dedicated IP addresses to list. To view additional addresses, issue another request to GetDedicatedIps, passing this token in the NextToken parameter. description: Information about the dedicated IP addresses that are associated with your Amazon Web Services account. PutEmailIdentityConfigurationSetAttributesResponse: type: object properties: {} description: If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. KinesisFirehoseDestination: type: object required: - IamRoleArn - DeliveryStreamArn properties: IamRoleArn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses to send email events to the Amazon Kinesis Data Firehose stream. DeliveryStreamArn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that the Amazon SES API v2 sends email events to. description: An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift. DeliveryOptions: type: object properties: TlsPolicy: allOf: - $ref: '#/components/schemas/TlsPolicy' - description: Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established. SendingPoolName: allOf: - $ref: '#/components/schemas/PoolName' - description: The name of the dedicated IP pool to associate with the configuration set. description: Used to associate a configuration set with a dedicated IP pool. DeleteSuppressedDestinationResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. DkimSigningAttributesOrigin: type: string enum: - AWS_SES - EXTERNAL DedicatedIp: type: object required: - Ip - WarmupStatus - WarmupPercentage properties: Ip: allOf: - $ref: '#/components/schemas/Ip' - description: An IPv4 address. WarmupStatus: allOf: - $ref: '#/components/schemas/WarmupStatus' - description:

The warm-up status of a dedicated IP address. The status can have one of the following values:

WarmupPercentage: allOf: - $ref: '#/components/schemas/Percentage100Wrapper' - description: Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use. PoolName: allOf: - $ref: '#/components/schemas/PoolName' - description: The name of the dedicated IP pool that the IP address is associated with. description:

Contains information about a dedicated IP address that is associated with your Amazon SES account.

To learn more about requesting dedicated IP addresses, see Requesting and Relinquishing Dedicated IP Addresses in the Amazon SES Developer Guide.

DomainDeliverabilityTrackingOption: type: object properties: Domain: allOf: - $ref: '#/components/schemas/Domain' - description: A verified domain that’s associated with your Amazon Web Services account and currently has an active Deliverability dashboard subscription. SubscriptionStartDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date when you enabled the Deliverability dashboard for the domain. InboxPlacementTrackingOption: allOf: - $ref: '#/components/schemas/InboxPlacementTrackingOption' - description: An object that contains information about the inbox placement data settings for the domain. description: An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an active Deliverability dashboard subscription. If a Deliverability dashboard subscription is active for a domain, you gain access to reputation, inbox placement, and other metrics for the domain. Recommendation: type: object properties: ResourceArn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The resource affected by the recommendation, with values like arn:aws:ses:us-east-1:123456789012:identity/example.com. Type: allOf: - $ref: '#/components/schemas/RecommendationType' - description: The recommendation type, with values like DKIM, SPF, DMARC or BIMI. Description: allOf: - $ref: '#/components/schemas/RecommendationDescription' - description: The recommendation description / disambiguator - e.g. DKIM1 and DKIM2 are different recommendations about your DKIM setup. Status: allOf: - $ref: '#/components/schemas/RecommendationStatus' - description: The recommendation status, with values like OPEN or FIXED. CreatedTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: The first time this issue was encountered and the recommendation was generated. LastUpdatedTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: The last time the recommendation was updated. Impact: allOf: - $ref: '#/components/schemas/RecommendationImpact' - description: The recommendation impact, with values like HIGH or LOW. description: A recommendation generated for your account. MailFromDomainName: type: string description: The domain to use as a MAIL FROM domain. IdentityType: type: string enum: - EMAIL_ADDRESS - DOMAIN - MANAGED_DOMAIN GetDedicatedIpPoolResponse: type: object properties: DedicatedIpPool: allOf: - $ref: '#/components/schemas/DedicatedIpPool' - description: An object that contains information about a dedicated IP pool. description: The following element is returned by the service. CustomVerificationEmailTemplateMetadata: type: object properties: TemplateName: allOf: - $ref: '#/components/schemas/EmailTemplateName' - description: The name of the custom verification email template. FromEmailAddress: allOf: - $ref: '#/components/schemas/EmailAddress' - description: The email address that the custom verification email is sent from. TemplateSubject: allOf: - $ref: '#/components/schemas/EmailTemplateSubject' - description: The subject line of the custom verification email. SuccessRedirectionURL: allOf: - $ref: '#/components/schemas/SuccessRedirectionURL' - description: The URL that the recipient of the verification email is sent to if his or her address is successfully verified. FailureRedirectionURL: allOf: - $ref: '#/components/schemas/FailureRedirectionURL' - description: The URL that the recipient of the verification email is sent to if his or her address is not successfully verified. description: Contains information about a custom verification email template. Description: type: string VdmAttributes: type: object required: - VdmEnabled properties: VdmEnabled: allOf: - $ref: '#/components/schemas/FeatureStatus' - description:

Specifies the status of your VDM configuration. Can be one of the following:

DashboardAttributes: allOf: - $ref: '#/components/schemas/DashboardAttributes' - description: Specifies additional settings for your VDM configuration as applicable to the Dashboard. GuardianAttributes: allOf: - $ref: '#/components/schemas/GuardianAttributes' - description: Specifies additional settings for your VDM configuration as applicable to the Guardian. description: The VDM attributes that apply to your Amazon SES account. CreateEmailIdentityResponse: type: object properties: IdentityType: allOf: - $ref: '#/components/schemas/IdentityType' - description: 'The email identity type. Note: the MANAGED_DOMAIN identity type is not supported.' VerifiedForSendingStatus: allOf: - $ref: '#/components/schemas/Enabled' - description: Specifies whether or not the identity is verified. You can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide. DkimAttributes: allOf: - $ref: '#/components/schemas/DkimAttributes' - description: An object that contains information about the DKIM attributes for the identity. description:

If the email identity is a domain, this object contains information about the DKIM verification status for the domain.

If the email identity is an email address, this object is empty.

BlacklistingDescription: type: string description: A description of the blacklisting event. ListOfDedicatedIpPools: type: array description: A list of dedicated IP pools that are associated with your Amazon Web Services account. items: $ref: '#/components/schemas/PoolName' Domain: type: string UnsubscribeAll: type: boolean SendingOptions: type: object properties: SendingEnabled: allOf: - $ref: '#/components/schemas/Enabled' - description: If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set. description: Used to enable or disable email sending for messages that use this configuration set in the current Amazon Web Services Region. GetEmailIdentityPoliciesResponse: type: object properties: Policies: allOf: - $ref: '#/components/schemas/PolicyMap' - description: A map of policy names to policies. description: Identity policies associated with email identity. MaxSendRate: type: number format: double GetAccountResponse: type: object properties: DedicatedIpAutoWarmupEnabled: allOf: - $ref: '#/components/schemas/Enabled' - description: Indicates whether or not the automatic warm-up feature is enabled for dedicated IP addresses that are associated with your account. EnforcementStatus: allOf: - $ref: '#/components/schemas/GeneralEnforcementStatus' - description:

The reputation status of your Amazon SES account. The status can be one of the following:

ProductionAccessEnabled: allOf: - $ref: '#/components/schemas/Enabled' - description:

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

If the value is false, then your account is in the sandbox. When your account is in the sandbox, you can only send email to verified identities. Additionally, the maximum number of emails you can send in a 24-hour period (your sending quota) is 200, and the maximum number of emails you can send per second (your maximum sending rate) is 1.

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

SendQuota: allOf: - $ref: '#/components/schemas/SendQuota' - description: An object that contains information about the per-day and per-second sending limits for your Amazon SES account in the current Amazon Web Services Region. SendingEnabled: allOf: - $ref: '#/components/schemas/Enabled' - description: Indicates whether or not email sending is enabled for your Amazon SES account in the current Amazon Web Services Region. SuppressionAttributes: allOf: - $ref: '#/components/schemas/SuppressionAttributes' - description: An object that contains information about the email address suppression preferences for your account in the current Amazon Web Services Region. Details: allOf: - $ref: '#/components/schemas/AccountDetails' - description: An object that defines your account details. VdmAttributes: allOf: - $ref: '#/components/schemas/VdmAttributes' - description: The VDM attributes that apply to your Amazon SES account. description: A list of details about the email-sending capabilities of your Amazon SES account in the current Amazon Web Services Region. ListEmailTemplatesResponse: type: object properties: TemplatesMetadata: allOf: - $ref: '#/components/schemas/EmailTemplateMetadataList' - description: An array the contains the name and creation time stamp for each template in your Amazon SES account. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: A token indicating that there are additional email templates available to be listed. Pass this token to a subsequent ListEmailTemplates call to retrieve the next 10 email templates. description: The following elements are returned by the service. EmailTemplateSubject: type: string description: The subject line of the email. DeleteContactResponse: type: object properties: {} Subject: type: string NotFoundException: {} Content: type: object required: - Data properties: Data: allOf: - $ref: '#/components/schemas/MessageData' - description: The content of the message itself. Charset: allOf: - $ref: '#/components/schemas/Charset' - description: The character set for the content. Because of the constraints of the SMTP protocol, Amazon SES uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8, ISO-8859-1, or Shift_JIS. description: An object that represents the content of the email, and optionally a character set specification. GetCustomVerificationEmailTemplateResponse: type: object properties: TemplateName: allOf: - $ref: '#/components/schemas/EmailTemplateName' - description: The name of the custom verification email template. FromEmailAddress: allOf: - $ref: '#/components/schemas/EmailAddress' - description: The email address that the custom verification email is sent from. TemplateSubject: allOf: - $ref: '#/components/schemas/EmailTemplateSubject' - description: The subject line of the custom verification email. TemplateContent: allOf: - $ref: '#/components/schemas/TemplateContent' - description: The content of the custom verification email. SuccessRedirectionURL: allOf: - $ref: '#/components/schemas/SuccessRedirectionURL' - description: The URL that the recipient of the verification email is sent to if his or her address is successfully verified. FailureRedirectionURL: allOf: - $ref: '#/components/schemas/FailureRedirectionURL' - description: The URL that the recipient of the verification email is sent to if his or her address is not successfully verified. description: The following elements are returned by the service. DeleteEmailIdentityResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. ImageUrl: type: string TagResourceResponse: type: object properties: {} SendingPausedException: {} MailFromDomainNotVerifiedException: {} EmailTemplateHtml: type: string description: The HTML body of the email. CustomRedirectDomain: type: string description: The domain to use for tracking open and click events. ImportJobSummaryList: type: array description: A list of the import job summaries. items: $ref: '#/components/schemas/ImportJobSummary' UpdateContactListResponse: type: object properties: {} BadRequestException: {} SendQuota: type: object properties: Max24HourSend: allOf: - $ref: '#/components/schemas/Max24HourSend' - description: The maximum number of emails that you can send in the current Amazon Web Services Region over a 24-hour period. A value of -1 signifies an unlimited quota. (This value is also referred to as your sending quota.) MaxSendRate: allOf: - $ref: '#/components/schemas/MaxSendRate' - description: The maximum number of emails that you can send per second in the current Amazon Web Services Region. This value is also called your maximum sending rate or your maximum TPS (transactions per second) rate. SentLast24Hours: allOf: - $ref: '#/components/schemas/SentLast24Hours' - description: The number of emails sent from your Amazon SES account in the current Amazon Web Services Region over the past 24 hours. description: An object that contains information about the per-day and per-second sending limits for your Amazon SES account in the current Amazon Web Services Region. PinpointDestination: type: object properties: ApplicationArn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The Amazon Resource Name (ARN) of the Amazon Pinpoint project to send email events to. description: An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide. DeliverabilityDashboardAccountStatus: type: string enum: - ACTIVE - PENDING_EXPIRATION - DISABLED description: The current status of your Deliverability dashboard subscription. If this value is PENDING_EXPIRATION, your subscription is scheduled to expire at the end of the current calendar month. DedicatedIpPool: type: object required: - PoolName - ScalingMode properties: PoolName: allOf: - $ref: '#/components/schemas/PoolName' - description: The name of the dedicated IP pool. ScalingMode: allOf: - $ref: '#/components/schemas/ScalingMode' - description:

The type of the dedicated IP pool.

description: Contains information about a dedicated IP pool. DeliverabilityTestReport: type: object properties: ReportId: allOf: - $ref: '#/components/schemas/ReportId' - description: A unique string that identifies the predictive inbox placement test. ReportName: allOf: - $ref: '#/components/schemas/ReportName' - description: A name that helps you identify a predictive inbox placement test report. Subject: allOf: - $ref: '#/components/schemas/DeliverabilityTestSubject' - description: The subject line for an email that you submitted in a predictive inbox placement test. FromEmailAddress: allOf: - $ref: '#/components/schemas/EmailAddress' - description: The sender address that you specified for the predictive inbox placement test. CreateDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date and time when the predictive inbox placement test was created. DeliverabilityTestStatus: allOf: - $ref: '#/components/schemas/DeliverabilityTestStatus' - description: The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test. description: An object that contains metadata related to a predictive inbox placement test. S3Url: type: string pattern: ^s3:\/\/([^\/]+)\/(.*?([^\/]+)\/?)$ description: An Amazon S3 URL in the format s3://<bucket_name>/<object>. FailedRecordsCount: type: integer PutEmailIdentityMailFromAttributesResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. SentLast24Hours: type: number format: double SuppressionListImportAction: type: string enum: - DELETE - PUT description: '

The type of action to perform on the address. The following are possible values:

' PrivateKey: type: string pattern: ^[a-zA-Z0-9+\/]+={0,2}$ minLength: 1 maxLength: 20480 format: password GetEmailIdentityResponse: type: object properties: IdentityType: allOf: - $ref: '#/components/schemas/IdentityType' - description: 'The email identity type. Note: the MANAGED_DOMAIN identity type is not supported.' FeedbackForwardingStatus: allOf: - $ref: '#/components/schemas/Enabled' - description:

The feedback forwarding configuration for the identity.

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

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

VerifiedForSendingStatus: allOf: - $ref: '#/components/schemas/Enabled' - description: Specifies whether or not the identity is verified. You can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide. DkimAttributes: allOf: - $ref: '#/components/schemas/DkimAttributes' - description: An object that contains information about the DKIM attributes for the identity. MailFromAttributes: allOf: - $ref: '#/components/schemas/MailFromAttributes' - description: An object that contains information about the Mail-From attributes for the email identity. Policies: allOf: - $ref: '#/components/schemas/PolicyMap' - description: A map of policy names to policies. Tags: allOf: - $ref: '#/components/schemas/TagList' - description: An array of objects that define the tags (keys and values) that are associated with the email identity. ConfigurationSetName: allOf: - $ref: '#/components/schemas/ConfigurationSetName' - description: The configuration set used by default when sending from this identity. VerificationStatus: allOf: - $ref: '#/components/schemas/VerificationStatus' - description:

The verification status of the identity. The status can be one of the following:

description: Details about an email identity. ConcurrentModificationException: {} FailureRedirectionURL: type: string description: The URL that the recipient of the verification email is sent to if his or her address is not successfully verified. ProcessedRecordsCount: type: integer PutConfigurationSetSendingOptionsResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. SuccessRedirectionURL: type: string description: The URL that the recipient of the verification email is sent to if his or her address is successfully verified. CreateConfigurationSetEventDestinationResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. Destination: type: object properties: ToAddresses: allOf: - $ref: '#/components/schemas/EmailAddressList' - description: An array that contains the email addresses of the "To" recipients for the email. CcAddresses: allOf: - $ref: '#/components/schemas/EmailAddressList' - description: An array that contains the email addresses of the "CC" (carbon copy) recipients for the email. BccAddresses: allOf: - $ref: '#/components/schemas/EmailAddressList' - description: An array that contains the email addresses of the "BCC" (blind carbon copy) recipients for the email. description:

An object that describes the recipients for an email.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a destination email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492.

DomainDeliverabilityCampaign: type: object properties: CampaignId: allOf: - $ref: '#/components/schemas/CampaignId' - description: The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign. ImageUrl: allOf: - $ref: '#/components/schemas/ImageUrl' - description: The URL of an image that contains a snapshot of the email message that was sent. Subject: allOf: - $ref: '#/components/schemas/Subject' - description: The subject line, or title, of the email message. FromAddress: allOf: - $ref: '#/components/schemas/Identity' - description: The verified email address that the email message was sent from. SendingIps: allOf: - $ref: '#/components/schemas/IpList' - description: The IP addresses that were used to send the email message. FirstSeenDateTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The first time when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message. LastSeenDateTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The last time when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message. InboxCount: allOf: - $ref: '#/components/schemas/Volume' - description: The number of email messages that were delivered to recipients’ inboxes. SpamCount: allOf: - $ref: '#/components/schemas/Volume' - description: The number of email messages that were delivered to recipients' spam or junk mail folders. ReadRate: allOf: - $ref: '#/components/schemas/Percentage' - description: The percentage of email messages that were opened by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images. DeleteRate: allOf: - $ref: '#/components/schemas/Percentage' - description: The percentage of email messages that were deleted by recipients, without being opened first. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images. ReadDeleteRate: allOf: - $ref: '#/components/schemas/Percentage' - description: The percentage of email messages that were opened and then deleted by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images. ProjectedVolume: allOf: - $ref: '#/components/schemas/Volume' - description: The projected number of recipients that the email message was sent to. Esps: allOf: - $ref: '#/components/schemas/Esps' - description: The major email providers who handled the email message. description: An object that contains 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). ListSuppressedDestinationsResponse: type: object properties: SuppressedDestinationSummaries: allOf: - $ref: '#/components/schemas/SuppressedDestinationSummaries' - description: A list of summaries, each containing a summary for a suppressed email destination. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: A token that indicates that there are additional email addresses on the suppression list for your account. To view additional suppressed addresses, issue another request to ListSuppressedDestinations, and pass this token in the NextToken parameter. description: A list of suppressed email addresses. ListDomainDeliverabilityCampaignsResponse: type: object required: - DomainDeliverabilityCampaigns properties: DomainDeliverabilityCampaigns: allOf: - $ref: '#/components/schemas/DomainDeliverabilityCampaignList' - description: An array of responses, one for each campaign that used the domain to send email during the specified time range. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of the campaign in the list of campaigns. description: An array of objects that provide 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. SuppressionOptions: type: object properties: SuppressedReasons: allOf: - $ref: '#/components/schemas/SuppressionListReasons' - description:

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

description: An object that contains information about the suppression list preferences for your account. ListOfContacts: type: array items: $ref: '#/components/schemas/Contact' FeedbackId: type: string AdditionalContactEmailAddresses: type: array items: $ref: '#/components/schemas/AdditionalContactEmailAddress' minItems: 1 maxItems: 4 PutAccountDedicatedIpWarmupAttributesResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. EmailAddress: type: string PutConfigurationSetSuppressionOptionsResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. MessageTag: type: object required: - Name - Value properties: Name: allOf: - $ref: '#/components/schemas/MessageTagName' - description:

The name of the message tag. The message tag name has to meet the following criteria:

Value: allOf: - $ref: '#/components/schemas/MessageTagValue' - description:

The value of the message tag. The message tag value has to meet the following criteria:

description: 'Contains the name and value of a tag that you apply to an email. You can use message tags when you publish email sending events. ' DeleteConfigurationSetEventDestinationResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. ContactLanguage: type: string enum: - EN - JA CreateContactListResponse: type: object properties: {} GetDomainDeliverabilityCampaignResponse: type: object required: - DomainDeliverabilityCampaign properties: DomainDeliverabilityCampaign: allOf: - $ref: '#/components/schemas/DomainDeliverabilityCampaign' - description: An object that contains the deliverability data for the campaign. description: An object that contains 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. TopicPreferenceList: type: array items: $ref: '#/components/schemas/TopicPreference' CloudWatchDestination: type: object required: - DimensionConfigurations properties: DimensionConfigurations: allOf: - $ref: '#/components/schemas/CloudWatchDimensionConfigurations' - description: An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch. description: An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics. MetricDataResult: type: object properties: Id: allOf: - $ref: '#/components/schemas/QueryIdentifier' - description: The query identifier. Timestamps: allOf: - $ref: '#/components/schemas/TimestampList' - description: A list of timestamps for the metric data results. Values: allOf: - $ref: '#/components/schemas/MetricValueList' - description: A list of values (cumulative / sum) for the metric data results. description: The result of a single metric data query. VdmOptions: type: object properties: DashboardOptions: allOf: - $ref: '#/components/schemas/DashboardOptions' - description: Specifies additional settings for your VDM configuration as applicable to the Dashboard. GuardianOptions: allOf: - $ref: '#/components/schemas/GuardianOptions' - description: Specifies additional settings for your VDM configuration as applicable to the Guardian. description: An object that defines the VDM settings that apply to emails that you send using the configuration set. BatchGetMetricDataQuery: type: object required: - Id - Namespace - Metric - StartDate - EndDate properties: Id: allOf: - $ref: '#/components/schemas/QueryIdentifier' - description: The query identifier. Namespace: allOf: - $ref: '#/components/schemas/MetricNamespace' - description: 'The query namespace - e.g. VDM ' Metric: allOf: - $ref: '#/components/schemas/Metric' - description:

The queried metric. This can be one of the following:

Dimensions: allOf: - $ref: '#/components/schemas/Dimensions' - description: An object that contains mapping between MetricDimensionName and MetricDimensionValue to filter metrics by. StartDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: Represents the start date for the query interval. EndDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: Represents the end date for the query interval. description: Represents a single metric data query to include in a batch. QueryErrorMessage: type: string IspPlacements: type: array items: $ref: '#/components/schemas/IspPlacement' MailType: type: string enum: - MARKETING - TRANSACTIONAL EventTypes: type: array items: $ref: '#/components/schemas/EventType' AlreadyExistsException: {} MessageContent: type: string description: The body of an email message. ReportName: type: string description: A name that helps you identify a report generated by the Deliverability dashboard. PutEmailIdentityFeedbackAttributesResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. Identity: type: string minLength: 1 BulkEmailStatus: type: string enum: - SUCCESS - MESSAGE_REJECTED - MAIL_FROM_DOMAIN_NOT_VERIFIED - CONFIGURATION_SET_NOT_FOUND - TEMPLATE_NOT_FOUND - ACCOUNT_SUSPENDED - ACCOUNT_THROTTLED - ACCOUNT_DAILY_QUOTA_EXCEEDED - INVALID_SENDING_POOL_NAME - ACCOUNT_SENDING_PAUSED - CONFIGURATION_SET_SENDING_PAUSED - INVALID_PARAMETER - TRANSIENT_FAILURE - FAILED Enabled: type: boolean PutConfigurationSetReputationOptionsResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. TopicName: type: string SnsDestination: type: object required: - TopicArn properties: TopicArn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The Amazon Resource Name (ARN) of the Amazon SNS topic to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide. description: An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur. DashboardOptions: type: object properties: EngagementMetrics: allOf: - $ref: '#/components/schemas/FeatureStatus' - description:

Specifies the status of your VDM engagement metrics collection. Can be one of the following:

description: An object containing additional settings for your VDM configuration as applicable to the Dashboard. Percentage: type: number description: An object that contains information about inbox placement percentages. format: double UntagResourceResponse: type: object properties: {} CreateDedicatedIpPoolResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. ListContactsResponse: type: object properties: Contacts: allOf: - $ref: '#/components/schemas/ListOfContacts' - description: The contacts present in a specific contact list. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: A string token indicating that there might be additional contacts available to be listed. Copy this token to a subsequent call to ListContacts with the same parameters to retrieve the next page of contacts. PutDedicatedIpWarmupAttributesResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. IdentityInfoList: type: array items: $ref: '#/components/schemas/IdentityInfo' CreateConfigurationSetResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. DeleteConfigurationSetResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. SuppressedDestinationAttributes: type: object properties: MessageId: allOf: - $ref: '#/components/schemas/OutboundMessageId' - description: The unique identifier of the email message that caused the email address to be added to the suppression list for your account. FeedbackId: allOf: - $ref: '#/components/schemas/FeedbackId' - description: A unique identifier that's generated when an email address is added to the suppression list for your account. description: An object that contains additional attributes that are related an email address that is on the suppression list for your account. CreateEmailIdentityPolicyResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. IspNameList: type: array items: $ref: '#/components/schemas/IspName' DnsTokenList: type: array items: $ref: '#/components/schemas/DnsToken' ListContactListsResponse: type: object properties: ContactLists: allOf: - $ref: '#/components/schemas/ListOfContactLists' - description: The available contact lists. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: A string token indicating that there might be additional contact lists available to be listed. Copy this token to a subsequent call to ListContactLists with the same parameters to retrieve the next page of contact lists. ScalingMode: type: string enum: - STANDARD - MANAGED UpdateCustomVerificationEmailTemplateResponse: type: object properties: {} description: If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. EmailAddressList: type: array items: $ref: '#/components/schemas/EmailAddress' CampaignId: type: string TrackingOptions: type: object required: - CustomRedirectDomain properties: CustomRedirectDomain: allOf: - $ref: '#/components/schemas/CustomRedirectDomain' - description: The domain to use for tracking open and click events. description:

An object that defines the tracking options for a configuration set. When you use the Amazon SES API v2 to send an email, it contains an invisible image that's used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them.

These images and links include references to a domain operated by Amazon Web Services. You can optionally configure the Amazon SES to use a domain that you operate for these images and links.

RecommendationImpact: type: string enum: - LOW - HIGH RecommendationStatus: type: string enum: - OPEN - FIXED Contact: type: object properties: EmailAddress: allOf: - $ref: '#/components/schemas/EmailAddress' - description: The contact's email address. TopicPreferences: allOf: - $ref: '#/components/schemas/TopicPreferenceList' - description: The contact's preference for being opted-in to or opted-out of a topic. TopicDefaultPreferences: allOf: - $ref: '#/components/schemas/TopicPreferenceList' - description: The default topic preferences applied to the contact. UnsubscribeAll: allOf: - $ref: '#/components/schemas/UnsubscribeAll' - description: A boolean value status noting if the contact is unsubscribed from all contact list topics. LastUpdatedTimestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: A timestamp noting the last time the contact's information was updated. description: A contact is the end-user who is receiving the email. GetBlacklistReportsResponse: type: object required: - BlacklistReport properties: BlacklistReport: allOf: - $ref: '#/components/schemas/BlacklistReport' - description: An object that contains information about a blacklist that one of your dedicated IP addresses appears on. description: An object that contains information about blacklist events. MetricDataErrorList: type: array items: $ref: '#/components/schemas/MetricDataError' MetricValueList: type: array items: $ref: '#/components/schemas/Counter' InternalServiceErrorException: {} FeatureStatus: type: string enum: - ENABLED - DISABLED ImportDestination: type: object properties: SuppressionListDestination: allOf: - $ref: '#/components/schemas/SuppressionListDestination' - description: An object that contains the action of the import job towards suppression list. ContactListDestination: allOf: - $ref: '#/components/schemas/ContactListDestination' - description: An object that contains the action of the import job towards a contact list. description: An object that contains details about the resource destination the import job is going to target. EventType: type: string enum: - SEND - REJECT - BOUNCE - COMPLAINT - DELIVERY - OPEN - CLICK - RENDERING_FAILURE - DELIVERY_DELAY - SUBSCRIPTION description: An email sending event type. For example, email sends, opens, and bounces are all email events. AccountSuspendedException: {} AccountDetails: type: object properties: MailType: allOf: - $ref: '#/components/schemas/MailType' - description:

The type of email your account is sending. The mail type can be one of the following:

WebsiteURL: allOf: - $ref: '#/components/schemas/WebsiteURL' - description: The URL of your website. This information helps us better understand the type of content that you plan to send. ContactLanguage: allOf: - $ref: '#/components/schemas/ContactLanguage' - description: The language you would prefer for the case. The contact language can be one of ENGLISH or JAPANESE. UseCaseDescription: allOf: - $ref: '#/components/schemas/UseCaseDescription' - description: A description of the types of email that you plan to send. AdditionalContactEmailAddresses: allOf: - $ref: '#/components/schemas/AdditionalContactEmailAddresses' - description: Additional email addresses where updates are sent about your account review process. ReviewDetails: allOf: - $ref: '#/components/schemas/ReviewDetails' - description: Information about the review of the latest details you submitted. description: An object that contains information about your account details. PutEmailIdentityDkimAttributesResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. PutAccountVdmAttributesResponse: type: object properties: {} OutboundMessageId: type: string BlacklistItemName: type: string description: An IP address that you want to obtain blacklist information for. DeliverabilityTestStatus: type: string enum: - IN_PROGRESS - COMPLETED description: The status of a predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport operation to view the results of the test. GuardianOptions: type: object properties: OptimizedSharedDelivery: allOf: - $ref: '#/components/schemas/FeatureStatus' - description:

Specifies the status of your VDM optimized shared delivery. Can be one of the following:

description: An object containing additional settings for your VDM configuration as applicable to the Guardian. MessageTagValue: type: string description:

The value of the message tag. The message tag value has to meet the following criteria:

TooManyRequestsException: {} UseCaseDescription: type: string minLength: 1 maxLength: 5000 format: password DimensionValueSource: type: string enum: - MESSAGE_TAG - EMAIL_HEADER - LINK_TAG description: The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or SendRawEmail API, choose messageTag. To use your own email headers, choose emailHeader. To use link tags, choose linkTags. DeleteEmailIdentityPolicyResponse: type: object properties: {} description: An HTTP 200 response if the request succeeds, or an error message if the request fails. DeleteEmailTemplateResponse: type: object properties: {} description: If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. GetConfigurationSetResponse: type: object properties: ConfigurationSetName: allOf: - $ref: '#/components/schemas/ConfigurationSetName' - description: The name of the configuration set. TrackingOptions: allOf: - $ref: '#/components/schemas/TrackingOptions' - description: An object that defines the open and click tracking options for emails that you send using the configuration set. DeliveryOptions: allOf: - $ref: '#/components/schemas/DeliveryOptions' - description: An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set. ReputationOptions: allOf: - $ref: '#/components/schemas/ReputationOptions' - description: An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set. SendingOptions: allOf: - $ref: '#/components/schemas/SendingOptions' - description: An object that defines whether or not Amazon SES can send email that you send using the configuration set. Tags: allOf: - $ref: '#/components/schemas/TagList' - description: An array of objects that define the tags (keys and values) that are associated with the configuration set. SuppressionOptions: allOf: - $ref: '#/components/schemas/SuppressionOptions' - description: An object that contains information about the suppression list preferences for your account. VdmOptions: allOf: - $ref: '#/components/schemas/VdmOptions' - description: An object that contains information about the VDM preferences for your configuration set. description: Information about a configuration set. LimitExceededException: {} RawMessage: type: object required: - Data properties: Data: allOf: - $ref: '#/components/schemas/RawMessageData' - description:

The raw email message. The message has to meet the following criteria:

description: Represents the raw content of an email message. parameters: X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/email/ x-hasEquivalentPaths: true