openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 398 kB

JSON

{"openapi":"3.0.0","info":{"version":"2019-09-27","x-release":"v4","title":"Amazon Simple Email Service","description":"<fullname>Amazon SES API v2</fullname> <a href=\"http://aws.amazon.com/ses\">Amazon SES</a> 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 <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/\">Amazon Simple Email Service Developer Guide</a>. 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://twitter.com/awscloud/profile_image?size=original","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},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/email/"},"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)"}],"x-hasEquivalentPaths":true,"paths":{"/v2/email/metrics/batch":{"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}}}}}}},"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"}]},"/v2/email/configuration-sets":{"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 <code>Require</code>, messages are only delivered if a TLS connection can be established. If the value is <code>Optional</code>, 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 <code>true</code>, tracking of reputation metrics is enabled for the configuration set. If <code>false</code>, 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 <code>true</code>, email sending is enabled for the configuration set. If <code>false</code>, 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: <ul> <li> <code>COMPLAINT</code> – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint. </li> <li> <code>BOUNCE</code> – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce. </li> </ul>"}]}}},"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."}]}}}}}}}}},"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":"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 <code>ListConfigurationSets</code> 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 <code>ListConfigurationSets</code>. If the number of results is larger than the number you specified in this parameter, then the response includes a <code>NextToken</code> element, which you can use to obtain additional results.","schema":{"type":"integer"}}]}},"/v2/email/configuration-sets/{ConfigurationSetName}/event-destinations":{"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 <code>true</code>, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this <code>EventDestinationDefinition</code>. If <code>false</code>, 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 <code>EventDestinationDefinition</code>."}]},"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 <a href=\"https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html\">Transactional Messaging Charts</a> in the Amazon Pinpoint User Guide."}]}}}}}}}}},"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":"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."}}]}},"/v2/email/contact-lists/{ContactListName}/contacts":{"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"}}}}}}},"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":"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 <code>NextToken</code> element is sent in the response. Use the <code>NextToken</code> 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: <code>OPT_IN</code> or <code>OPT_OUT</code>."}]},"TopicFilter":{"allOf":[{"$ref":"#/components/schemas/TopicFilter"},{"description":"Used for filtering by a specific topic preference."}]}}}}}}}}}},"/v2/email/contact-lists":{"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"}}}}}}}},"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":"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 <code>NextToken</code> element is sent in the response. Use the <code>NextToken</code> 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"}}]}},"/v2/email/custom-verification-email-templates":{"post":{"operationId":"CreateCustomVerificationEmailTemplate","description":"Creates a new custom verification email template. For more information about custom verification email templates, see <a href=\"https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom\">Using custom verification email templates</a> 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 <code>SendTemplatedEmail</code> or <code>SendBulkTemplatedEmail</code> 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"}}}}}}},"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":"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 <a href=\"https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom\">Using custom verification email templates</a> 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 <code>ListCustomVerificationEmailTemplates</code> 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 <code>ListCustomVerificationEmailTemplates</code>. If the number of results is larger than the number you specified in this parameter, then the response includes a <code>NextToken</code> 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"}}]}},"/v2/email/dedicated-ip-pools":{"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"]}}}}}}},"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":"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 <code>ListDedicatedIpPools</code> 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 <code>ListDedicatedIpPools</code>. If the number of results is larger than the number you specified in this parameter, then the response includes a <code>NextToken</code> element, which you can use to obtain additional results.","schema":{"type":"integer"}}]}},"/v2/email/deliverability-dashboard/test":{"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 <code>GetDeliverabilityTestReport</code> 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: <ul> <li> The message has to contain a header and a body, separated by one blank line. </li> <li> All of the required header fields must be present in the message. </li> <li> Each part of a multipart MIME message must be formatted properly. </li> <li> If you include attachments, they must be in a file format that the Amazon SES API v2 supports. </li> <li> The entire message must be Base64 encoded. </li> <li> If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly. </li> <li> The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in <a href=\"https://tools.ietf.org/html/rfc5321\">RFC 5321</a>. </li> </ul>"}]},"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"}}}}}}}},"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"}]},"/v2/email/identities":{"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 <code>DkimSigningAttributes</code> 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 <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html\">Easy DKIM</a>. 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 <code>CreateEmailIdentity</code> operation has to include the <code>DkimSigningAttributes</code> 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"}}}}}}},"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":"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 <code>ListEmailIdentities</code> 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 <code>ListEmailIdentities</code>. If the number of results is larger than the number you specified in this parameter, then the response includes a <code>NextToken</code> 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"}}]}},"/v2/email/identities/{EmailIdentity}/policies/{PolicyName}":{"post":{"operationId":"CreateEmailIdentityPolicy","description":"Creates the specified sending authorization policy for the given identity (an email address or a domain). <note> This API is for the identity owner only. If you have not verified the identity, this API will return an error. </note> Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>. 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","require