<?php
// This file was auto-generated from sdk-root/src/data/sesv2/2019-09-27/docs-2.json
return [ 'version' => '2.0', 'service' => '<fullname>Amazon SES API v2</fullname> <p> <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.</p> <p>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 <i>Amazon SES Developer Guide</i> provides information and code samples that demonstrate how to use Amazon SES API v2 features programmatically.</p>', 'operations' => [ 'BatchGetMetricData' => '<p>Retrieves batches of metric data collected based on your sending activity.</p> <p>You can execute this operation no more than 16 times per second, and with at most 160 queries from the batches per second (cumulative).</p>', 'CancelExportJob' => '<p>Cancels an export job.</p>', 'CreateConfigurationSet' => '<p>Create a configuration set. <i>Configuration sets</i> 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. </p>', 'CreateConfigurationSetEventDestination' => '<p>Create an event destination. <i>Events</i> include message sends, deliveries, opens, clicks, bounces, and complaints. <i>Event destinations</i> are places that you can send information about these events to. For example, you can send event data to Amazon EventBridge and associate a rule to send the event to the specified target.</p> <p>A single configuration set can include more than one event destination.</p>', 'CreateContact' => '<p>Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list.</p>', 'CreateContactList' => '<p>Creates a contact list.</p>', 'CreateCustomVerificationEmailTemplate' => '<p>Creates a new custom verification email template.</p> <p>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 <i>Amazon SES Developer Guide</i>.</p> <p>You can execute this operation no more than once per second.</p>', 'CreateDedicatedIpPool' => '<p>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.</p>', 'CreateDeliverabilityTestReport' => '<p>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.</p>', 'CreateEmailIdentity' => '<p>Starts the process of verifying an email identity. An <i>identity</i> 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.</p> <p>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. </p> <p>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>.</p> <p>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.</p> <p>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.</p> <p>Additionally, you can associate an existing configuration set with the email identity that you\'re verifying.</p>', 'CreateEmailIdentityPolicy' => '<p>Creates the specified sending authorization policy for the given identity (an email address or a domain).</p> <note> <p>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</p> </note> <p>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>.</p> <p>You can execute this operation no more than once per second.</p>', 'CreateEmailTemplate' => '<p>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 <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html">Amazon SES Developer Guide</a>.</p> <p>You can execute this operation no more than once per second.</p>', 'CreateExportJob' => '<p>Creates an export job for a data source and destination.</p> <p>You can execute this operation no more than once per second.</p>', 'CreateImportJob' => '<p>Creates an import job for a data destination.</p>', 'CreateMultiRegionEndpoint' => '<p>Creates a multi-region endpoint (global-endpoint).</p> <p>The primary region is going to be the AWS-Region where the operation is executed. The secondary region has to be provided in request\'s parameters. From the data flow standpoint there is no difference between primary and secondary regions - sending traffic will be split equally between the two. The primary region is the region where the resource has been created and where it can be managed. </p>', 'CreateTenant' => '<p>Create a tenant.</p> <p> <i>Tenants</i> are logical containers that group related SES resources together. Each tenant can have its own set of resources like email identities, configuration sets, and templates, along with reputation metrics and sending status. This helps isolate and manage email sending for different customers or business units within your Amazon SES API v2 account.</p>', 'CreateTenantResourceAssociation' => '<p>Associate a resource with a tenant.</p> <p> <i>Resources</i> can be email identities, configuration sets, or email templates. When you associate a resource with a tenant, you can use that resource when sending emails on behalf of that tenant.</p> <p>A single resource can be associated with multiple tenants, allowing for resource sharing across different tenants while maintaining isolation in email sending operations.</p>', 'DeleteConfigurationSet' => '<p>Delete an existing configuration set.</p> <p> <i>Configuration sets</i> 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.</p>', 'DeleteConfigurationSetEventDestination' => '<p>Delete an event destination.</p> <p> <i>Events</i> include message sends, deliveries, opens, clicks, bounces, and complaints. <i>Event destinations</i> are places that you can send information about these events to. For example, you can send event data to Amazon EventBridge and associate a rule to send the event to the specified target.</p>', 'DeleteContact' => '<p>Removes a contact from a contact list.</p>', 'DeleteContactList' => '<p>Deletes a contact list and all of the contacts on that list.</p>', 'DeleteCustomVerificationEmailTemplate' => '<p>Deletes an existing custom verification email template.</p> <p>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 <i>Amazon SES Developer Guide</i>.</p> <p>You can execute this operation no more than once per second.</p>', 'DeleteDedicatedIpPool' => '<p>Delete a dedicated IP pool.</p>', 'DeleteEmailIdentity' => '<p>Deletes an email identity. An identity can be either an email address or a domain name.</p>', 'DeleteEmailIdentityPolicy' => '<p>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.</p> <note> <p>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</p> </note> <p>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>.</p> <p>You can execute this operation no more than once per second.</p>', 'DeleteEmailTemplate' => '<p>Deletes an email template.</p> <p>You can execute this operation no more than once per second.</p>', 'DeleteMultiRegionEndpoint' => '<p>Deletes a multi-region endpoint (global-endpoint).</p> <p>Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is executed can be deleted.</p>', 'DeleteSuppressedDestination' => '<p>Removes an email address from the suppression list for your account.</p>', 'DeleteTenant' => '<p>Delete an existing tenant.</p> <p>When you delete a tenant, its associations with resources are removed, but the resources themselves are not deleted.</p>', 'DeleteTenantResourceAssociation' => '<p>Delete an association between a tenant and a resource.</p> <p>When you delete a tenant-resource association, the resource itself is not deleted, only its association with the specific tenant is removed. After removal, the resource will no longer be available for use with that tenant\'s email sending operations.</p>', 'GetAccount' => '<p>Obtain information about the email-sending status and capabilities of your Amazon SES account in the current Amazon Web Services Region.</p>', 'GetBlacklistReports' => '<p>Retrieve a list of the blacklists that your dedicated IP addresses appear on.</p>', 'GetConfigurationSet' => '<p>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.</p> <p> <i>Configuration sets</i> 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.</p>', 'GetConfigurationSetEventDestinations' => '<p>Retrieve a list of event destinations that are associated with a configuration set.</p> <p> <i>Events</i> include message sends, deliveries, opens, clicks, bounces, and complaints. <i>Event destinations</i> are places that you can send information about these events to. For example, you can send event data to Amazon EventBridge and associate a rule to send the event to the specified target.</p>', 'GetContact' => '<p>Returns a contact from a contact list.</p>', 'GetContactList' => '<p>Returns contact list metadata. It does not return any information about the contacts present in the list.</p>', 'GetCustomVerificationEmailTemplate' => '<p>Returns the custom email verification template for the template name you specify.</p> <p>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 <i>Amazon SES Developer Guide</i>.</p> <p>You can execute this operation no more than once per second.</p>', 'GetDedicatedIp' => '<p>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.</p>', 'GetDedicatedIpPool' => '<p>Retrieve information about the dedicated pool.</p>', 'GetDedicatedIps' => '<p>List the dedicated IP addresses that are associated with your Amazon Web Services account.</p>', 'GetDeliverabilityDashboardOptions' => '<p>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.</p> <p>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 <a href="http://aws.amazon.com/ses/pricing/">Amazon SES Pricing</a>.</p>', 'GetDeliverabilityTestReport' => '<p>Retrieve the results of a predictive inbox placement test.</p>', 'GetDomainDeliverabilityCampaign' => '<p>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.</p>', 'GetDomainStatisticsReport' => '<p>Retrieve inbox placement and engagement rates for the domains that you use to send email.</p>', 'GetEmailIdentity' => '<p>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.</p>', 'GetEmailIdentityPolicies' => '<p>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.</p> <note> <p>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</p> </note> <p>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>.</p> <p>You can execute this operation no more than once per second.</p>', 'GetEmailTemplate' => '<p>Displays the template object (which includes the subject line, HTML part and text part) for the template you specify.</p> <p>You can execute this operation no more than once per second.</p>', 'GetExportJob' => '<p>Provides information about an export job.</p>', 'GetImportJob' => '<p>Provides information about an import job.</p>', 'GetMessageInsights' => '<p>Provides information about a specific message, including the from address, the subject, the recipient address, email tags, as well as events associated with the message.</p> <p>You can execute this operation no more than once per second.</p>', 'GetMultiRegionEndpoint' => '<p>Displays the multi-region endpoint (global-endpoint) configuration.</p> <p>Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is executed can be displayed.</p>', 'GetReputationEntity' => '<p>Retrieve information about a specific reputation entity, including its reputation management policy, customer-managed status, Amazon Web Services Amazon SES-managed status, and aggregate sending status.</p> <p> <i>Reputation entities</i> represent resources in your Amazon SES account that have reputation tracking and management capabilities. The reputation impact reflects the highest impact reputation finding for the entity. Reputation findings can be retrieved using the <code>ListRecommendations</code> operation.</p>', 'GetSuppressedDestination' => '<p>Retrieves information about a specific email address that\'s on the suppression list for your account.</p>', 'GetTenant' => '<p>Get information about a specific tenant, including the tenant\'s name, ID, ARN, creation timestamp, tags, and sending status.</p>', 'ListConfigurationSets' => '<p>List all of the configuration sets associated with your account in the current region.</p> <p> <i>Configuration sets</i> 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.</p>', 'ListContactLists' => '<p>Lists all of the contact lists available.</p> <p>If your output includes a "NextToken" field with a string value, this indicates there may be additional contacts on the filtered list - regardless of the number of contacts returned.</p>', 'ListContacts' => '<p>Lists the contacts present in a specific contact list.</p>', 'ListCustomVerificationEmailTemplates' => '<p>Lists the existing custom verification email templates for your account in the current Amazon Web Services Region.</p> <p>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 <i>Amazon SES Developer Guide</i>.</p> <p>You can execute this operation no more than once per second.</p>', 'ListDedicatedIpPools' => '<p>List all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region.</p>', 'ListDeliverabilityTestReports' => '<p>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 <code>GetDeliverabilityTestReport</code> operation to view the results.</p>', 'ListDomainDeliverabilityCampaigns' => '<p>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.</p>', 'ListEmailIdentities' => '<p>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.</p>', 'ListEmailTemplates' => '<p>Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region.</p> <p>You can execute this operation no more than once per second.</p>', 'ListExportJobs' => '<p>Lists all of the export jobs.</p>', 'ListImportJobs' => '<p>Lists all of the import jobs.</p>', 'ListMultiRegionEndpoints' => '<p>List the multi-region endpoints (global-endpoints).</p> <p>Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is executed will be listed.</p>', 'ListRecommendations' => '<p>Lists the recommendations present in your Amazon SES account in the current Amazon Web Services Region.</p> <p>You can execute this operation no more than once per second.</p>', 'ListReputationEntities' => '<p>List reputation entities in your Amazon SES account in the current Amazon Web Services Region. You can filter the results by entity type, reputation impact, sending status, or entity reference prefix.</p> <p> <i>Reputation entities</i> represent resources in your account that have reputation tracking and management capabilities. Use this operation to get an overview of all entities and their current reputation status.</p>', 'ListResourceTenants' => '<p>List all tenants associated with a specific resource.</p> <p>This operation returns a list of tenants that are associated with the specified resource. This is useful for understanding which tenants are currently using a particular resource such as an email identity, configuration set, or email template.</p>', 'ListSuppressedDestinations' => '<p>Retrieves a list of email addresses that are on the suppression list for your account.</p>', 'ListTagsForResource' => '<p>Retrieve a list of the tags (keys and values) that are associated with a specified resource. A <i>tag</i> is a label that you optionally define and associate with a resource. Each tag consists of a required <i>tag key</i> and an optional associated <i>tag value</i>. 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.</p>', 'ListTenantResources' => '<p>List all resources associated with a specific tenant.</p> <p>This operation returns a list of resources (email identities, configuration sets, or email templates) that are associated with the specified tenant. You can optionally filter the results by resource type.</p>', 'ListTenants' => '<p>List all tenants associated with your account in the current Amazon Web Services Region.</p> <p>This operation returns basic information about each tenant, such as tenant name, ID, ARN, and creation timestamp.</p>', 'PutAccountDedicatedIpWarmupAttributes' => '<p>Enable or disable the automatic warm-up feature for dedicated IP addresses.</p>', 'PutAccountDetails' => '<p>Update your Amazon SES account details.</p>', 'PutAccountSendingAttributes' => '<p>Enable or disable the ability of your account to send email.</p>', 'PutAccountSuppressionAttributes' => '<p>Change the settings for the account-level suppression list.</p>', 'PutAccountVdmAttributes' => '<p>Update your Amazon SES account VDM attributes.</p> <p>You can execute this operation no more than once per second.</p>', 'PutConfigurationSetArchivingOptions' => '<p>Associate the configuration set with a MailManager archive. When you send email using the <code>SendEmail</code> or <code>SendBulkEmail</code> operations the message as it will be given to the receiving SMTP server will be archived, along with the recipient information.</p>', 'PutConfigurationSetDeliveryOptions' => '<p>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.</p>', 'PutConfigurationSetReputationOptions' => '<p>Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific Amazon Web Services Region.</p>', 'PutConfigurationSetSendingOptions' => '<p>Enable or disable email sending for messages that use a particular configuration set in a specific Amazon Web Services Region.</p>', 'PutConfigurationSetSuppressionOptions' => '<p>Specify the account suppression list preferences for a configuration set.</p>', 'PutConfigurationSetTrackingOptions' => '<p>Specify a custom domain to use for open and click tracking elements in email that you send.</p>', 'PutConfigurationSetVdmOptions' => '<p>Specify VDM preferences for email that you send using the configuration set.</p> <p>You can execute this operation no more than once per second.</p>', 'PutDedicatedIpInPool' => '<p>Move a dedicated IP address to an existing dedicated IP pool.</p> <note> <p>The dedicated IP address that you specify must already exist, and must be associated with your Amazon Web Services account. </p> <p>The dedicated IP pool you specify must already exist. You can create a new pool by using the <code>CreateDedicatedIpPool</code> operation.</p> </note>', 'PutDedicatedIpPoolScalingAttributes' => '<p>Used to convert a dedicated IP pool to a different scaling mode.</p> <note> <p> <code>MANAGED</code> pools cannot be converted to <code>STANDARD</code> scaling mode.</p> </note>', 'PutDedicatedIpWarmupAttributes' => '<p/>', 'PutDeliverabilityDashboardOption' => '<p>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.</p> <p>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 <a href="http://aws.amazon.com/ses/pricing/">Amazon SES Pricing</a>.</p>', 'PutEmailIdentityConfigurationSetAttributes' => '<p>Used to associate a configuration set with an email identity.</p>', 'PutEmailIdentityDkimAttributes' => '<p>Used to enable or disable DKIM authentication for an email identity.</p>', 'PutEmailIdentityDkimSigningAttributes' => '<p>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:</p> <ul> <li> <p>Update the signing attributes for an identity that uses Bring Your Own DKIM (BYODKIM).</p> </li> <li> <p>Update the key length that should be used for Easy DKIM.</p> </li> <li> <p>Change from using no DKIM authentication to using Easy DKIM.</p> </li> <li> <p>Change from using no DKIM authentication to using BYODKIM.</p> </li> <li> <p>Change from using Easy DKIM to using BYODKIM.</p> </li> <li> <p>Change from using BYODKIM to using Easy DKIM.</p> </li> </ul>', 'PutEmailIdentityFeedbackAttributes' => '<p>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.</p> <p>If the value is <code>true</code>, you receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the <code>Return-Path</code> header of the original email.</p> <p>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).</p>', 'PutEmailIdentityMailFromAttributes' => '<p>Used to enable or disable the custom Mail-From domain configuration for an email identity.</p>', 'PutSuppressedDestination' => '<p>Adds an email address to the suppression list for your account.</p>', 'SendBulkEmail' => '<p>Composes an email message to multiple destinations.</p>', 'SendCustomVerificationEmail' => '<p>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.</p> <p>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 <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 <i>Amazon SES Developer Guide</i>.</p> <p>You can execute this operation no more than once per second.</p>', 'SendEmail' => '<p>Sends an email message. You can use the Amazon SES API v2 to send the following types of messages:</p> <ul> <li> <p> <b>Simple</b> – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon SES assembles the message for you.</p> </li> <li> <p> <b>Raw</b> – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message.</p> </li> <li> <p> <b>Templated</b> – A message that contains personalization tags. When you send this type of email, Amazon SES API v2 automatically replaces the tags with values that you specify.</p> </li> </ul>', 'TagResource' => '<p>Add one or more tags (keys and values) to a specified resource. A <i>tag</i> 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.</p> <p>Each tag consists of a required <i>tag key</i> and an associated <i>tag value</i>, 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.</p>', 'TestRenderEmailTemplate' => '<p>Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.</p> <p>You can execute this operation no more than once per second.</p>', 'UntagResource' => '<p>Remove one or more tags (keys and values) from a specified resource.</p>', 'UpdateConfigurationSetEventDestination' => '<p>Update the configuration of an event destination for a configuration set.</p> <p> <i>Events</i> include message sends, deliveries, opens, clicks, bounces, and complaints. <i>Event destinations</i> are places that you can send information about these events to. For example, you can send event data to Amazon EventBridge and associate a rule to send the event to the specified target.</p>', 'UpdateContact' => '<p>Updates a contact\'s preferences for a list.</p> <note> <p>You must specify all existing topic preferences in the <code>TopicPreferences</code> object, not just the ones that need updating; otherwise, all your existing preferences will be removed.</p> </note>', 'UpdateContactList' => '<p>Updates contact list metadata. This operation does a complete replacement.</p>', 'UpdateCustomVerificationEmailTemplate' => '<p>Updates an existing custom verification email template.</p> <p>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 <i>Amazon SES Developer Guide</i>.</p> <p>You can execute this operation no more than once per second.</p>', 'UpdateEmailIdentityPolicy' => '<p>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.</p> <note> <p>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</p> </note> <p>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>.</p> <p>You can execute this operation no more than once per second.</p>', 'UpdateEmailTemplate' => '<p>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 <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html">Amazon SES Developer Guide</a>.</p> <p>You can execute this operation no more than once per second.</p>', 'UpdateReputationEntityCustomerManagedStatus' => '<p>Update the customer-managed sending status for a reputation entity. This allows you to enable, disable, or reinstate sending for the entity.</p> <p>The customer-managed status works in conjunction with the Amazon Web Services Amazon SES-managed status to determine the overall sending capability. When you update the customer-managed status, the Amazon Web Services Amazon SES-managed status remains unchanged. If Amazon Web Services Amazon SES has disabled the entity, it will not be allowed to send regardless of the customer-managed status setting. When you reinstate an entity through the customer-managed status, it can continue sending only if the Amazon Web Services Amazon SES-managed status also permits sending, even if there are active reputation findings, until the findings are resolved or new violations occur.</p>', 'UpdateReputationEntityPolicy' => '<p>Update the reputation management policy for a reputation entity. The policy determines how the entity responds to reputation findings, such as automatically pausing sending when certain thresholds are exceeded.</p> <p>Reputation management policies are Amazon Web Services Amazon SES-managed (predefined policies). You can select from none, standard, and strict policies.</p>', ], 'shapes' => [ 'AccountDetails' => [ 'base' => '<p>An object that contains information about your account details.</p>', 'refs' => [ 'GetAccountResponse$Details' => '<p>An object that defines your account details.</p>', ], ], 'AccountSuspendedException' => [ 'base' => '<p>The message can\'t be sent because the account\'s ability to send email has been permanently restricted.</p>', 'refs' => [], ], 'AdditionalContactEmailAddress' => [ 'base' => NULL, 'refs' => [ 'AdditionalContactEmailAddresses$member' => NULL, ], ], 'AdditionalContactEmailAddresses' => [ 'base' => NULL, 'refs' => [ 'AccountDetails$AdditionalContactEmailAddresses' => '<p>Additional email addresses where updates are sent about your account review process.</p>', 'PutAccountDetailsRequest$AdditionalContactEmailAddresses' => '<p>Additional email addresses that you would like to be notified regarding Amazon SES matters.</p>', ], ], 'AdminEmail' => [ 'base' => NULL, 'refs' => [ 'SOARecord$AdminEmail' => '<p>Administrative contact email from the SOA record.</p>', ], ], 'AlreadyExistsException' => [ 'base' => '<p>The resource specified in your request already exists.</p>', 'refs' => [], ], 'AmazonResourceName' => [ 'base' => NULL, 'refs' => [ 'CreateTenantResourceAssociationRequest$ResourceArn' => '<p>The Amazon Resource Name (ARN) of the resource to associate with the tenant.</p>', 'CreateTenantResponse$TenantArn' => '<p>The Amazon Resource Name (ARN) of the tenant.</p>', 'DeleteTenantResourceAssociationRequest$ResourceArn' => '<p>The Amazon Resource Name (ARN) of the resource to remove from the tenant association.</p>', 'EventBridgeDestination$EventBusArn' => '<p>The Amazon Resource Name (ARN) of the Amazon EventBridge bus to publish email events to. Only the default bus is supported. </p>', 'KinesisFirehoseDestination$IamRoleArn' => '<p>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.</p>', 'KinesisFirehoseDestination$DeliveryStreamArn' => '<p>The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that the Amazon SES API v2 sends email events to.</p>', 'ListResourceTenantsRequest$ResourceArn' => '<p>The Amazon Resource Name (ARN) of the resource to list associated tenants for.</p>', 'ListTagsForResourceRequest$ResourceArn' => '<p>The Amazon Resource Name (ARN) of the resource that you want to retrieve tag information for.</p>', 'PinpointDestination$ApplicationArn' => '<p>The Amazon Resource Name (ARN) of the Amazon Pinpoint project to send email events to.</p>', 'Recommendation$ResourceArn' => '<p>The resource affected by the recommendation, with values like <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</p>', 'ReputationEntity$ReputationManagementPolicy' => '<p>The Amazon Resource Name (ARN) of the reputation management policy applied to this entity. This is an Amazon Web Services Amazon SES-managed policy.</p>', 'ResourceTenantMetadata$ResourceArn' => '<p>The Amazon Resource Name (ARN) of the resource.</p>', 'SendBulkEmailRequest$FromEmailAddressIdentityArn' => '<p>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 <code>FromEmailAddress</code> parameter.</p> <p>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 <code>FromEmailAddressIdentityArn</code> to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the <code>FromEmailAddress</code> to be sender@example.com.</p> <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>.</p>', 'SendBulkEmailRequest$FeedbackForwardingEmailAddressIdentityArn' => '<p>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 <code>FeedbackForwardingEmailAddress</code> parameter.</p> <p>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 <code>FeedbackForwardingEmailAddressIdentityArn</code> to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the <code>FeedbackForwardingEmailAddress</code> to be feedback@example.com.</p> <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>.</p>', 'SendEmailRequest$FromEmailAddressIdentityArn' => '<p>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 <code>FromEmailAddress</code> parameter.</p> <p>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 <code>FromEmailAddressIdentityArn</code> to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the <code>FromEmailAddress</code> to be sender@example.com.</p> <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>.</p> <p>For Raw emails, the <code>FromEmailAddressIdentityArn</code> value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.</p>', 'SendEmailRequest$FeedbackForwardingEmailAddressIdentityArn' => '<p>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 <code>FeedbackForwardingEmailAddress</code> parameter.</p> <p>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 <code>FeedbackForwardingEmailAddressIdentityArn</code> to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the <code>FeedbackForwardingEmailAddress</code> to be feedback@example.com.</p> <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>.</p>', 'SnsDestination$TopicArn' => '<p>The Amazon Resource Name (ARN) of the Amazon SNS topic to publish email events to. For more information about Amazon SNS topics, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html">Amazon SNS Developer Guide</a>.</p>', 'TagResourceRequest$ResourceArn' => '<p>The Amazon Resource Name (ARN) of the resource that you want to add one or more tags to.</p>', 'Template$TemplateArn' => '<p>The Amazon Resource Name (ARN) of the template.</p>', 'Tenant$TenantArn' => '<p>The Amazon Resource Name (ARN) of the tenant.</p>', 'TenantInfo$TenantArn' => '<p>The Amazon Resource Name (ARN) of the tenant.</p>', 'TenantResource$ResourceArn' => '<p>The Amazon Resource Name (ARN) of the resource associated with the tenant.</p>', 'UntagResourceRequest$ResourceArn' => '<p>The Amazon Resource Name (ARN) of the resource that you want to remove one or more tags from.</p>', 'UpdateReputationEntityPolicyRequest$ReputationEntityPolicy' => '<p>The Amazon Resource Name (ARN) of the reputation management policy to apply to this entity. This is an Amazon Web Services Amazon SES-managed policy.</p>', ], ], 'ArchiveArn' => [ 'base' => NULL, 'refs' => [ 'ArchivingOptions$ArchiveArn' => '<p>The Amazon Resource Name (ARN) of the MailManager archive where the Amazon SES API v2 will archive sent emails.</p>', 'PutConfigurationSetArchivingOptionsRequest$ArchiveArn' => '<p>The Amazon Resource Name (ARN) of the MailManager archive that the Amazon SES API v2 sends email to.</p>', ], ], 'ArchivingOptions' => [ 'base' => '<p>Used to associate a configuration set with a MailManager archive.</p>', 'refs' => [ 'CreateConfigurationSetRequest$ArchivingOptions' => '<p>An object that defines the MailManager archiving options for emails that you send using the configuration set.</p>', 'GetConfigurationSetResponse$ArchivingOptions' => '<p>An object that defines the MailManager archive where sent emails are archived that you send using the configuration set.</p>', ], ], 'Attachment' => [ 'base' => '<p> Contains metadata and attachment raw content.</p>', 'refs' => [ 'AttachmentList$member' => NULL, ], ], 'AttachmentContentDescription' => [ 'base' => NULL, 'refs' => [ 'Attachment$ContentDescription' => '<p> A brief description of the attachment content.</p>', ], ], 'AttachmentContentDisposition' => [ 'base' => NULL, 'refs' => [ 'Attachment$ContentDisposition' => '<p> A standard descriptor indicating how the attachment should be rendered in the email. Supported values: <code>ATTACHMENT</code> or <code>INLINE</code>.</p>', ], ], 'AttachmentContentId' => [ 'base' => NULL, 'refs' => [ 'Attachment$ContentId' => '<p> Unique identifier for the attachment, used for referencing attachments with INLINE disposition in HTML content.</p>', ], ], 'AttachmentContentTransferEncoding' => [ 'base' => NULL, 'refs' => [ 'Attachment$ContentTransferEncoding' => '<p> Specifies how the attachment is encoded. Supported values: <code>BASE64</code>, <code>QUOTED_PRINTABLE</code>, <code>SEVEN_BIT</code>.</p>', ], ], 'AttachmentContentType' => [ 'base' => NULL, 'refs' => [ 'Attachment$ContentType' => '<p> The MIME type of the attachment.</p> <note> <p>Example: <code>application/pdf</code>, <code>image/jpeg</code> </p> </note>', ], ], 'AttachmentFileName' => [ 'base' => NULL, 'refs' => [ 'Attachment$FileName' => '<p>The file name for the attachment as it will appear in the email. Amazon SES restricts certain file extensions. To ensure attachments are accepted, check the <a href="https://docs.aws.amazon.com/ses/latest/dg/mime-types.html">Unsupported attachment types</a> in the Amazon SES Developer Guide.</p>', ], ], 'AttachmentList' => [ 'base' => NULL, 'refs' => [ 'Message$Attachments' => '<p> The List of attachments to include in your email. All recipients will receive the same attachments.</p>', 'Template$Attachments' => '<p> The List of attachments to include in your email. All recipients will receive the same attachments.</p>', ], ], 'AttributesData' => [ 'base' => NULL, 'refs' => [ 'CreateContactRequest$AttributesData' => '<p>The attribute data attached to a contact.</p>', 'GetContactResponse$AttributesData' => '<p>The attribute data attached to a contact.</p>', 'UpdateContactRequest$AttributesData' => '<p>The attribute data attached to a contact.</p>', ], ], 'BadRequestException' => [ 'base' => '<p>The input you provided is invalid.</p>', 'refs' => [], ], 'BatchGetMetricDataQueries' => [ 'base' => NULL, 'refs' => [ 'BatchGetMetricDataRequest$Queries' => '<p>A list of queries for metrics to be retrieved.</p>', ], ], 'BatchGetMetricDataQuery' => [ 'base' => '<p>Represents a single metric data query to include in a batch.</p>', 'refs' => [ 'BatchGetMetricDataQueries$member' => NULL, ], ], 'BatchGetMetricDataRequest' => [ 'base' => '<p>Represents a request to retrieve a batch of metric data.</p>', 'refs' => [], ], 'BatchGetMetricDataResponse' => [ 'base' => '<p>Represents the result of processing your metric data batch request</p>', 'refs' => [], ], 'BehaviorOnMxFailure' => [ 'base' => '<p>The action to take if the required MX record can\'t be found when you send an email. When you set this value to <code>UseDefaultValue</code>, the mail is sent using <i>amazonses.com</i> as the MAIL FROM domain. When you set this value to <code>RejectMessage</code>, the Amazon SES API v2 returns a <code>MailFromDomainNotVerified</code> error, and doesn\'t attempt to deliver the email.</p> <p>These behaviors are taken when the custom MAIL FROM domain configuration is in the <code>Pending</code>, <code>Failed</code>, and <code>TemporaryFailure</code> states.</p>', 'refs' => [ 'MailFromAttributes$BehaviorOnMxFailure' => '<p>The action to take if the required MX record can\'t be found when you send an email. When you set this value to <code>USE_DEFAULT_VALUE</code>, the mail is sent using <i>amazonses.com</i> as the MAIL FROM domain. When you set this value to <code>REJECT_MESSAGE</code>, the Amazon SES API v2 returns a <code>MailFromDomainNotVerified</code> error, and doesn\'t attempt to deliver the email.</p> <p>These behaviors are taken when the custom MAIL FROM domain configuration is in the <code>Pending</code>, <code>Failed</code>, and <code>TemporaryFailure</code> states.</p>', 'PutEmailIdentityMailFromAttributesRequest$BehaviorOnMxFailure' => '<p>The action to take if the required MX record isn\'t found when you send an email. When you set this value to <code>UseDefaultValue</code>, the mail is sent using <i>amazonses.com</i> as the MAIL FROM domain. When you set this value to <code>RejectMessage</code>, the Amazon SES API v2 returns a <code>MailFromDomainNotVerified</code> error, and doesn\'t attempt to deliver the email.</p> <p>These behaviors are taken when the custom MAIL FROM domain configuration is in the <code>Pending</code>, <code>Failed</code>, and <code>TemporaryFailure</code> states.</p>', ], ], 'BlacklistEntries' => [ 'base' => NULL, 'refs' => [ 'BlacklistReport$value' => NULL, ], ], 'BlacklistEntry' => [ 'base' => '<p>An object that contains information about a blacklisting event that impacts one of the dedicated IP addresses that is associated with your account.</p>', 'refs' => [ 'BlacklistEntries$member' => NULL, ], ], 'BlacklistItemName' => [ 'base' => '<p>An IP address that you want to obtain blacklist information for.</p>', 'refs' => [ 'BlacklistItemNames$member' => NULL, 'BlacklistReport$key' => NULL, ], ], 'BlacklistItemNames' => [ 'base' => NULL, 'refs' => [ 'GetBlacklistReportsRequest$BlacklistItemNames' => '<p>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.</p>', ], ], 'BlacklistReport' => [ 'base' => NULL, 'refs' => [ 'GetBlacklistReportsResponse$BlacklistReport' => '<p>An object that contains information about a blacklist that one of your dedicated IP addresses appears on.</p>', ], ], 'BlacklistingDescription' => [ 'base' => '<p>A description of the blacklisting event.</p>', 'refs' => [ 'BlacklistEntry$Description' => '<p>Additional information about the blacklisting event, as provided by the blacklist maintainer.</p>', ], ], 'Body' => [ 'base' => '<p>Represents the body of the email message.</p>', 'refs' => [ 'Message$Body' => '<p>The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both.</p>', ], ], 'Bounce' => [ 'base' => '<p>Information about a <code>Bounce</code> event.</p>', 'refs' => [ 'EventDetails$Bounce' => '<p>Information about a <code>Bounce</code> event.</p>', ], ], 'BounceSubType' => [ 'base' => NULL, 'refs' => [ 'Bounce$BounceSubType' => '<p>The subtype of the bounce, as determined by SES.</p>', ], ], 'BounceType' => [ 'base' => NULL, 'refs' => [ 'Bounce$BounceType' => '<p>The type of the bounce, as determined by SES. Can be one of <code>UNDETERMINED</code>, <code>TRANSIENT</code>, or <code>PERMANENT</code> </p>', ], ], 'BulkEmailContent' => [ 'base' => '<p>An object that contains the body of the message. You can specify a template message.</p>', 'refs' => [ 'SendBulkEmailRequest$DefaultContent' => '<p>An object that contains the body of the message. You can specify a template message.</p>', ], ], 'BulkEmailEntry' => [ 'base' => NULL, 'refs' => [ 'BulkEmailEntryList$member' => NULL, ], ], 'BulkEmailEntryList' => [ 'base' => '<p>A list of <code>BulkEmailEntry</code> objects.</p>', 'refs' => [ 'SendBulkEmailRequest$BulkEmailEntries' => '<p>The list of bulk email entry objects.</p>', ], ], 'BulkEmailEntryResult' => [ 'base' => '<p>The result of the <code>SendBulkEmail</code> operation of each specified <code>BulkEmailEntry</code>.</p>', 'refs' => [ 'BulkEmailEntryResultList$member' => NULL, ], ], 'BulkEmailEntryResultList' => [ 'base' => '<p>A list of <code>BulkMailEntry</code> objects.</p>', 'refs' => [ 'SendBulkEmailResponse$BulkEmailEntryResults' => '<p>One object per intended recipient. Check each response object and retry any messages with a failure status.</p>', ], ], 'BulkEmailStatus' => [ 'base' => NULL, 'refs' => [ 'BulkEmailEntryResult$Status' => '<p>The status of a message sent using the <code>SendBulkTemplatedEmail</code> operation.</p> <p>Possible values for this parameter include:</p> <ul> <li> <p>SUCCESS: Amazon SES accepted the message, and will attempt to deliver it to the recipients.</p> </li> <li> <p>MESSAGE_REJECTED: The message was rejected because it contained a virus.</p> </li> <li> <p>MAIL_FROM_DOMAIN_NOT_VERIFIED: The sender\'s email address or domain was not verified.</p> </li> <li> <p>CONFIGURATION_SET_DOES_NOT_EXIST: The configuration set you specified does not exist.</p> </li> <li> <p>TEMPLATE_DOES_NOT_EXIST: The template you specified does not exist.</p> </li> <li> <p>ACCOUNT_SUSPENDED: Your account has been shut down because of issues related to your email sending practices.</p> </li> <li> <p>ACCOUNT_THROTTLED: The number of emails you can send has been reduced because your account has exceeded its allocated sending limit.</p> </li> <li> <p>ACCOUNT_DAILY_QUOTA_EXCEEDED: You have reached or exceeded the maximum number of emails you can send from your account in a 24-hour period.</p> </li> <li> <p>INVALID_SENDING_POOL_NAME: The configuration set you specified refers to an IP pool that does not exist.</p> </li> <li> <p>ACCOUNT_SENDING_PAUSED: Email sending for the Amazon SES account was disabled using the <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateAccountSendingEnabled.html">UpdateAccountSendingEnabled</a> operation.</p> </li> <li> <p>CONFIGURATION_SET_SENDING_PAUSED: Email sending for this configuration set was disabled using the <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateConfigurationSetSendingEnabled.html">UpdateConfigurationSetSendingEnabled</a> operation.</p> </li> <li> <p>INVALID_PARAMETER_VALUE: One or more of the parameters you specified when calling this operation was invalid. See the error message for additional information.</p> </li> <li> <p>TRANSIENT_FAILURE: Amazon SES was unable to process your request because of a temporary issue.</p> </li> <li> <p>FAILED: Amazon SES was unable to process your request. See the error message for additional information.</p> </li> </ul>', ], ], 'CampaignId' => [ 'base' => NULL, 'refs' => [ 'DomainDeliverabilityCampaign$CampaignId' => '<p>The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.</p>', 'GetDomainDeliverabilityCampaignRequest$CampaignId' => '<p>The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.</p>', ], ], 'CancelExportJobRequest' => [ 'base' => '<p>Represents a request to cancel an export job using the export job ID.</p>', 'refs' => [], ], 'CancelExportJobResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'CaseId' => [ 'base' => NULL, 'refs' => [ 'ReviewDetails$CaseId' => '<p>The associated support center case ID (if any).</p>', ], ], 'Charset' => [ 'base' => NULL, 'refs' => [ 'Content$Charset' => '<p>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 <code>UTF-8</code>, <code>ISO-8859-1</code>, or <code>Shift_JIS</code>.</p>', ], ], 'CloudWatchDestination' => [ 'base' => '<p>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.</p>', 'refs' => [ 'EventDestination$CloudWatchDestination' => '<p>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.</p>', 'EventDestinationDefinition$CloudWatchDestination' => '<p>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.</p>', ], ], 'CloudWatchDimensionConfiguration' => [ 'base' => '<p>An object that defines the dimension configuration to use when you send email events to Amazon CloudWatch.</p>', 'refs' => [ 'CloudWatchDimensionConfigurations$member' => NULL, ], ], 'CloudWatchDimensionConfigurations' => [ 'base' => NULL, 'refs' => [ 'CloudWatchDestination$DimensionConfigurations' => '<p>An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.</p>', ], ], 'Complaint' => [ 'base' => '<p>Information about a <code>Complaint</code> event.</p>', 'refs' => [ 'EventDetails$Complaint' => '<p>Information about a <code>Complaint</code> event.</p>', ], ], 'ComplaintFeedbackType' => [ 'base' => NULL, 'refs' => [ 'Complaint$ComplaintFeedbackType' => '<p> The value of the <code>Feedback-Type</code> field from the feedback report received from the ISP. </p>', ], ], 'ComplaintSubType' => [ 'base' => NULL, 'refs' => [ 'Complaint$ComplaintSubType' => '<p> Can either be <code>null</code> or <code>OnAccountSuppressionList</code>. If the value is <code>OnAccountSuppressionList</code>, SES accepted the message, but didn\'t attempt to send it because it was on the account-level suppression list. </p>', ], ], 'ConcurrentModificationException' => [ 'base' => '<p>The resource is being modified by another operation or thread.</p>', 'refs' => [], ], 'ConfigurationSetName' => [ 'base' => '<p>The name of a configuration set.</p> <p> <i>Configuration sets</i> 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.</p>', 'refs' => [ 'ConfigurationSetNameList$member' => NULL, 'CreateConfigurationSetEventDestinationRequest$ConfigurationSetName' => '<p>The name of the configuration set .</p>', 'CreateConfigurationSetRequest$ConfigurationSetName' => '<p>The name of the configuration set. The name can contain up to 64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_) only.</p>', 'CreateEmailIdentityRequest$ConfigurationSetName' => '<p>The configuration set to use by default when sending from this identity. Note that any configuration set defined in the email sending request takes precedence. </p>', 'DeleteConfigurationSetEventDestinationRequest$ConfigurationSetName' => '<p>The name of the configuration set that contains the event destination to delete.</p>', 'DeleteConfigurationSetRequest$ConfigurationSetName' => '<p>The name of the configuration set.</p>', 'GetConfigurationSetEventDestinationsRequest$ConfigurationSetName' => '<p>The name of the configuration set that contains the event destination.</p>', 'GetConfigurationSetRequest$ConfigurationSetName' => '<p>The name of the configuration set.</p>', 'GetConfigurationSetResponse$ConfigurationSetName' => '<p>The name of the configuration set.</p>', 'GetEmailIdentityResponse$ConfigurationSetName' => '<p>The configuration set used by default when sending from this identity.</p>', 'PutConfigurationSetArchivingOptionsRequest$ConfigurationSetName' => '<p>The name of the configuration set to associate with a MailManager archive.</p>', 'PutConfigurationSetDeliveryOptionsRequest$ConfigurationSetName' => '<p>The name of the configuration set to associate with a dedicated IP pool.</p>', 'PutConfigurationSetReputationOptionsRequest$ConfigurationSetName' => '<p>The name of the configuration set.</p>', 'PutConfigurationSetSendingOptionsRequest$ConfigurationSetName' => '<p>The name of the configuration set to enable or disable email sending for.</p>', 'PutConfigurationSetSuppressionOptionsRequest$ConfigurationSetName' => '<p>The name of the configuration set to change the suppression list preferences for.</p>', 'PutConfigurationSetTrackingOptionsRequest$ConfigurationSetName' => '<p>The name of the configuration set.</p>', 'PutConfigurationSetVdmOptionsRequest$ConfigurationSetName' => '<p>The name of the configuration set.</p>', 'PutEmailIdentityConfigurationSetAttributesRequest$ConfigurationSetName' => '<p>The configuration set to associate with an email identity.</p>', 'SendBulkEmailRequest$ConfigurationSetName' => '<p>The name of the configuration set to use when sending the email.</p>', 'SendCustomVerificationEmailRequest$ConfigurationSetName' => '<p>Name of a configuration set to use when sending the verification email.</p>', 'SendEmailRequest$ConfigurationSetName' => '<p>The name of the configuration set to use when sending the email.</p>', 'UpdateConfigurationSetEventDestinationRequest$ConfigurationSetName' => '<p>The name of the configuration set that contains the event destination to modify.</p>', ], ], 'ConfigurationSetNameList' => [ 'base' => NULL, 'refs' => [ 'ListConfigurationSetsResponse$ConfigurationSets' => '<p>An array that contains all of the configuration sets in your Amazon SES account in the current Amazon Web Services Region.</p>', ], ], 'ConflictException' => [ 'base' => '<p>If there is already an ongoing account details update under review.</p>', 'refs' => [], ], 'Contact' => [ 'base' => '<p>A contact is the end-user who is receiving the email.</p>', 'refs' => [ 'ListOfContacts$member' => NULL, ], ], 'ContactLanguage' => [ 'base' => NULL, 'refs' => [ 'AccountDetails$ContactLanguage' => '<p>The language you would prefer for the case. The contact language can be one of <code>ENGLISH</code> or <code>JAPANESE</code>.</p>', 'PutAccountDetailsRequest$ContactLanguage' => '<p>The language you would prefer to be contacted with.</p>', ], ], 'ContactList' => [ 'base' => '<p>A list that contains contacts that have subscribed to a particular topic or topics.</p>', 'refs' => [ 'ListOfContactLists$member' => NULL, ], ], 'ContactListDestination' => [ 'base' => '<p>An object that contains details about the action of a contact list.</p>', 'refs' => [ 'ImportDestination$ContactListDestination' => '<p>An object that contains the action of the import job towards a contact list.</p>', ], ], 'ContactListImportAction' => [ 'base' => NULL, 'refs' => [ 'ContactListDestination$ContactListImportAction' => '<p>&gt;The type of action to perform on the addresses. The following are the possible values:</p> <ul> <li> <p>PUT: add the addresses to the contact list. If the record already exists, it will override it with the new value.</p> </li> <li> <p>DELETE: remove the addresses from the contact list.</p> </li> </ul>', ], ], 'ContactListName' => [ 'base' => NULL, 'refs' => [ 'ContactList$ContactListName' => '<p>The name of the contact list.</p>', 'ContactListDestination$ContactListName' => '<p>The name of the contact list.</p>', 'CreateContactListRequest$ContactListName' => '<p>The name of the contact list.</p>', 'CreateContactRequest$ContactListName' => '<p>The name of the contact list to which the contact should be added.</p>', 'DeleteContactListRequest$ContactListName' => '<p>The name of the contact list.</p>', 'DeleteContactRequest$ContactListName' => '<p>The name of the contact list from which the contact should be removed.</p>', 'GetContactListRequest$ContactListName' => '<p>The name of the contact list.</p>', 'GetContactListResponse$ContactListName' => '<p>The name of the contact list.</p>', 'GetContactRequest$ContactListName' => '<p>The name of the contact list to which the contact belongs.</p>', 'GetContactResponse$ContactListName' => '<p>The name of the contact list to which the contact belongs.</p>', 'ListContactsRequest$ContactListName' => '<p>The name of the contact list.</p>', 'ListManagementOptions$ContactListName' => '<p>The name of the contact list.</p>', 'UpdateContactListRequest$ContactListName' => '<p>The name of the contact list.</p>', 'UpdateContactRequest$ContactListName' => '<p>The name of the contact list.</p>', ], ], 'Content' => [ 'base' => '<p>An object that represents the content of the email, and optionally a character set specification.</p>', 'refs' => [ 'Body$Text' => '<p>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.</p>', 'Body$Html' => '<p>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. </p>', 'Message$Subject' => '<p>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 <a href="https://tools.ietf.org/html/rfc2047">RFC 2047</a>.</p>', ], ], 'Counter' => [ 'base' => NULL, 'refs' => [ 'MetricValueList$member' => NULL, ], ], 'CreateConfigurationSetEventDestinationRequest' => [ 'base' => '<p>A request to add an event destination to a configuration set.</p>', 'refs' => [], ], 'CreateConfigurationSetEventDestinationResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'CreateConfigurationSetRequest' => [ 'base' => '<p>A request to create a configuration set.</p>', 'refs' => [], ], 'CreateConfigurationSetResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'CreateContactListRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateContactListResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateCustomVerificationEmailTemplateRequest' => [ 'base' => '<p>Represents a request to create a custom verification email template.</p>', 'refs' => [], ], 'CreateCustomVerificationEmailTemplateResponse' => [ 'base' => '<p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>', 'refs' => [], ], 'CreateDedicatedIpPoolRequest' => [ 'base' => '<p>A request to create a new dedicated IP pool.</p>', 'refs' => [], ], 'CreateDedicatedIpPoolResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'CreateDeliverabilityTestReportRequest' => [ 'base' => '<p>A request to perform a predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. We send that message to special email addresses spread across several major email providers around the world. The test takes about 24 hours to complete. When the test is complete, you can use the <code>GetDeliverabilityTestReport</code> operation to view the results of the test.</p>', 'refs' => [], ], 'CreateDeliverabilityTestReportResponse' => [ 'base' => '<p>Information about the predictive inbox placement test that you created.</p>', 'refs' => [], ], 'CreateEmailIdentityPolicyRequest' => [ 'base' => '<p>Represents a request to create a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html">Amazon SES Developer Guide</a>.</p>', 'refs' => [], ], 'CreateEmailIdentityPolicyResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'CreateEmailIdentityRequest' => [ 'base' => '<p>A request to begin the verification process for an email identity (an email address or domain).</p>', 'refs' => [], ], 'CreateEmailIdentityResponse' => [ 'base' => '<p>If the email identity is a domain, this object contains information about the DKIM verification status for the domain.</p> <p>If the email identity is an email address, this object is empty. </p>', 'refs' => [], ], 'CreateEmailTemplateRequest' => [ 'base' => '<p>Represents a request to create an email template. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html">Amazon SES Developer Guide</a>.</p>', 'refs' => [], ], 'CreateEmailTemplateResponse' => [ 'base' => '<p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>', 'refs' => [], ], 'CreateExportJobRequest' => [ 'base' => '<p>Represents a request to create an export job from a data source to a data destination.</p>', 'refs' => [], ], 'CreateExportJobResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'CreateImportJobRequest' => [ 'base' => '<p>Represents a request to create an import job from a data source for a data destination.</p>', 'refs' => [], ], 'CreateImportJobResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'CreateMultiRegionEndpointRequest' => [ 'base' => '<p>Represents a request to create a multi-region endpoint (global-endpoint).</p>', 'refs' => [], ], 'CreateMultiRegionEndpointResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'CreateTenantRequest' => [ 'base' => '<p>Represents a request to create a tenant.</p> <p> <i>Tenants</i> are logical containers that group related SES resources together. Each tenant can have its own set of resources like email identities, configuration sets, and templates, along with reputation metrics and sending status. This helps isolate and manage email sending for different customers or business units within your Amazon SES API v2 account.</p>', 'refs' => [], ], 'CreateTenantResourceAssociationRequest' => [ 'base' => '<p>Represents a request to associate a resource with a tenant.</p> <p>Resources can be email identities, configuration sets, or email templates. When you associate a resource with a tenant, you can use that resource when sending emails on behalf of that tenant.</p>', 'refs' => [], ], 'CreateTenantResourceAssociationResponse' => [ 'base' => '<p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>', 'refs' => [], ], 'CreateTenantResponse' => [ 'base' => '<p>Information about a newly created tenant.</p>', 'refs' => [], ], 'CustomRedirectDomain' => [ 'base' => '<p>The domain to use for tracking open and click events.</p>', 'refs' => [ 'PutConfigurationSetTrackingOptionsRequest$CustomRedirectDomain' => '<p>The domain to use to track open and click events.</p>', 'TrackingOptions$CustomRedirectDomain' => '<p>The domain to use for tracking open and click events.</p>', ], ], 'CustomVerificationEmailTemplateMetadata' => [ 'base' => '<p>Contains information about a custom verification email template.</p>', 'refs' => [ 'CustomVerificationEmailTemplatesList$member' => NULL, ], ], 'CustomVerificationEmailTemplatesList' => [ 'base' => '<p>A list of the custom verification email templates that exist in your account.</p>', 'refs' => [ 'ListCustomVerificationEmailTemplatesResponse$CustomVerificationEmailTemplates' => '<p>A list of the custom verification email templates that exist in your account.</p>', ], ], 'DailyVolume' => [ 'base' => '<p>An object that contains information about the volume of email sent on each day of the analysis period.</p>', 'refs' => [ 'DailyVolumes$member' => NULL, ], ], 'DailyVolumes' => [ 'base' => NULL, 'refs' => [ 'GetDomainStatisticsReportResponse$DailyVolumes' => '<p>An object that contains deliverability metrics for the domain that you specified. This object contains data for each day, starting on the <code>StartDate</code> and ending on the <code>EndDate</code>.</p>', ], ], 'DashboardAttributes' => [ 'base' => '<p>An object containing additional settings for your VDM configuration as applicable to the Dashboard.</p>', 'refs' => [ 'VdmAttributes$DashboardAttributes' => '<p>Specifies additional settings for your VDM configuration as applicable to the Dashboard.</p>', ], ], 'DashboardOptions' => [ 'base' => '<p>An object containing additional settings for your VDM configuration as applicable to the Dashboard.</p>', 'refs' => [ 'VdmOptions$DashboardOptions' => '<p>Specifies additional settings for your VDM configuration as applicable to the Dashboard.</p>', ], ], 'DataFormat' => [ 'base' => '<p>The data format of a file, can be one of the following:</p> <ul> <li> <p> <code>CSV</code> – A comma-separated values file.</p> </li> <li> <p> <code>JSON</code> – A JSON file.</p> </li> </ul>', 'refs' => [ 'ExportDestination$DataFormat' => '<p>The data format of the final export job file, can be one of the following:</p> <ul> <li> <p> <code>CSV</code> - A comma-separated values file.</p> </li> <li> <p> <code>JSON</code> - A Json file.</p> </li> </ul>', 'ImportDataSource$DataFormat' => '<p>The data format of the import job\'s data source.</p>', ], ], 'DedicatedIp' => [ 'base' => '<p>Contains information about a dedicated IP address that is associated with your Amazon SES account.</p> <p>To learn more about requesting dedicated IP addresses, see <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/dedicated-ip-case.html">Requesting and Relinquishing Dedicated IP Addresses</a> in the <i>Amazon SES Developer Guide</i>.</p>', 'refs' => [ 'DedicatedIpList$member' => NULL, 'GetDedicatedIpResponse$DedicatedIp' => '<p>An object that contains information about a dedicated IP address.</p>', ], ], 'DedicatedIpList' => [ 'base' => '<p>A list of dedicated IP addresses that are associated with your Amazon Web Services account.</p>', 'refs' => [ 'GetDedicatedIpsResponse$DedicatedIps' => '<p>A list of dedicated IP addresses that are associated with your Amazon Web Services account.</p>', ], ], 'DedicatedIpPool' => [ 'base' => '<p>Contains information about a dedicated IP pool.</p>', 'refs' => [ 'GetDedicatedIpPoolResponse$DedicatedIpPool' => '<p>An object that contains information about a dedicated IP pool.</p>', ], ], 'DefaultDimensionValue' => [ 'base' => '<p>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:</p> <ul> <li> <p>It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).</p> </li> <li> <p>It can contain no more than 256 characters.</p> </li> </ul>', 'refs' => [ 'CloudWatchDimensionConfiguration$DefaultDimensionValue' => '<p>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:</p> <ul> <li> <p>Can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-), at signs (@), and periods (.).</p> </li> <li> <p>It can contain no more than 256 characters.</p> </li> </ul>', ], ], 'DeleteConfigurationSetEventDestinationRequest' => [ 'base' => '<p>A request to delete an event destination from a configuration set.</p>', 'refs' => [], ], 'DeleteConfigurationSetEventDestinationResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'DeleteConfigurationSetRequest' => [ 'base' => '<p>A request to delete a configuration set.</p>', 'refs' => [], ], 'DeleteConfigurationSetResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'DeleteContactListRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContactListResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCustomVerificationEmailTemplateRequest' => [ 'base' => '<p>Represents a request to delete an existing custom verification email template.</p>', 'refs' => [], ], 'DeleteCustomVerificationEmailTemplateResponse' => [ 'base' => '<p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>', 'refs' => [], ], 'DeleteDedicatedIpPoolRequest' => [ 'base' => '<p>A request to delete a dedicated IP pool.</p>', 'refs' => [], ], 'DeleteDedicatedIpPoolResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'DeleteEmailIdentityPolicyRequest' => [ 'base' => '<p>Represents a request to delete a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html">Amazon SES Developer Guide</a>.</p>', 'refs' => [], ], 'DeleteEmailIdentityPolicyResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'DeleteEmailIdentityRequest' => [ 'base' => '<p>A request to delete an existing email identity. When you delete an identity, you lose the ability to send email from that identity. You can restore your ability to send email by completing the verification process for the identity again.</p>', 'refs' => [], ], 'DeleteEmailIdentityResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'DeleteEmailTemplateRequest' => [ 'base' => '<p>Represents a request to delete an email template. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html">Amazon SES Developer Guide</a>.</p>', 'refs' => [], ], 'DeleteEmailTemplateResponse' => [ 'base' => '<p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>', 'refs' => [], ], 'DeleteMultiRegionEndpointRequest' => [ 'base' => '<p>Represents a request to delete a multi-region endpoint (global-endpoint).</p>', 'refs' => [], ], 'DeleteMultiRegionEndpointResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'DeleteSuppressedDestinationRequest' => [ 'base' => '<p>A request to remove an email address from the suppression list for your account.</p>', 'refs' => [], ], 'DeleteSuppressedDestinationResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'DeleteTenantRequest' => [ 'base' => '<p>Represents a request to delete a tenant.</p>', 'refs' => [], ], 'DeleteTenantResourceAssociationRequest' => [ 'base' => '<p>Represents a request to delete an association between a tenant and a resource.</p>', 'refs' => [], ], 'DeleteTenantResourceAssociationResponse' => [ 'base' => '<p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>', 'refs' => [], ], 'DeleteTenantResponse' => [ 'base' => '<p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>', 'refs' => [], ], 'DeliverabilityDashboardAccountStatus' => [ 'base' => '<p>The current status of your Deliverability dashboard subscription. If this value is <code>PENDING_EXPIRATION</code>, your subscription is scheduled to expire at the end of the current calendar month.</p>', 'refs' => [ 'GetDeliverabilityDashboardOptionsResponse$AccountStatus' => '<p>The current status of your Deliverability dashboard subscription. If this value is <code>PENDING_EXPIRATION</code>, your subscription is scheduled to expire at the end of the current calendar month.</p>', ], ], 'DeliverabilityTestReport' => [ 'base' => '<p>An object that contains metadata related to a predictive inbox placement test.</p>', 'refs' => [ 'DeliverabilityTestReports$member' => NULL, 'GetDeliverabilityTestReportResponse$DeliverabilityTestReport' => '<p>An object that contains the results of the predictive inbox placement test.</p>', ], ], 'DeliverabilityTestReports' => [ 'base' => NULL, 'refs' => [ 'ListDeliverabilityTestReportsResponse$DeliverabilityTestReports' => '<p>An object that contains a lists of predictive inbox placement tests that you\'ve performed.</p>', ], ], 'DeliverabilityTestStatus' => [ 'base' => '<p>The status of a predictive inbox placement test. If the status is <code>IN_PROGRESS</code>, 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 <code>COMPLETE</code>, then the test is finished, and you can use the <code>GetDeliverabilityTestReport</code> operation to view the results of the test.</p>', 'refs' => [ 'CreateDeliverabilityTestReportResponse$DeliverabilityTestStatus' => '<p>The status of the predictive inbox placement test. If the status is <code>IN_PROGRESS</code>, 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 <code>COMPLETE</code>, then the test is finished, and you can use the <code>GetDeliverabilityTestReport</code> to view the results of the test.</p>', 'DeliverabilityTestReport$DeliverabilityTestStatus' => '<p>The status of the predictive inbox placement test. If the status is <code>IN_PROGRESS</code>, 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 <code>COMPLETE</code>, then the test is finished, and you can use the <code>GetDeliverabilityTestReport</code> to view the results of the test.</p>', ], ], 'DeliverabilityTestSubject' => [ 'base' => '<p>The subject line for an email that you submitted in a predictive inbox placement test.</p>', 'refs' => [ 'DeliverabilityTestReport$Subject' => '<p>The subject line for an email that you submitted in a predictive inbox placement test.</p>', ], ], 'DeliveryEventType' => [ 'base' => '<p>The type of delivery events:</p> <ul> <li> <p> <code>SEND</code> - The send request was successful and SES will attempt to deliver the message to the recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed.)</p> </li> <li> <p> <code>DELIVERY</code> - SES successfully delivered the email to the recipient\'s mail server. Excludes deliveries to the mailbox simulator and emails addressed to more than one recipient.</p> </li> <li> <p> <code>TRANSIENT_BOUNCE</code> - Feedback received for delivery failures excluding issues with non-existent mailboxes. Excludes bounces from the mailbox simulator, and those from emails addressed to more than one recipient.</p> </li> <li> <p> <code>PERMANENT_BOUNCE</code> - Feedback received for emails sent to non-existent mailboxes. Excludes bounces from the mailbox simulator, those originating from your account-level suppression list (if enabled), and those from emails addressed to more than one recipient.</p> </li> <li> <p> <code>UNDETERMINED_BOUNCE</code> - SES was unable to determine the bounce reason.</p> </li> <li> <p> <code>COMPLAINT</code> - Complaint received for the email. This excludes complaints from the mailbox simulator, those originating from your account-level suppression list (if enabled), and those from emails addressed to more than one recipient.</p> </li> </ul>', 'refs' => [ 'LastDeliveryEventList$member' => NULL, ], ], 'DeliveryOptions' => [ 'base' => '<p>Used to associate a configuration set with a dedicated IP pool.</p>', 'refs' => [ 'CreateConfigurationSetRequest$DeliveryOptions' => '<p>An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.</p>', 'GetConfigurationSetResponse$DeliveryOptions' => '<p>An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.</p>', ], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'CreateContactListRequest$Description' => '<p>A description of what the contact list is about.</p>', 'GetContactListResponse$Description' => '<p>A description of what the contact list is about.</p>', 'Topic$Description' => '<p>A description of what the topic is about, which the contact will see.</p>', 'UpdateContactListRequest$Description' => '<p>A description of what the contact list is about.</p>', ], ], 'Destination' => [ 'base' => '<p>An object that describes the recipients for an email.</p> <note> <p>Amazon SES does not support the SMTPUTF8 extension, as described in <a href="https://tools.ietf.org/html/rfc6531">RFC6531</a>. For this reason, the <i>local part</i> of a destination email address (the part of the email address that precedes the @ sign) may only contain <a href="https://en.wikipedia.org/wiki/Email_address#Local-part">7-bit ASCII characters</a>. If the <i>domain part</i> of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in <a href="https://tools.ietf.org/html/rfc3492.html">RFC3492</a>.</p> </note>', 'refs' => [ 'BulkEmailEntry$Destination' => '<p>Represents the destination of the message, consisting of To:, CC:, and BCC: fields.</p> <note> <p>Amazon SES does not support the SMTPUTF8 extension, as described in <a href="https://tools.ietf.org/html/rfc6531">RFC6531</a>. For this reason, the local part of a destination email address (the part of the email address that precedes the @ sign) may only contain <a href="https://en.wikipedia.org/wiki/Email_address#Local-part">7-bit ASCII characters</a>. 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 <a href="https://tools.ietf.org/html/rfc3492.html">RFC3492</a>.</p> </note>', 'SendEmailRequest$Destination' => '<p>An object that contains the recipients of the email message.</p>', ], ], 'Details' => [ 'base' => '<p>An object that contains configuration details of multi-region endpoint (global-endpoint).</p>', 'refs' => [ 'CreateMultiRegionEndpointRequest$Details' => '<p>Contains details of a multi-region endpoint (global-endpoint) being created.</p>', ], ], 'DiagnosticCode' => [ 'base' => NULL, 'refs' => [ 'Bounce$DiagnosticCode' => '<p>The status code issued by the reporting Message Transfer Authority (MTA). This field only appears if a delivery status notification (DSN) was attached to the bounce and the <code>Diagnostic-Code</code> was provided in the DSN. </p>', ], ], 'DimensionName' => [ 'base' => '<p>The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:</p> <ul> <li> <p>It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>It can contain no more than 256 characters.</p> </li> </ul>', 'refs' => [ 'CloudWatchDimensionConfiguration$DimensionName' => '<p>The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:</p> <ul> <li> <p>It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).</p> </li> <li> <p>It can contain no more than 256 characters.</p> </li> </ul>', ], ], 'DimensionValueSource' => [ 'base' => '<p>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 <code>X-SES-MESSAGE-TAGS</code> header or a parameter to the <code>SendEmail</code> or <code>SendRawEmail</code> API, choose <code>messageTag</code>. To use your own email headers, choose <code>emailHeader</code>. To use link tags, choose <code>linkTags</code>.</p>', 'refs' => [ 'CloudWatchDimensionConfiguration$DimensionValueSource' => '<p>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 <code>X-SES-MESSAGE-TAGS</code> header or a parameter to the <code>SendEmail</code> or <code>SendRawEmail</code> API, choose <code>messageTag</code>. To use your own email headers, choose <code>emailHeader</code>. To use link tags, choose <code>linkTags</code>.</p>', ], ], 'Dimensions' => [ 'base' => NULL, 'refs' => [ 'BatchGetMetricDataQuery$Dimensions' => '<p>An object that contains mapping between <code>MetricDimensionName</code> and <code>MetricDimensionValue</code> to filter metrics by.</p>', ], ], 'DisplayName' => [ 'base' => NULL, 'refs' => [ 'Topic$DisplayName' => '<p>The name of the topic the contact will see.</p>', ], ], 'DkimAttributes' => [ 'base' => '<p>An object that contains information about the DKIM authentication status for an email identity.</p> <p>Amazon SES determines the authentication status by searching for specific records in the DNS configuration for the domain. If you used <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Easy DKIM</a> 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</p>', 'refs' => [ 'CreateEmailIdentityResponse$DkimAttributes' => '<p>An object that contains information about the DKIM attributes for the identity.</p>', 'GetEmailIdentityResponse$DkimAttributes' => '<p>An object that contains information about the DKIM attributes for the identity.</p>', ], ], 'DkimSigningAttributes' => [ 'base' => '<p>An object that contains configuration for Bring Your Own DKIM (BYODKIM), or, for Easy DKIM</p>', 'refs' => [ 'CreateEmailIdentityRequest$DkimSigningAttributes' => '<p>If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Easy DKIM</a>.</p> <p>You can only specify this object if the email identity is a domain, as opposed to an address.</p>', 'PutEmailIdentityDkimSigningAttributesRequest$SigningAttributes' => '<p>An object that contains information about the private key and selector that you want to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the identity, or, configures the key length to be used for <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Easy DKIM</a>.</p>', ], ], 'DkimSigningAttributesOrigin' => [ 'base' => NULL, 'refs' => [ 'DkimAttributes$SigningAttributesOrigin' => '<p>A string that indicates how DKIM was configured for the identity. These are the possible values:</p> <ul> <li> <p> <code>AWS_SES</code> – Indicates that DKIM was configured for the identity by using <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Easy DKIM</a>.</p> </li> <li> <p> <code>EXTERNAL</code> – Indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).</p> </li> <li> <p> <code>AWS_SES_AF_SOUTH_1</code> – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Africa (Cape Town) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_EU_NORTH_1</code> – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (Stockholm) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_AP_SOUTH_1</code> – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Mumbai) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_AP_SOUTH_2</code> – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Hyderabad) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_EU_WEST_3</code> – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (Paris) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_EU_WEST_2</code> – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (London) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_EU_SOUTH_1</code> – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (Milan) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_EU_WEST_1</code> – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (Ireland) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_AP_NORTHEAST_3</code> – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Osaka) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_AP_NORTHEAST_2</code> – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Seoul) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_ME_CENTRAL_1</code> – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Middle East (UAE) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_ME_SOUTH_1</code> – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Middle East (Bahrain) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_AP_NORTHEAST_1</code> – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Tokyo) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_IL_CENTRAL_1</code> – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Israel (Tel Aviv) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_SA_EAST_1</code> – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in South America (São Paulo) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_CA_CENTRAL_1</code> – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Canada (Central) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_AP_SOUTHEAST_1</code> – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Singapore) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_AP_SOUTHEAST_2</code> – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Sydney) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_AP_SOUTHEAST_3</code> – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Asia Pacific (Jakarta) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_EU_CENTRAL_1</code> – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (Frankfurt) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_EU_CENTRAL_2</code> – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in Europe (Zurich) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_US_EAST_1</code> – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in US East (N. Virginia) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_US_EAST_2</code> – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in US East (Ohio) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_US_WEST_1</code> – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in US West (N. California) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_US_WEST_2</code> – Indicates that DKIM was configured for the identity by replicating signing attributes from a parent identity in US West (Oregon) region using Deterministic Easy-DKIM (DEED). </p> </li> </ul>', 'DkimSigningAttributes$DomainSigningAttributesOrigin' => '<p>The attribute to use for configuring DKIM for the identity depends on the operation: </p> <ol> <li> <p>For <code>PutEmailIdentityDkimSigningAttributes</code>: </p> <ul> <li> <p>None of the values are allowed - use the <a href="https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_PutEmailIdentityDkimSigningAttributes.html#SES-PutEmailIdentityDkimSigningAttributes-request-SigningAttributesOrigin"> <code>SigningAttributesOrigin</code> </a> parameter instead </p> </li> </ul> </li> <li> <p>For <code>CreateEmailIdentity</code> when replicating a parent identity\'s DKIM configuration: </p> <ul> <li> <p>Allowed values: All values except <code>AWS_SES</code> and <code>EXTERNAL</code> </p> </li> </ul> </li> </ol> <ul> <li> <p> <code>AWS_SES</code> – Configure DKIM for the identity by using Easy DKIM. </p> </li> <li> <p> <code>EXTERNAL</code> – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM). </p> </li> <li> <p> <code>AWS_SES_AF_SOUTH_1</code> – Configure DKIM for the identity by replicating from a parent identity in Africa (Cape Town) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_EU_NORTH_1</code> – Configure DKIM for the identity by replicating from a parent identity in Europe (Stockholm) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_AP_SOUTH_1</code> – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Mumbai) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_AP_SOUTH_2</code> – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Hyderabad) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_EU_WEST_3</code> – Configure DKIM for the identity by replicating from a parent identity in Europe (Paris) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_EU_WEST_2</code> – Configure DKIM for the identity by replicating from a parent identity in Europe (London) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_EU_SOUTH_1</code> – Configure DKIM for the identity by replicating from a parent identity in Europe (Milan) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_EU_WEST_1</code> – Configure DKIM for the identity by replicating from a parent identity in Europe (Ireland) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_AP_NORTHEAST_3</code> – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Osaka) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_AP_NORTHEAST_2</code> – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Seoul) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_ME_CENTRAL_1</code> – Configure DKIM for the identity by replicating from a parent identity in Middle East (UAE) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_ME_SOUTH_1</code> – Configure DKIM for the identity by replicating from a parent identity in Middle East (Bahrain) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_AP_NORTHEAST_1</code> – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Tokyo) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_IL_CENTRAL_1</code> – Configure DKIM for the identity by replicating from a parent identity in Israel (Tel Aviv) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_SA_EAST_1</code> – Configure DKIM for the identity by replicating from a parent identity in South America (São Paulo) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_CA_CENTRAL_1</code> – Configure DKIM for the identity by replicating from a parent identity in Canada (Central) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_AP_SOUTHEAST_1</code> – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Singapore) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_AP_SOUTHEAST_2</code> – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Sydney) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_AP_SOUTHEAST_3</code> – Configure DKIM for the identity by replicating from a parent identity in Asia Pacific (Jakarta) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_EU_CENTRAL_1</code> – Configure DKIM for the identity by replicating from a parent identity in Europe (Frankfurt) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_EU_CENTRAL_2</code> – Configure DKIM for the identity by replicating from a parent identity in Europe (Zurich) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_US_EAST_1</code> – Configure DKIM for the identity by replicating from a parent identity in US East (N. Virginia) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_US_EAST_2</code> – Configure DKIM for the identity by replicating from a parent identity in US East (Ohio) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_US_WEST_1</code> – Configure DKIM for the identity by replicating from a parent identity in US West (N. California) region using Deterministic Easy-DKIM (DEED). </p> </li> <li> <p> <code>AWS_SES_US_WEST_2</code> – Configure DKIM for the identity by replicating from a parent identity in US West (Oregon) region using Deterministic Easy-DKIM (DEED). </p> </li> </ul>', 'PutEmailIdentityDkimSigningAttributesRequest$SigningAttributesOrigin' => '<p>The method to use to configure DKIM for the identity. There are the following possible values:</p> <ul> <li> <p> <code>AWS_SES</code> – Configure DKIM for the identity by using <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Easy DKIM</a>.</p> </li> <li> <p> <code>EXTERNAL</code> – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM).</p> </li> </ul>', ], ], 'DkimSigningKeyLength' => [ 'base' => NULL, 'refs' => [ 'DkimAttributes$NextSigningKeyLength' => '<p>[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.</p>', 'DkimAttributes$CurrentSigningKeyLength' => '<p>[Easy DKIM] The key length of the DKIM key pair in use.</p>', 'DkimSigningAttributes$NextSigningKeyLength' => '<p>[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.</p>', ], ], 'DkimStatus' => [ 'base' => '<p>The DKIM authentication status of the identity. The status can be one of the following:</p> <ul> <li> <p> <code>PENDING</code> – The verification process was initiated, but Amazon SES hasn\'t yet detected the DKIM records in the DNS configuration for the domain.</p> </li> <li> <p> <code>SUCCESS</code> – The verification process completed successfully.</p> </li> <li> <p> <code>FAILED</code> – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.</p> </li> <li> <p> <code>TEMPORARY_FAILURE</code> – A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.</p> </li> <li> <p> <code>NOT_STARTED</code> – The DKIM verification process hasn\'t been initiated for the domain.</p> </li> </ul>', 'refs' => [ 'DkimAttributes$Status' => '<p>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:</p> <ul> <li> <p> <code>PENDING</code> – The verification process was initiated, but Amazon SES hasn\'t yet detected the DKIM records in the DNS configuration for the domain.</p> </li> <li> <p> <code>SUCCESS</code> – The verification process completed successfully.</p> </li> <li> <p> <code>FAILED</code> – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.</p> </li> <li> <p> <code>TEMPORARY_FAILURE</code> – A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.</p> </li> <li> <p> <code>NOT_STARTED</code> – The DKIM verification process hasn\'t been initiated for the domain.</p> </li> </ul>', 'PutEmailIdentityDkimSigningAttributesResponse$DkimStatus' => '<p>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 <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Easy DKIM</a> to set up DKIM authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration for your domain.</p> <p>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.</p> <p>The status can be one of the following:</p> <ul> <li> <p> <code>PENDING</code> – The verification process was initiated, but Amazon SES hasn\'t yet detected the DKIM records in the DNS configuration for the domain.</p> </li> <li> <p> <code>SUCCESS</code> – The verification process completed successfully.</p> </li> <li> <p> <code>FAILED</code> – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.</p> </li> <li> <p> <code>TEMPORARY_FAILURE</code> – A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.</p> </li> <li> <p> <code>NOT_STARTED</code> – The DKIM verification process hasn\'t been initiated for the domain.</p> </li> </ul>', ], ], 'DnsToken' => [ 'base' => NULL, 'refs' => [ 'DnsTokenList$member' => NULL, ], ], 'DnsTokenList' => [ 'base' => NULL, 'refs' => [ 'DkimAttributes$Tokens' => '<p>If you used <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Easy DKIM</a> 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.</p> <p>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.</p> <p>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.</p>', 'PutEmailIdentityDkimSigningAttributesResponse$DkimTokens' => '<p>If you used <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Easy DKIM</a> 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.</p> <p>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.</p> <p>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.</p>', ], ], 'Domain' => [ 'base' => NULL, 'refs' => [ 'DomainDeliverabilityTrackingOption$Domain' => '<p>A verified domain that’s associated with your Amazon Web Services account and currently has an active Deliverability dashboard subscription.</p>', 'ListDomainDeliverabilityCampaignsRequest$SubscribedDomain' => '<p>The domain to obtain deliverability data for.</p>', ], ], 'DomainDeliverabilityCampaign' => [ 'base' => '<p>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 (<code>PutDeliverabilityDashboardOption</code> operation).</p>', 'refs' => [ 'DomainDeliverabilityCampaignList$member' => NULL, 'GetDomainDeliverabilityCampaignResponse$DomainDeliverabilityCampaign' => '<p>An object that contains the deliverability data for the campaign.</p>', ], ], 'DomainDeliverabilityCampaignList' => [ 'base' => '<p/>', 'refs' => [ 'ListDomainDeliverabilityCampaignsResponse$DomainDeliverabilityCampaigns' => '<p>An array of responses, one for each campaign that used the domain to send email during the specified time range.</p>', ], ], 'DomainDeliverabilityTrackingOption' => [ 'base' => '<p>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.</p>', 'refs' => [ 'DomainDeliverabilityTrackingOptions$member' => NULL, ], ], 'DomainDeliverabilityTrackingOptions' => [ 'base' => '<p>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.</p>', 'refs' => [ 'GetDeliverabilityDashboardOptionsResponse$ActiveSubscribedDomains' => '<p>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.</p>', 'GetDeliverabilityDashboardOptionsResponse$PendingExpirationSubscribedDomains' => '<p>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.</p>', 'PutDeliverabilityDashboardOptionRequest$SubscribedDomains' => '<p>An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.</p>', ], ], 'DomainIspPlacement' => [ 'base' => '<p>An object that contains inbox placement data for email sent from one of your email domains to a specific email provider.</p>', 'refs' => [ 'DomainIspPlacements$member' => NULL, ], ], 'DomainIspPlacements' => [ 'base' => NULL, 'refs' => [ 'DailyVolume$DomainIspPlacements' => '<p>An object that contains inbox placement metrics for a specified day in the analysis period, broken out by the recipient\'s email provider.</p>', 'OverallVolume$DomainIspPlacements' => '<p>An object that contains inbox and junk mail placement metrics for individual email providers.</p>', ], ], 'EmailAddress' => [ 'base' => NULL, 'refs' => [ 'Contact$EmailAddress' => '<p>The contact\'s email address.</p>', 'CreateContactRequest$EmailAddress' => '<p>The contact\'s email address.</p>', 'CreateCustomVerificationEmailTemplateRequest$FromEmailAddress' => '<p>The email address that the custom verification email is sent from.</p>', 'CreateDeliverabilityTestReportRequest$FromEmailAddress' => '<p>The email address that the predictive inbox placement test email was sent from.</p>', 'CustomVerificationEmailTemplateMetadata$FromEmailAddress' => '<p>The email address that the custom verification email is sent from.</p>', 'DeleteContactRequest$EmailAddress' => '<p>The contact\'s email address.</p>', 'DeleteSuppressedDestinationRequest$EmailAddress' => '<p>The suppressed email destination to remove from the account suppression list.</p>', 'DeliverabilityTestReport$FromEmailAddress' => '<p>The sender address that you specified for the predictive inbox placement test.</p>', 'EmailAddressList$member' => NULL, 'GetContactRequest$EmailAddress' => '<p>The contact\'s email address.</p>', 'GetContactResponse$EmailAddress' => '<p>The contact\'s email address.</p>', 'GetCustomVerificationEmailTemplateResponse$FromEmailAddress' => '<p>The email address that the custom verification email is sent from.</p>', 'GetSuppressedDestinationRequest$EmailAddress' => '<p>The email address that\'s on the account suppression list.</p>', 'PutSuppressedDestinationRequest$EmailAddress' => '<p>The email address that should be added to the suppression list for your account.</p>', 'SendBulkEmailRequest$FromEmailAddress' => '<p>The email address to use as the "From" address for the email. The address that you specify has to be verified.</p>', 'SendBulkEmailRequest$FeedbackForwardingEmailAddress' => '<p>The address that you want bounce and complaint notifications to be sent to.</p>', 'SendCustomVerificationEmailRequest$EmailAddress' => '<p>The email address to verify.</p>', 'SendEmailRequest$FromEmailAddress' => '<p>The email address to use as the "From" address for the email. The address that you specify has to be verified. </p>', 'SendEmailRequest$FeedbackForwardingEmailAddress' => '<p>The address that you want bounce and complaint notifications to be sent to.</p>', 'SuppressedDestination$EmailAddress' => '<p>The email address that is on the suppression list for your account.</p>', 'SuppressedDestinationSummary$EmailAddress' => '<p>The email address that\'s on the suppression list for your account.</p>', 'UpdateContactRequest$EmailAddress' => '<p>The contact\'s email address.</p>', 'UpdateCustomVerificationEmailTemplateRequest$FromEmailAddress' => '<p>The email address that the custom verification email is sent from.</p>', ], ], 'EmailAddressFilterList' => [ 'base' => NULL, 'refs' => [ 'MessageInsightsFilters$FromEmailAddress' => '<p>The from address used to send the message.</p>', 'MessageInsightsFilters$Destination' => '<p>The recipient\'s email address.</p>', ], ], 'EmailAddressList' => [ 'base' => NULL, 'refs' => [ 'Destination$ToAddresses' => '<p>An array that contains the email addresses of the "To" recipients for the email.</p>', 'Destination$CcAddresses' => '<p>An array that contains the email addresses of the "CC" (carbon copy) recipients for the email.</p>', 'Destination$BccAddresses' => '<p>An array that contains the email addresses of the "BCC" (blind carbon copy) recipients for the email.</p>', 'SendBulkEmailRequest$ReplyToAddresses' => '<p>The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.</p>', 'SendEmailRequest$ReplyToAddresses' => '<p>The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.</p>', ], ], 'EmailContent' => [ 'base' => '<p>An object that defines the entire content of the email, including the message headers, body content, and attachments. For a simple email message, you specify the subject and provide both text and HTML versions of the message body. You can also add attachments to simple and templated messages. For a raw message, you provide a complete MIME-formatted message, which can include custom headers and attachments.</p>', 'refs' => [ 'CreateDeliverabilityTestReportRequest$Content' => '<p>The HTML body of the message that you sent when you performed the predictive inbox placement test.</p>', 'SendEmailRequest$Content' => '<p>An object that contains the body of the message. You can send either a Simple message, Raw message, or a Templated message.</p>', ], ], 'EmailInsights' => [ 'base' => '<p>An email\'s insights contain metadata and delivery information about a specific email.</p>', 'refs' => [ 'EmailInsightsList$member' => NULL, ], ], 'EmailInsightsList' => [ 'base' => NULL, 'refs' => [ 'GetMessageInsightsResponse$Insights' => '<p>A set of insights associated with the message.</p>', ], ], 'EmailSubject' => [ 'base' => NULL, 'refs' => [ 'EmailSubjectFilterList$member' => NULL, 'GetMessageInsightsResponse$Subject' => '<p>The subject line of the message.</p>', ], ], 'EmailSubjectFilterList' => [ 'base' => NULL, 'refs' => [ 'MessageInsightsFilters$Subject' => '<p>The subject line of the message.</p>', ], ], 'EmailTemplateContent' => [ 'base' => '<p>The content of the email, composed of a subject line, an HTML part, and a text-only part.</p>', 'refs' => [ 'CreateEmailTemplateRequest$TemplateContent' => '<p>The content of the email template, composed of a subject line, an HTML part, and a text-only part.</p>', 'GetEmailTemplateResponse$TemplateContent' => '<p>The content of the email template, composed of a subject line, an HTML part, and a text-only part.</p>', 'Template$TemplateContent' => '<p>The content of the template.</p> <note> <p>Amazon SES supports only simple substitions when you send email using the <code>SendEmail</code> or <code>SendBulkEmail</code> operations and you provide the full template content in the request.</p> </note>', 'UpdateEmailTemplateRequest$TemplateContent' => '<p>The content of the email template, composed of a subject line, an HTML part, and a text-only part.</p>', ], ], 'EmailTemplateData' => [ 'base' => '<p>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.</p>', 'refs' => [ 'ReplacementTemplate$ReplacementTemplateData' => '<p>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.</p>', 'Template$TemplateData' => '<p>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.</p>', 'TestRenderEmailTemplateRequest$TemplateData' => '<p>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.</p>', ], ], 'EmailTemplateHtml' => [ 'base' => '<p>The HTML body of the email.</p>', 'refs' => [ 'EmailTemplateContent$Html' => '<p>The HTML body of the email.</p>', ], ], 'EmailTemplateMetadata' => [ 'base' => '<p>Contains information about an email template.</p>', 'refs' => [ 'EmailTemplateMetadataList$member' => NULL, ], ], 'EmailTemplateMetadataList' => [ 'base' => '<p>A list of the EmailTemplateMetadata object.</p>', 'refs' => [ 'ListEmailTemplatesResponse$TemplatesMetadata' => '<p>An array the contains the name and creation time stamp for each template in your Amazon SES account.</p>', ], ], 'EmailTemplateName' => [ 'base' => '<p>The name of the template. You will refer to this name when you send email using the <code>SendEmail</code> or <code>SendBulkEmail</code> operations.</p>', 'refs' => [ 'CreateCustomVerificationEmailTemplateRequest$TemplateName' => '<p>The name of the custom verification email template.</p>', 'CreateEmailTemplateRequest$TemplateName' => '<p>The name of the template.</p>', 'CustomVerificationEmailTemplateMetadata$TemplateName' => '<p>The name of the custom verification email template.</p>', 'DeleteCustomVerificationEmailTemplateRequest$TemplateName' => '<p>The name of the custom verification email template that you want to delete.</p>', 'DeleteEmailTemplateRequest$TemplateName' => '<p>The name of the template to be deleted.</p>', 'EmailTemplateMetadata$TemplateName' => '<p>The name of the template.</p>', 'GetCustomVerificationEmailTemplateRequest$TemplateName' => '<p>The name of the custom verification email template that you want to retrieve.</p>', 'GetCustomVerificationEmailTemplateResponse$TemplateName' => '<p>The name of the custom verification email template.</p>', 'GetEmailTemplateRequest$TemplateName' => '<p>The name of the template.</p>', 'GetEmailTemplateResponse$TemplateName' => '<p>The name of the template.</p>', 'SendCustomVerificationEmailRequest$TemplateName' => '<p>The name of the custom verification email template to use when sending the verification email.</p>', 'Template$TemplateName' => '<p>The name of the template. You will refer to this name when you send email using the <code>SendEmail</code> or <code>SendBulkEmail</code> operations. </p>', 'TestRenderEmailTemplateRequest$TemplateName' => '<p>The name of the template.</p>', 'UpdateCustomVerificationEmailTemplateRequest$TemplateName' => '<p>The name of the custom verification email template that you want to update.</p>', 'UpdateEmailTemplateRequest$TemplateName' => '<p>The name of the template.</p>', ], ], 'EmailTemplateSubject' => [ 'base' => '<p>The subject line of the email.</p>', 'refs' => [ 'CreateCustomVerificationEmailTemplateRequest$TemplateSubject' => '<p>The subject line of the custom verification email.</p>', 'CustomVerificationEmailTemplateMetadata$TemplateSubject' => '<p>The subject line of the custom verification email.</p>', 'EmailTemplateContent$Subject' => '<p>The subject line of the email.</p>', 'GetCustomVerificationEmailTemplateResponse$TemplateSubject' => '<p>The subject line of the custom verification email.</p>', 'UpdateCustomVerificationEmailTemplateRequest$TemplateSubject' => '<p>The subject line of the custom verification email.</p>', ], ], 'EmailTemplateText' => [ 'base' => '<p>The email body that will be visible to recipients whose email clients do not display HTML.</p>', 'refs' => [ 'EmailTemplateContent$Text' => '<p>The email body that will be visible to recipients whose email clients do not display HTML.</p>', ], ], 'Enabled' => [ 'base' => NULL, 'refs' => [ 'CreateEmailIdentityResponse$VerifiedForSendingStatus' => '<p>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 <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html">Amazon Pinpoint User Guide</a>.</p>', 'DkimAttributes$SigningEnabled' => '<p>If the value is <code>true</code>, then the messages that you send from the identity are signed using DKIM. If the value is <code>false</code>, then the messages that you send from the identity aren\'t DKIM-signed.</p>', 'EventDestination$Enabled' => '<p>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>.</p> <p>If <code>false</code>, the event destination is disabled. When the event destination is disabled, events aren\'t sent to the specified destinations.</p>', 'EventDestinationDefinition$Enabled' => '<p>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>.</p> <p>If <code>false</code>, the event destination is disabled. When the event destination is disabled, events aren\'t sent to the specified destinations.</p>', 'GetAccountResponse$DedicatedIpAutoWarmupEnabled' => '<p>Indicates whether or not the automatic warm-up feature is enabled for dedicated IP addresses that are associated with your account.</p>', 'GetAccountResponse$ProductionAccessEnabled' => '<p>Indicates whether or not your account has production access in the current Amazon Web Services Region.</p> <p>If the value is <code>false</code>, then your account is in the <i>sandbox</i>. When your account is in the sandbox, you can only send email to verified identities. </p> <p>If the value is <code>true</code>, 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.</p>', 'GetAccountResponse$SendingEnabled' => '<p>Indicates whether or not email sending is enabled for your Amazon SES account in the current Amazon Web Services Region.</p>', 'GetDeliverabilityDashboardOptionsResponse$DashboardEnabled' => '<p>Specifies whether the Deliverability dashboard is enabled. If this value is <code>true</code>, the dashboard is enabled.</p>', 'GetEmailIdentityResponse$FeedbackForwardingStatus' => '<p>The feedback forwarding configuration for the identity.</p> <p>If the value is <code>true</code>, you receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the <code>Return-Path</code> header of the original email.</p> <p>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).</p>', 'GetEmailIdentityResponse$VerifiedForSendingStatus' => '<p>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 <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html">Amazon Pinpoint User Guide</a>.</p>', 'IdentityInfo$SendingEnabled' => '<p>Indicates whether or not you can send email from the identity.</p> <p>An <i>identity</i> 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.</p>', 'InboxPlacementTrackingOption$Global' => '<p>Specifies whether inbox placement data is being tracked for the domain.</p>', 'PutAccountDedicatedIpWarmupAttributesRequest$AutoWarmupEnabled' => '<p>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 <code>true</code> to enable the automatic warm-up feature, or set to <code>false</code> to disable it.</p>', 'PutAccountSendingAttributesRequest$SendingEnabled' => '<p>Enables or disables your account\'s ability to send email. Set to <code>true</code> to enable email sending, or set to <code>false</code> to disable email sending.</p> <note> <p>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.</p> </note>', 'PutConfigurationSetReputationOptionsRequest$ReputationMetricsEnabled' => '<p>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.</p>', 'PutConfigurationSetSendingOptionsRequest$SendingEnabled' => '<p>If <code>true</code>, email sending is enabled for the configuration set. If <code>false</code>, email sending is disabled for the configuration set.</p>', 'PutDeliverabilityDashboardOptionRequest$DashboardEnabled' => '<p>Specifies whether to enable the Deliverability dashboard. To enable the dashboard, set this value to <code>true</code>.</p>', 'PutEmailIdentityDkimAttributesRequest$SigningEnabled' => '<p>Sets the DKIM signing configuration for the identity.</p> <p>When you set this value <code>true</code>, then the messages that are sent from the identity are signed using DKIM. If you set this value to <code>false</code>, your messages are sent without DKIM signing.</p>', 'PutEmailIdentityFeedbackAttributesRequest$EmailForwardingEnabled' => '<p>Sets the feedback forwarding configuration for the identity.</p> <p>If the value is <code>true</code>, you receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the <code>Return-Path</code> header of the original email.</p> <p>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).</p>', 'ReputationOptions$ReputationMetricsEnabled' => '<p>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.</p>', 'SendingOptions$SendingEnabled' => '<p>If <code>true</code>, email sending is enabled for the configuration set. If <code>false</code>, email sending is disabled for the configuration set.</p>', ], ], 'EnabledWrapper' => [ 'base' => NULL, 'refs' => [ 'PutAccountDetailsRequest$ProductionAccessEnabled' => '<p>Indicates whether or not your account should have production access in the current Amazon Web Services Region.</p> <p>If the value is <code>false</code>, then your account is in the <i>sandbox</i>. When your account is in the sandbox, you can only send email to verified identities. </p> <p>If the value is <code>true</code>, 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.</p>', ], ], 'EndpointId' => [ 'base' => '<p>The ID of the multi-region endpoint (global-endpoint).</p>', 'refs' => [ 'CreateMultiRegionEndpointResponse$EndpointId' => '<p>The ID of the multi-region endpoint (global-endpoint).</p>', 'GetMultiRegionEndpointResponse$EndpointId' => '<p>The ID of the multi-region endpoint (global-endpoint).</p>', 'MultiRegionEndpoint$EndpointId' => '<p>The ID of the multi-region endpoint (global-endpoint).</p>', 'SendBulkEmailRequest$EndpointId' => '<p>The ID of the multi-region endpoint (global-endpoint).</p>', 'SendEmailRequest$EndpointId' => '<p>The ID of the multi-region endpoint (global-endpoint).</p>', ], ], 'EndpointName' => [ 'base' => '<p>The name of the multi-region endpoint (global-endpoint).</p>', 'refs' => [ 'CreateMultiRegionEndpointRequest$EndpointName' => '<p>The name of the multi-region endpoint (global-endpoint).</p>', 'DeleteMultiRegionEndpointRequest$EndpointName' => '<p>The name of the multi-region endpoint (global-endpoint) to be deleted.</p>', 'GetMultiRegionEndpointRequest$EndpointName' => '<p>The name of the multi-region endpoint (global-endpoint).</p>', 'GetMultiRegionEndpointResponse$EndpointName' => '<p>The name of the multi-region endpoint (global-endpoint).</p>', 'MultiRegionEndpoint$EndpointName' => '<p>The name of the multi-region endpoint (global-endpoint).</p>', ], ], 'EngagementEventType' => [ 'base' => '<p>The type of delivery events:</p> <ul> <li> <p> <code>OPEN</code> - Open event for emails including open trackers. Excludes opens for emails addressed to more than one recipient.</p> </li> <li> <p> <code>CLICK</code> - Click event for emails including wrapped links. Excludes clicks for emails addressed to more than one recipient.</p> </li> </ul>', 'refs' => [ 'LastEngagementEventList$member' => NULL, ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'BulkEmailEntryResult$Error' => '<p>A description of an error that prevented a message being sent using the <code>SendBulkTemplatedEmail</code> operation.</p>', 'FailureInfo$ErrorMessage' => '<p>A message about why the job failed.</p>', ], ], 'Esp' => [ 'base' => NULL, 'refs' => [ 'Esps$member' => NULL, ], ], 'Esps' => [ 'base' => NULL, 'refs' => [ 'DomainDeliverabilityCampaign$Esps' => '<p>The major email providers who handled the email message.</p>', ], ], 'EventBridgeDestination' => [ 'base' => '<p>An object that defines an Amazon EventBridge destination for email events. You can use Amazon EventBridge to send notifications when certain email events occur.</p>', 'refs' => [ 'EventDestination$EventBridgeDestination' => '<p>An object that defines an Amazon EventBridge destination for email events. You can use Amazon EventBridge to send notifications when certain email events occur.</p>', 'EventDestinationDefinition$EventBridgeDestination' => '<p>An object that defines an Amazon EventBridge destination for email events. You can use Amazon EventBridge to send notifications when certain email events occur.</p>', ], ], 'EventDestination' => [ 'base' => '<p>In the Amazon SES API v2, <i>events</i> include message sends, deliveries, opens, clicks, bounces, complaints and delivery delays. <i>Event destinations</i> 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.</p>', 'refs' => [ 'EventDestinations$member' => NULL, ], ], 'EventDestinationDefinition' => [ 'base' => '<p>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.</p>', 'refs' => [ 'CreateConfigurationSetEventDestinationRequest$EventDestination' => '<p>An object that defines the event destination.</p>', 'UpdateConfigurationSetEventDestinationRequest$EventDestination' => '<p>An object that defines the event destination.</p>', ], ], 'EventDestinationName' => [ 'base' => '<p>The name of an event destination.</p> <p> <i>Events</i> include message sends, deliveries, opens, clicks, bounces, and complaints. <i>Event destinations</i> 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.</p>', 'refs' => [ 'CreateConfigurationSetEventDestinationRequest$EventDestinationName' => '<p>A name that identifies the event destination within the configuration set.</p>', 'DeleteConfigurationSetEventDestinationRequest$EventDestinationName' => '<p>The name of the event destination to delete.</p>', 'EventDestination$Name' => '<p>A name that identifies the event destination.</p>', 'UpdateConfigurationSetEventDestinationRequest$EventDestinationName' => '<p>The name of the event destination.</p>', ], ], 'EventDestinations' => [ 'base' => NULL, 'refs' => [ 'GetConfigurationSetEventDestinationsResponse$EventDestinations' => '<p>An array that includes all of the events destinations that have been configured for the configuration set.</p>', ], ], 'EventDetails' => [ 'base' => '<p> Contains a <code>Bounce</code> object if the event type is <code>BOUNCE</code>. Contains a <code>Complaint</code> object if the event type is <code>COMPLAINT</code>. </p>', 'refs' => [ 'InsightsEvent$Details' => '<p>Details about bounce or complaint events.</p>', ], ], 'EventType' => [ 'base' => '<p>An email sending event type. For example, email sends, opens, and bounces are all email events.</p>', 'refs' => [ 'EventTypes$member' => NULL, 'InsightsEvent$Type' => '<p>The type of event:</p> <ul> <li> <p> <code>SEND</code> - The send request was successful and SES will attempt to deliver the message to the recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed.) </p> </li> <li> <p> <code>DELIVERY</code> - SES successfully delivered the email to the recipient\'s mail server. Excludes deliveries to the mailbox simulator, and those from emails addressed to more than one recipient. </p> </li> <li> <p> <code>BOUNCE</code> - Feedback received for delivery failures. Additional details about the bounce are provided in the <code>Details</code> object. Excludes bounces from the mailbox simulator, and those from emails addressed to more than one recipient. </p> </li> <li> <p> <code>COMPLAINT</code> - Complaint received for the email. Additional details about the complaint are provided in the <code>Details</code> object. This excludes complaints from the mailbox simulator, those originating from your account-level suppression list (if enabled), and those from emails addressed to more than one recipient. </p> </li> <li> <p> <code>OPEN</code> - Open event for emails including open trackers. Excludes opens for emails addressed to more than one recipient.</p> </li> <li> <p> <code>CLICK</code> - Click event for emails including wrapped links. Excludes clicks for emails addressed to more than one recipient.</p> </li> </ul>', ], ], 'EventTypes' => [ 'base' => NULL, 'refs' => [ 'EventDestination$MatchingEventTypes' => '<p>The types of events that Amazon SES sends to the specified event destinations.</p> <ul> <li> <p> <code>SEND</code> - The send request was successful and SES will attempt to deliver the message to the recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed.)</p> </li> <li> <p> <code>REJECT</code> - SES accepted the email, but determined that it contained a virus and didn’t attempt to deliver it to the recipient’s mail server.</p> </li> <li> <p> <code>BOUNCE</code> - (<i>Hard bounce</i>) The recipient\'s mail server permanently rejected the email. (<i>Soft bounces</i> are only included when SES fails to deliver the email after retrying for a period of time.)</p> </li> <li> <p> <code>COMPLAINT</code> - The email was successfully delivered to the recipient’s mail server, but the recipient marked it as spam.</p> </li> <li> <p> <code>DELIVERY</code> - SES successfully delivered the email to the recipient\'s mail server.</p> </li> <li> <p> <code>OPEN</code> - The recipient received the message and opened it in their email client.</p> </li> <li> <p> <code>CLICK</code> - The recipient clicked one or more links in the email.</p> </li> <li> <p> <code>RENDERING_FAILURE</code> - The email wasn\'t sent because of a template rendering issue. This event type can occur when template data is missing, or when there is a mismatch between template parameters and data. (This event type only occurs when you send email using the <a href="https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_SendEmail.html"> <code>SendEmail</code> </a> or <a href="https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_SendBulkEmail.html"> <code>SendBulkEmail</code> </a> API operations.) </p> </li> <li> <p> <code>DELIVERY_DELAY</code> - The email couldn\'t be delivered to the recipient’s mail server because a temporary issue occurred. Delivery delays can occur, for example, when the recipient\'s inbox is full, or when the receiving email server experiences a transient issue.</p> </li> <li> <p> <code>SUBSCRIPTION</code> - The email was successfully delivered, but the recipient updated their subscription preferences by clicking on an <i>unsubscribe</i> link as part of your <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-email-subscription-management.html">subscription management</a>.</p> </li> </ul>', 'EventDestinationDefinition$MatchingEventTypes' => '<p>An array that specifies which events the Amazon SES API v2 should send to the destinations in this <code>EventDestinationDefinition</code>.</p>', ], ], 'ExportDataSource' => [ 'base' => '<p>An object that contains details about the data source of the export job. It can only contain one of <code>MetricsDataSource</code> or <code>MessageInsightsDataSource</code> object.</p>', 'refs' => [ 'CreateExportJobRequest$ExportDataSource' => '<p>The data source for the export job.</p>', 'GetExportJobResponse$ExportDataSource' => '<p>The data source of the export job.</p>', ], ], 'ExportDestination' => [ 'base' => '<p>An object that contains details about the destination of the export job.</p>', 'refs' => [ 'CreateExportJobRequest$ExportDestination' => '<p>The destination for the export job.</p>', 'GetExportJobResponse$ExportDestination' => '<p>The destination of the export job.</p>', ], ], 'ExportDimensionValue' => [ 'base' => NULL, 'refs' => [ 'ExportDimensions$value' => NULL, ], ], 'ExportDimensions' => [ 'base' => NULL, 'refs' => [ 'MetricsDataSource$Dimensions' => '<p>An object that contains a mapping between a <code>MetricDimensionName</code> and <code>MetricDimensionValue</code> to filter metrics by. Must contain a least 1 dimension but no more than 3 unique ones.</p>', ], ], 'ExportJobSummary' => [ 'base' => '<p>A summary of the export job.</p>', 'refs' => [ 'ExportJobSummaryList$member' => NULL, ], ], 'ExportJobSummaryList' => [ 'base' => '<p>A list of the export job summaries.</p>', 'refs' => [ 'ListExportJobsResponse$ExportJobs' => '<p>A list of the export job summaries.</p>', ], ], 'ExportMetric' => [ 'base' => '<p>An object that contains a mapping between a <code>Metric</code> and <code>MetricAggregation</code>.</p>', 'refs' => [ 'ExportMetrics$member' => NULL, ], ], 'ExportMetrics' => [ 'base' => NULL, 'refs' => [ 'MetricsDataSource$Metrics' => '<p>A list of <code>ExportMetric</code> objects to export.</p>', ], ], 'ExportSourceType' => [ 'base' => '<p>The type of data source of an export, can be one of the following:</p> <ul> <li> <p> <code>METRICS_DATA</code> - The metrics export.</p> </li> <li> <p> <code>MESSAGE_INSIGHTS</code> - The Message Insights export.</p> </li> </ul>', 'refs' => [ 'ExportJobSummary$ExportSourceType' => '<p>The source type of the export job.</p>', 'GetExportJobResponse$ExportSourceType' => '<p>The type of source of the export job.</p>', 'ListExportJobsRequest$ExportSourceType' => '<p>A value used to list export jobs that have a certain <code>ExportSourceType</code>.</p>', ], ], 'ExportStatistics' => [ 'base' => '<p>Statistics about the execution of an export job.</p>', 'refs' => [ 'GetExportJobResponse$Statistics' => '<p>The statistics about the export job.</p>', ], ], 'ExportedRecordsCount' => [ 'base' => NULL, 'refs' => [ 'ExportStatistics$ExportedRecordsCount' => '<p>The number of records that were exported to the final export file.</p> <p>This value might not be available for all export source types</p>', ], ], 'FailedRecordsCount' => [ 'base' => NULL, 'refs' => [ 'GetImportJobResponse$FailedRecordsCount' => '<p>The number of records that failed processing because of invalid input or other reasons.</p>', 'ImportJobSummary$FailedRecordsCount' => '<p>The number of records that failed processing because of invalid input or other reasons.</p>', ], ], 'FailedRecordsS3Url' => [ 'base' => NULL, 'refs' => [ 'FailureInfo$FailedRecordsS3Url' => '<p>An Amazon S3 pre-signed URL that contains all the failed records and related information.</p>', ], ], 'FailureInfo' => [ 'base' => '<p>An object that contains the failure details about a job.</p>', 'refs' => [ 'GetExportJobResponse$FailureInfo' => '<p>The failure details about an export job.</p>', 'GetImportJobResponse$FailureInfo' => '<p>The failure details about an import job.</p>', ], ], 'FailureRedirectionURL' => [ 'base' => '<p>The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.</p>', 'refs' => [ 'CreateCustomVerificationEmailTemplateRequest$FailureRedirectionURL' => '<p>The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.</p>', 'CustomVerificationEmailTemplateMetadata$FailureRedirectionURL' => '<p>The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.</p>', 'GetCustomVerificationEmailTemplateResponse$FailureRedirectionURL' => '<p>The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.</p>', 'UpdateCustomVerificationEmailTemplateRequest$FailureRedirectionURL' => '<p>The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.</p>', ], ], 'FeatureStatus' => [ 'base' => NULL, 'refs' => [ 'DashboardAttributes$EngagementMetrics' => '<p>Specifies the status of your VDM engagement metrics collection. Can be one of the following:</p> <ul> <li> <p> <code>ENABLED</code> – Amazon SES enables engagement metrics for your account.</p> </li> <li> <p> <code>DISABLED</code> – Amazon SES disables engagement metrics for your account.</p> </li> </ul>', 'DashboardOptions$EngagementMetrics' => '<p>Specifies the status of your VDM engagement metrics collection. Can be one of the following:</p> <ul> <li> <p> <code>ENABLED</code> – Amazon SES enables engagement metrics for the configuration set.</p> </li> <li> <p> <code>DISABLED</code> – Amazon SES disables engagement metrics for the configuration set.</p> </li> </ul>', 'GuardianAttributes$OptimizedSharedDelivery' => '<p>Specifies the status of your VDM optimized shared delivery. Can be one of the following:</p> <ul> <li> <p> <code>ENABLED</code> – Amazon SES enables optimized shared delivery for your account.</p> </li> <li> <p> <code>DISABLED</code> – Amazon SES disables optimized shared delivery for your account.</p> </li> </ul>', 'GuardianOptions$OptimizedSharedDelivery' => '<p>Specifies the status of your VDM optimized shared delivery. Can be one of the following:</p> <ul> <li> <p> <code>ENABLED</code> – Amazon SES enables optimized shared delivery for the configuration set.</p> </li> <li> <p> <code>DISABLED</code> – Amazon SES disables optimized shared delivery for the configuration set.</p> </li> </ul>', 'VdmAttributes$VdmEnabled' => '<p>Specifies the status of your VDM configuration. Can be one of the following:</p> <ul> <li> <p> <code>ENABLED</code> – Amazon SES enables VDM for your account.</p> </li> <li> <p> <code>DISABLED</code> – Amazon SES disables VDM for your account.</p> </li> </ul>', ], ], 'FeedbackId' => [ 'base' => NULL, 'refs' => [ 'SuppressedDestinationAttributes$FeedbackId' => '<p>A unique identifier that\'s generated when an email address is added to the suppression list for your account.</p>', ], ], 'GeneralEnforcementStatus' => [ 'base' => NULL, 'refs' => [ 'GetAccountResponse$EnforcementStatus' => '<p>The reputation status of your Amazon SES account. The status can be one of the following:</p> <ul> <li> <p> <code>HEALTHY</code> – There are no reputation-related issues that currently impact your account.</p> </li> <li> <p> <code>PROBATION</code> – We\'ve identified potential issues with your Amazon SES account. We\'re placing your account under review while you work on correcting these issues.</p> </li> <li> <p> <code>SHUTDOWN</code> – Your account\'s ability to send email is currently paused because of an issue with the email sent from your account. When you correct the issue, you can contact us and request that your account\'s ability to send email is resumed.</p> </li> </ul>', ], ], 'GetAccountRequest' => [ 'base' => '<p>A request to obtain information about the email-sending capabilities of your Amazon SES account.</p>', 'refs' => [], ], 'GetAccountResponse' => [ 'base' => '<p>A list of details about the email-sending capabilities of your Amazon SES account in the current Amazon Web Services Region.</p>', 'refs' => [], ], 'GetBlacklistReportsRequest' => [ 'base' => '<p>A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.</p>', 'refs' => [], ], 'GetBlacklistReportsResponse' => [ 'base' => '<p>An object that contains information about blacklist events.</p>', 'refs' => [], ], 'GetConfigurationSetEventDestinationsRequest' => [ 'base' => '<p>A request to obtain information about the event destinations for a configuration set.</p>', 'refs' => [], ], 'GetConfigurationSetEventDestinationsResponse' => [ 'base' => '<p>Information about an event destination for a configuration set.</p>', 'refs' => [], ], 'GetConfigurationSetRequest' => [ 'base' => '<p>A request to obtain information about a configuration set.</p>', 'refs' => [], ], 'GetConfigurationSetResponse' => [ 'base' => '<p>Information about a configuration set.</p>', 'refs' => [], ], 'GetContactListRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetContactListResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCustomVerificationEmailTemplateRequest' => [ 'base' => '<p>Represents a request to retrieve an existing custom verification email template.</p>', 'refs' => [], ], 'GetCustomVerificationEmailTemplateResponse' => [ 'base' => '<p>The following elements are returned by the service.</p>', 'refs' => [], ], 'GetDedicatedIpPoolRequest' => [ 'base' => '<p>A request to obtain more information about a dedicated IP pool.</p>', 'refs' => [], ], 'GetDedicatedIpPoolResponse' => [ 'base' => '<p>The following element is returned by the service.</p>', 'refs' => [], ], 'GetDedicatedIpRequest' => [ 'base' => '<p>A request to obtain more information about a dedicated IP address.</p>', 'refs' => [], ], 'GetDedicatedIpResponse' => [ 'base' => '<p>Information about a dedicated IP address.</p>', 'refs' => [], ], 'GetDedicatedIpsRequest' => [ 'base' => '<p>A request to obtain more information about dedicated IP pools.</p>', 'refs' => [], ], 'GetDedicatedIpsResponse' => [ 'base' => '<p>Information about the dedicated IP addresses that are associated with your Amazon Web Services account.</p>', 'refs' => [], ], 'GetDeliverabilityDashboardOptionsRequest' => [ 'base' => '<p>Retrieve information about the status of the Deliverability dashboard for your Amazon Web Services account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for your domains. You also gain the ability to perform predictive inbox placement tests.</p> <p>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 <a href="http://aws.amazon.com/pinpoint/pricing/">Amazon Pinpoint Pricing</a>.</p>', 'refs' => [], ], 'GetDeliverabilityDashboardOptionsResponse' => [ 'base' => '<p>An object that shows the status of the Deliverability dashboard.</p>', 'refs' => [], ], 'GetDeliverabilityTestReportRequest' => [ 'base' => '<p>A request to retrieve the results of a predictive inbox placement test.</p>', 'refs' => [], ], 'GetDeliverabilityTestReportResponse' => [ 'base' => '<p>The results of the predictive inbox placement test.</p>', 'refs' => [], ], 'GetDomainDeliverabilityCampaignRequest' => [ 'base' => '<p>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 (<code>PutDeliverabilityDashboardOption</code> operation).</p>', 'refs' => [], ], 'GetDomainDeliverabilityCampaignResponse' => [ 'base' => '<p>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.</p>', 'refs' => [], ], 'GetDomainStatisticsReportRequest' => [ 'base' => '<p>A request to obtain deliverability metrics for a domain.</p>', 'refs' => [], ], 'GetDomainStatisticsReportResponse' => [ 'base' => '<p>An object that includes statistics that are related to the domain that you specified.</p>', 'refs' => [], ], 'GetEmailIdentityPoliciesRequest' => [ 'base' => '<p>A request to return the policies of an email identity.</p>', 'refs' => [], ], 'GetEmailIdentityPoliciesResponse' => [ 'base' => '<p>Identity policies associated with email identity.</p>', 'refs' => [], ], 'GetEmailIdentityRequest' => [ 'base' => '<p>A request to return details about an email identity.</p>', 'refs' => [], ], 'GetEmailIdentityResponse' => [ 'base' => '<p>Details about an email identity.</p>', 'refs' => [], ], 'GetEmailTemplateRequest' => [ 'base' => '<p>Represents a request to display the template object (which includes the subject line, HTML part and text part) for the template you specify.</p>', 'refs' => [], ], 'GetEmailTemplateResponse' => [ 'base' => '<p>The following element is returned by the service.</p>', 'refs' => [], ], 'GetExportJobRequest' => [ 'base' => '<p>Represents a request to retrieve information about an export job using the export job ID.</p>', 'refs' => [], ], 'GetExportJobResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'GetImportJobRequest' => [ 'base' => '<p>Represents a request for information about an import job using the import job ID.</p>', 'refs' => [], ], 'GetImportJobResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'GetMessageInsightsRequest' => [ 'base' => '<p>A request to return information about a message.</p>', 'refs' => [], ], 'GetMessageInsightsResponse' => [ 'base' => '<p>Information about a message.</p>', 'refs' => [], ], 'GetMultiRegionEndpointRequest' => [ 'base' => '<p>Represents a request to display the multi-region endpoint (global-endpoint).</p>', 'refs' => [], ], 'GetMultiRegionEndpointResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'GetReputationEntityRequest' => [ 'base' => '<p>Represents a request to retrieve information about a specific reputation entity.</p>', 'refs' => [], ], 'GetReputationEntityResponse' => [ 'base' => '<p>Information about the requested reputation entity.</p>', 'refs' => [], ], 'GetSuppressedDestinationRequest' => [ 'base' => '<p>A request to retrieve information about an email address that\'s on the suppression list for your account.</p>', 'refs' => [], ], 'GetSuppressedDestinationResponse' => [ 'base' => '<p>Information about the suppressed email address.</p>', 'refs' => [], ], 'GetTenantRequest' => [ 'base' => '<p>Represents a request to get information about a specific tenant.</p>', 'refs' => [], ], 'GetTenantResponse' => [ 'base' => '<p>Information about a specific tenant.</p>', 'refs' => [], ], 'GuardianAttributes' => [ 'base' => '<p>An object containing additional settings for your VDM configuration as applicable to the Guardian.</p>', 'refs' => [ 'VdmAttributes$GuardianAttributes' => '<p>Specifies additional settings for your VDM configuration as applicable to the Guardian.</p>', ], ], 'GuardianOptions' => [ 'base' => '<p>An object containing additional settings for your VDM configuration as applicable to the Guardian.</p>', 'refs' => [ 'VdmOptions$GuardianOptions' => '<p>Specifies additional settings for your VDM configuration as applicable to the Guardian.</p>', ], ], 'HttpsPolicy' => [ 'base' => '<p>The https policy to use for tracking open and click events. If the value is OPTIONAL or HttpsPolicy is not specified, the open trackers use HTTP and click tracker use the original protocol of the link. If the value is REQUIRE, both open and click tracker uses HTTPS and if the value is REQUIRE_OPEN_ONLY open tracker uses HTTPS and link tracker is same as original protocol of the link. </p>', 'refs' => [ 'PutConfigurationSetTrackingOptionsRequest$HttpsPolicy' => NULL, 'TrackingOptions$HttpsPolicy' => '<p>The https policy to use for tracking open and click events.</p>', ], ], 'Identity' => [ 'base' => NULL, 'refs' => [ 'CreateEmailIdentityPolicyRequest$EmailIdentity' => '<p>The email identity.</p>', 'CreateEmailIdentityRequest$EmailIdentity' => '<p>The email address or domain to verify.</p>', 'DeleteEmailIdentityPolicyRequest$EmailIdentity' => '<p>The email identity.</p>', 'DeleteEmailIdentityRequest$EmailIdentity' => '<p>The identity (that is, the email address or domain) to delete.</p>', 'DomainDeliverabilityCampaign$FromAddress' => '<p>The verified email address that the email message was sent from.</p>', 'GetDomainStatisticsReportRequest$Domain' => '<p>The domain that you want to obtain deliverability metrics for.</p>', 'GetEmailIdentityPoliciesRequest$EmailIdentity' => '<p>The email identity.</p>', 'GetEmailIdentityRequest$EmailIdentity' => '<p>The email identity.</p>', 'IdentityInfo$IdentityName' => '<p>The address or domain of the identity.</p>', 'PutEmailIdentityConfigurationSetAttributesRequest$EmailIdentity' => '<p>The email address or domain to associate with a configuration set.</p>', 'PutEmailIdentityDkimAttributesRequest$EmailIdentity' => '<p>The email identity.</p>', 'PutEmailIdentityDkimSigningAttributesRequest$EmailIdentity' => '<p>The email identity.</p>', 'PutEmailIdentityFeedbackAttributesRequest$EmailIdentity' => '<p>The email identity.</p>', 'PutEmailIdentityMailFromAttributesRequest$EmailIdentity' => '<p>The verified email identity.</p>', 'UpdateEmailIdentityPolicyRequest$EmailIdentity' => '<p>The email identity.</p>', ], ], 'IdentityInfo' => [ 'base' => '<p>Information about an email identity.</p>', 'refs' => [ 'IdentityInfoList$member' => NULL, ], ], 'IdentityInfoList' => [ 'base' => NULL, 'refs' => [ 'ListEmailIdentitiesResponse$EmailIdentities' => '<p>An array that includes all of the email identities associated with your Amazon Web Services account.</p>', ], ], 'IdentityType' => [ 'base' => NULL, 'refs' => [ 'CreateEmailIdentityResponse$IdentityType' => '<p>The email identity type. Note: the <code>MANAGED_DOMAIN</code> identity type is not supported.</p>', 'GetEmailIdentityResponse$IdentityType' => '<p>The email identity type. Note: the <code>MANAGED_DOMAIN</code> identity type is not supported.</p>', 'IdentityInfo$IdentityType' => '<p>The email identity type. Note: the <code>MANAGED_DOMAIN</code> type is not supported for email identity types.</p>', ], ], 'ImageUrl' => [ 'base' => NULL, 'refs' => [ 'DomainDeliverabilityCampaign$ImageUrl' => '<p>The URL of an image that contains a snapshot of the email message that was sent.</p>', ], ], 'ImportDataSource' => [ 'base' => '<p>An object that contains details about the data source of the import job.</p>', 'refs' => [ 'CreateImportJobRequest$ImportDataSource' => '<p>The data source for the import job.</p>', 'GetImportJobResponse$ImportDataSource' => '<p>The data source of the import job.</p>', ], ], 'ImportDestination' => [ 'base' => '<p>An object that contains details about the resource destination the import job is going to target.</p>', 'refs' => [ 'CreateImportJobRequest$ImportDestination' => '<p>The destination for the import job.</p>', 'GetImportJobResponse$ImportDestination' => '<p>The destination of the import job.</p>', 'ImportJobSummary$ImportDestination' => NULL, ], ], 'ImportDestinationType' => [ 'base' => '<p>The destination of the import job, which can be used to list import jobs that have a certain <code>ImportDestinationType</code>.</p>', 'refs' => [ 'ListImportJobsRequest$ImportDestinationType' => '<p>The destination of the import job, which can be used to list import jobs that have a certain <code>ImportDestinationType</code>.</p>', ], ], 'ImportJobSummary' => [ 'base' => '<p>A summary of the import job.</p>', 'refs' => [ 'ImportJobSummaryList$member' => NULL, ], ], 'ImportJobSummaryList' => [ 'base' => '<p>A list of the import job summaries.</p>', 'refs' => [ 'ListImportJobsResponse$ImportJobs' => '<p>A list of the import job summaries.</p>', ], ], 'InboxPlacementTrackingOption' => [ 'base' => '<p>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.</p>', 'refs' => [ 'DomainDeliverabilityTrackingOption$InboxPlacementTrackingOption' => '<p>An object that contains information about the inbox placement data settings for the domain.</p>', ], ], 'InsightsEmailAddress' => [ 'base' => NULL, 'refs' => [ 'EmailAddressFilterList$member' => NULL, 'EmailInsights$Destination' => '<p>The recipient of the email.</p>', 'GetMessageInsightsResponse$FromEmailAddress' => '<p>The from address used to send the message.</p>', ], ], 'InsightsEvent' => [ 'base' => '<p>An object containing details about a specific event.</p>', 'refs' => [ 'InsightsEvents$member' => NULL, ], ], 'InsightsEvents' => [ 'base' => NULL, 'refs' => [ 'EmailInsights$Events' => '<p>A list of events associated with the sent email.</p>', ], ], 'InternalServiceErrorException' => [ 'base' => '<p>The request couldn\'t be processed because an error occurred with the Amazon SES API v2.</p>', 'refs' => [], ], 'InvalidNextTokenException' => [ 'base' => '<p>The specified request includes an invalid or expired token.</p>', 'refs' => [], ], 'Ip' => [ 'base' => '<p>An IPv4 address.</p>', 'refs' => [ 'DedicatedIp$Ip' => '<p>An IPv4 address.</p>', 'GetDedicatedIpRequest$Ip' => '<p>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.</p>', 'IpList$member' => NULL, 'PutDedicatedIpInPoolRequest$Ip' => '<p>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.</p>', 'PutDedicatedIpWarmupAttributesRequest$Ip' => '<p>The dedicated IP address that you want to update the warm-up attributes for.</p>', ], ], 'IpList' => [ 'base' => NULL, 'refs' => [ 'DomainDeliverabilityCampaign$SendingIps' => '<p>The IP addresses that were used to send the email message.</p>', ], ], 'Isp' => [ 'base' => NULL, 'refs' => [ 'EmailInsights$Isp' => '<p>The recipient\'s ISP (e.g., <code>Gmail</code>, <code>Yahoo</code>, etc.).</p>', 'IspFilterList$member' => NULL, ], ], 'IspFilterList' => [ 'base' => NULL, 'refs' => [ 'MessageInsightsFilters$Isp' => '<p>The recipient\'s ISP (e.g., <code>Gmail</code>, <code>Yahoo</code>, etc.).</p>', ], ], 'IspName' => [ 'base' => '<p>The name of an email provider.</p>', 'refs' => [ 'DomainIspPlacement$IspName' => '<p>The name of the email provider that the inbox placement data applies to.</p>', 'IspNameList$member' => NULL, 'IspPlacement$IspName' => '<p>The name of the email provider that the inbox placement data applies to.</p>', ], ], 'IspNameList' => [ 'base' => NULL, 'refs' => [ 'InboxPlacementTrackingOption$TrackedIsps' => '<p>An array of strings, one for each major email provider that the inbox placement data applies to.</p>', ], ], 'IspPlacement' => [ 'base' => '<p>An object that describes how email sent during the predictive inbox placement test was handled by a certain email provider.</p>', 'refs' => [ 'IspPlacements$member' => NULL, ], ], 'IspPlacements' => [ 'base' => NULL, 'refs' => [ 'GetDeliverabilityTestReportResponse$IspPlacements' => '<p>An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others.</p>', ], ], 'JobId' => [ 'base' => '<p>A string that represents a job ID.</p>', 'refs' => [ 'CancelExportJobRequest$JobId' => '<p>The export job ID.</p>', 'CreateExportJobResponse$JobId' => '<p>A string that represents the export job ID.</p>', 'CreateImportJobResponse$JobId' => '<p>A string that represents the import job ID.</p>', 'ExportJobSummary$JobId' => '<p>The export job ID.</p>', 'GetExportJobRequest$JobId' => '<p>The export job ID.</p>', 'GetExportJobResponse$JobId' => '<p>The export job ID.</p>', 'GetImportJobRequest$JobId' => '<p>The ID of the import job.</p>', 'GetImportJobResponse$JobId' => '<p>A string that represents the import job ID.</p>', 'ImportJobSummary$JobId' => NULL, ], ], 'JobStatus' => [ 'base' => '<p>The status of a job.</p> <ul> <li> <p> <code>CREATED</code> – Job has just been created.</p> </li> <li> <p> <code>PROCESSING</code> – Job is processing.</p> </li> <li> <p> <code>ERROR</code> – An error occurred during processing.</p> </li> <li> <p> <code>COMPLETED</code> – Job has completed processing successfully.</p> </li> </ul>', 'refs' => [ 'ExportJobSummary$JobStatus' => '<p>The status of the export job.</p>', 'GetExportJobResponse$JobStatus' => '<p>The status of the export job.</p>', 'GetImportJobResponse$JobStatus' => '<p>The status of the import job.</p>', 'ImportJobSummary$JobStatus' => NULL, 'ListExportJobsRequest$JobStatus' => '<p>A value used to list export jobs that have a certain <code>JobStatus</code>.</p>', ], ], 'KinesisFirehoseDestination' => [ 'base' => '<p>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.</p>', 'refs' => [ 'EventDestination$KinesisFirehoseDestination' => '<p>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.</p>', 'EventDestinationDefinition$KinesisFirehoseDestination' => '<p>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.</p>', ], ], 'LastDeliveryEventList' => [ 'base' => NULL, 'refs' => [ 'MessageInsightsFilters$LastDeliveryEvent' => '<p> The last delivery-related event for the email, where the ordering is as follows: <code>SEND</code> &lt; <code>BOUNCE</code> &lt; <code>DELIVERY</code> &lt; <code>COMPLAINT</code>. </p>', ], ], 'LastEngagementEventList' => [ 'base' => NULL, 'refs' => [ 'MessageInsightsFilters$LastEngagementEvent' => '<p> The last engagement-related event for the email, where the ordering is as follows: <code>OPEN</code> &lt; <code>CLICK</code>. </p> <p> Engagement events are only available if <a href="https://docs.aws.amazon.com/ses/latest/dg/vdm-settings.html">Engagement tracking</a> is enabled. </p>', ], ], 'LastFreshStart' => [ 'base' => '<p>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.</p>', 'refs' => [ 'ReputationOptions$LastFreshStart' => '<p>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.</p>', ], ], 'LimitExceededException' => [ 'base' => '<p>There are too many instances of the specified resource type.</p>', 'refs' => [], ], 'ListConfigurationSetsRequest' => [ 'base' => '<p>A request to obtain a list of configuration sets for your Amazon SES account in the current Amazon Web Services Region.</p>', 'refs' => [], ], 'ListConfigurationSetsResponse' => [ 'base' => '<p>A list of configuration sets in your Amazon SES account in the current Amazon Web Services Region.</p>', 'refs' => [], ], 'ListContactListsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListContactListsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListContactsFilter' => [ 'base' => '<p>A filter that can be applied to a list of contacts.</p>', 'refs' => [ 'ListContactsRequest$Filter' => '<p>A filter that can be applied to a list of contacts.</p>', ], ], 'ListContactsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListContactsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCustomVerificationEmailTemplatesRequest' => [ 'base' => '<p>Represents a request to list the existing custom verification email templates for your account.</p>', 'refs' => [], ], 'ListCustomVerificationEmailTemplatesResponse' => [ 'base' => '<p>The following elements are returned by the service.</p>', 'refs' => [], ], 'ListDedicatedIpPoolsRequest' => [ 'base' => '<p>A request to obtain a list of dedicated IP pools.</p>', 'refs' => [], ], 'ListDedicatedIpPoolsResponse' => [ 'base' => '<p>A list of dedicated IP pools.</p>', 'refs' => [], ], 'ListDeliverabilityTestReportsRequest' => [ 'base' => '<p>A request to list all of the predictive inbox placement tests that you\'ve performed.</p>', 'refs' => [], ], 'ListDeliverabilityTestReportsResponse' => [ 'base' => '<p>A list of the predictive inbox placement test reports that are available for your account, regardless of whether or not those tests are complete.</p>', 'refs' => [], ], 'ListDomainDeliverabilityCampaignsRequest' => [ 'base' => '<p>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.</p>', 'refs' => [], ], 'ListDomainDeliverabilityCampaignsResponse' => [ 'base' => '<p>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.</p>', 'refs' => [], ], 'ListEmailIdentitiesRequest' => [ 'base' => '<p>A request to list all of the email identities associated with your Amazon Web Services account. This list includes identities that you\'ve already verified, identities that are unverified, and identities that were verified in the past, but are no longer verified.</p>', 'refs' => [], ], 'ListEmailIdentitiesResponse' => [ 'base' => '<p>A list of all of the identities that you\'ve attempted to verify, regardless of whether or not those identities were successfully verified.</p>', 'refs' => [], ], 'ListEmailTemplatesRequest' => [ 'base' => '<p>Represents a request to list the email templates present in your Amazon SES account in the current Amazon Web Services Region. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html">Amazon SES Developer Guide</a>.</p>', 'refs' => [], ], 'ListEmailTemplatesResponse' => [ 'base' => '<p>The following elements are returned by the service.</p>', 'refs' => [], ], 'ListExportJobsRequest' => [ 'base' => '<p>Represents a request to list all export jobs with filters.</p>', 'refs' => [], ], 'ListExportJobsResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'ListImportJobsRequest' => [ 'base' => '<p>Represents a request to list all of the import jobs for a data destination within the specified maximum number of import jobs.</p>', 'refs' => [], ], 'ListImportJobsResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'ListManagementOptions' => [ 'base' => '<p>An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.</p>', 'refs' => [ 'SendEmailRequest$ListManagementOptions' => '<p>An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.</p>', ], ], 'ListMultiRegionEndpointsRequest' => [ 'base' => '<p>Represents a request to list all the multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is executed. </p>', 'refs' => [], ], 'ListMultiRegionEndpointsResponse' => [ 'base' => '<p>The following elements are returned by the service.</p>', 'refs' => [], ], 'ListOfContactLists' => [ 'base' => NULL, 'refs' => [ 'ListContactListsResponse$ContactLists' => '<p>The available contact lists.</p>', ], ], 'ListOfContacts' => [ 'base' => NULL, 'refs' => [ 'ListContactsResponse$Contacts' => '<p>The contacts present in a specific contact list.</p>', ], ], 'ListOfDedicatedIpPools' => [ 'base' => '<p>A list of dedicated IP pools that are associated with your Amazon Web Services account.</p>', 'refs' => [ 'ListDedicatedIpPoolsResponse$DedicatedIpPools' => '<p>A list of all of the dedicated IP pools that are associated with your Amazon Web Services account in the current Region.</p>', ], ], 'ListRecommendationFilterValue' => [ 'base' => NULL, 'refs' => [ 'ListRecommendationsFilter$value' => NULL, ], ], 'ListRecommendationsFilter' => [ 'base' => '<p>An object that contains mapping between <code>ListRecommendationsFilterKey</code> and <code>ListRecommendationFilterValue</code> to filter by.</p>', 'refs' => [ 'ListRecommendationsRequest$Filter' => '<p>Filters applied when retrieving recommendations. Can eiter be an individual filter, or combinations of <code>STATUS</code> and <code>IMPACT</code> or <code>STATUS</code> and <code>TYPE</code> </p>', ], ], 'ListRecommendationsFilterKey' => [ 'base' => '<p>The <code>ListRecommendations</code> filter type. This can be one of the following:</p> <ul> <li> <p> <code>TYPE</code> – The recommendation type, with values like <code>DKIM</code>, <code>SPF</code>, <code>DMARC</code>, <code>BIMI</code>, or <code>COMPLAINT</code>.</p> </li> <li> <p> <code>IMPACT</code> – The recommendation impact, with values like <code>HIGH</code> or <code>LOW</code>.</p> </li> <li> <p> <code>STATUS</code> – The recommendation status, with values like <code>OPEN</code> or <code>FIXED</code>.</p> </li> <li> <p> <code>RESOURCE_ARN</code> – The resource affected by the recommendation, with values like <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</p> </li> </ul>', 'refs' => [ 'ListRecommendationsFilter$key' => NULL, ], ], 'ListRecommendationsRequest' => [ 'base' => '<p>Represents a request to list the existing recommendations for your account.</p>', 'refs' => [], ], 'ListRecommendationsResponse' => [ 'base' => '<p>Contains the response to your request to retrieve the list of recommendations for your account.</p>', 'refs' => [], ], 'ListReputationEntitiesRequest' => [ 'base' => '<p>Represents a request to list reputation entities with optional filtering.</p>', 'refs' => [], ], 'ListReputationEntitiesResponse' => [ 'base' => '<p>A list of reputation entities in your account.</p>', 'refs' => [], ], 'ListResourceTenantsRequest' => [ 'base' => '<p>Represents a request to list tenants associated with a specific resource.</p>', 'refs' => [], ], 'ListResourceTenantsResponse' => [ 'base' => '<p>Information about tenants associated with a specific resource.</p>', 'refs' => [], ], 'ListSuppressedDestinationsRequest' => [ 'base' => '<p>A request to obtain a list of email destinations that are on the suppression list for your account.</p>', 'refs' => [], ], 'ListSuppressedDestinationsResponse' => [ 'base' => '<p>A list of suppressed email addresses.</p>', 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTenantResourcesFilter' => [ 'base' => '<p>An object that contains mapping between <code>ListTenantResourcesFilterKey</code> and <code>ListTenantResourcesFilterValue</code> to filter by.</p>', 'refs' => [ 'ListTenantResourcesRequest$Filter' => '<p>A map of filter keys and values for filtering the list of tenant resources. Currently, the only supported filter key is <code>RESOURCE_TYPE</code>.</p>', ], ], 'ListTenantResourcesFilterKey' => [ 'base' => '<p>The key used to filter tenant resources. Currently, the only supported filter key is <code>RESOURCE_TYPE</code>.</p>', 'refs' => [ 'ListTenantResourcesFilter$key' => NULL, ], ], 'ListTenantResourcesFilterValue' => [ 'base' => '<p>The value used to filter tenant resources. When filtering by <code>RESOURCE_TYPE</code>, valid values are <code>EMAIL_IDENTITY</code>, <code>CONFIGURATION_SET</code>, or <code>EMAIL_TEMPLATE</code>.</p>', 'refs' => [ 'ListTenantResourcesFilter$value' => NULL, ], ], 'ListTenantResourcesRequest' => [ 'base' => '<p>Represents a request to list resources associated with a specific tenant.</p>', 'refs' => [], ], 'ListTenantResourcesResponse' => [ 'base' => '<p>Information about resources associated with a specific tenant.</p>', 'refs' => [], ], 'ListTenantsRequest' => [ 'base' => '<p>Represents a request to list all tenants associated with your account in the current Amazon Web Services Region.</p>', 'refs' => [], ], 'ListTenantsResponse' => [ 'base' => '<p>Information about tenants associated with your account.</p>', 'refs' => [], ], 'MailFromAttributes' => [ 'base' => '<p>A list of attributes that are associated with a MAIL FROM domain.</p>', 'refs' => [ 'GetEmailIdentityResponse$MailFromAttributes' => '<p>An object that contains information about the Mail-From attributes for the email identity.</p>', ], ], 'MailFromDomainName' => [ 'base' => '<p>The domain to use as a MAIL FROM domain.</p>', 'refs' => [ 'MailFromAttributes$MailFromDomain' => '<p>The name of a domain that an email identity uses as a custom MAIL FROM domain.</p>', 'PutEmailIdentityMailFromAttributesRequest$MailFromDomain' => '<p> The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria:</p> <ul> <li> <p>It has to be a subdomain of the verified identity.</p> </li> <li> <p>It can\'t be used to receive email.</p> </li> <li> <p>It can\'t be used in a "From" address if the MAIL FROM domain is a destination for feedback forwarding emails.</p> </li> </ul>', ], ], 'MailFromDomainNotVerifiedException' => [ 'base' => '<p>The message can\'t be sent because the sending domain isn\'t verified.</p>', 'refs' => [], ], 'MailFromDomainStatus' => [ 'base' => '<p>The status of the MAIL FROM domain. This status can have the following values:</p> <ul> <li> <p> <code>PENDING</code> – Amazon SES hasn\'t started searching for the MX record yet.</p> </li> <li> <p> <code>SUCCESS</code> – Amazon SES detected the required MX record for the MAIL FROM domain.</p> </li> <li> <p> <code>FAILED</code> – Amazon SES can\'t find the required MX record, or the record no longer exists.</p> </li> <li> <p> <code>TEMPORARY_FAILURE</code> – A temporary issue occurred, which prevented Amazon SES from determining the status of the MAIL FROM domain.</p> </li> </ul>', 'refs' => [ 'MailFromAttributes$MailFromDomainStatus' => '<p>The status of the MAIL FROM domain. This status can have the following values:</p> <ul> <li> <p> <code>PENDING</code> – Amazon SES hasn\'t started searching for the MX record yet.</p> </li> <li> <p> <code>SUCCESS</code> – Amazon SES detected the required MX record for the MAIL FROM domain.</p> </li> <li> <p> <code>FAILED</code> – Amazon SES can\'t find the required MX record, or the record no longer exists.</p> </li> <li> <p> <code>TEMPORARY_FAILURE</code> – A temporary issue occurred, which prevented Amazon SES from determining the status of the MAIL FROM domain.</p> </li> </ul>', ], ], 'MailType' => [ 'base' => NULL, 'refs' => [ 'AccountDetails$MailType' => '<p>The type of email your account is sending. The mail type can be one of the following:</p> <ul> <li> <p> <code>MARKETING</code> – Most of your sending traffic is to keep your customers informed of your latest offering.</p> </li> <li> <p> <code>TRANSACTIONAL</code> – Most of your sending traffic is to communicate during a transaction with a customer.</p> </li> </ul>', 'PutAccountDetailsRequest$MailType' => '<p>The type of email your account will send.</p>', ], ], 'Max24HourSend' => [ 'base' => NULL, 'refs' => [ 'SendQuota$Max24HourSend' => '<p>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 <i>sending quota</i>.)</p>', ], ], 'MaxDeliverySeconds' => [ 'base' => NULL, 'refs' => [ 'DeliveryOptions$MaxDeliverySeconds' => '<p>The maximum amount of time, in seconds, that Amazon SES API v2 will attempt delivery of email. If specified, the value must greater than or equal to 300 seconds (5 minutes) and less than or equal to 50400 seconds (840 minutes). </p>', 'PutConfigurationSetDeliveryOptionsRequest$MaxDeliverySeconds' => '<p>The maximum amount of time, in seconds, that Amazon SES API v2 will attempt delivery of email. If specified, the value must greater than or equal to 300 seconds (5 minutes) and less than or equal to 50400 seconds (840 minutes). </p>', ], ], 'MaxItems' => [ 'base' => NULL, 'refs' => [ 'GetDedicatedIpsRequest$PageSize' => '<p>The number of results to show in a single call to <code>GetDedicatedIpsRequest</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.</p>', 'ListConfigurationSetsRequest$PageSize' => '<p>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.</p>', 'ListContactListsRequest$PageSize' => '<p>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.</p>', 'ListContactsRequest$PageSize' => '<p>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.</p>', 'ListCustomVerificationEmailTemplatesRequest$PageSize' => '<p>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.</p> <p>The value you specify has to be at least 1, and can be no more than 50.</p>', 'ListDedicatedIpPoolsRequest$PageSize' => '<p>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.</p>', 'ListDeliverabilityTestReportsRequest$PageSize' => '<p>The number of results to show in a single call to <code>ListDeliverabilityTestReports</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.</p> <p>The value you specify has to be at least 0, and can be no more than 1000.</p>', 'ListDomainDeliverabilityCampaignsRequest$PageSize' => '<p>The maximum number of results to include in response to a single call to the <code>ListDomainDeliverabilityCampaigns</code> operation. If the number of results is larger than the number that you specify in this parameter, the response includes a <code>NextToken</code> element, which you can use to obtain additional results.</p>', 'ListEmailIdentitiesRequest$PageSize' => '<p>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.</p> <p>The value you specify has to be at least 0, and can be no more than 1000.</p>', 'ListEmailTemplatesRequest$PageSize' => '<p>The number of results to show in a single call to <code>ListEmailTemplates</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.</p> <p>The value you specify has to be at least 1, and can be no more than 100.</p>', 'ListExportJobsRequest$PageSize' => '<p>Maximum number of export jobs to return at once. Use this parameter to paginate results. If additional export jobs exist beyond the specified limit, the <code>NextToken</code> element is sent in the response. Use the <code>NextToken</code> value in subsequent calls to <code>ListExportJobs</code> to retrieve additional export jobs.</p>', 'ListImportJobsRequest$PageSize' => '<p>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 <code>NextToken</code> element is sent in the response. Use the <code>NextToken</code> value in subsequent requests to retrieve additional addresses.</p>', 'ListRecommendationsRequest$PageSize' => '<p>The number of results to show in a single call to <code>ListRecommendations</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.</p> <p>The value you specify has to be at least 1, and can be no more than 100.</p>', 'ListReputationEntitiesRequest$PageSize' => '<p>The number of results to show in a single call to <code>ListReputationEntities</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.</p>', 'ListResourceTenantsRequest$PageSize' => '<p>The number of results to show in a single call to <code>ListResourceTenants</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.</p>', 'ListSuppressedDestinationsRequest$PageSize' => '<p>The number of results to show in a single call to <code>ListSuppressedDestinations</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.</p>', 'ListTenantResourcesRequest$PageSize' => '<p>The number of results to show in a single call to <code>ListTenantResources</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.</p>', 'ListTenantsRequest$PageSize' => '<p>The number of results to show in a single call to <code>ListTenants</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.</p>', ], ], 'MaxSendRate' => [ 'base' => NULL, 'refs' => [ 'SendQuota$MaxSendRate' => '<p>The maximum number of emails that you can send per second in the current Amazon Web Services Region. This value is also called your <i>maximum sending rate</i> or your <i>maximum TPS (transactions per second) rate</i>.</p>', ], ], 'Message' => [ 'base' => '<p>Represents the email message that you\'re sending. The <code>Message</code> object consists of a subject line and a message body.</p>', 'refs' => [ 'EmailContent$Simple' => '<p>The simple email message. The message consists of a subject, message body and attachments list.</p>', ], ], 'MessageContent' => [ 'base' => '<p>The body of an email message.</p>', 'refs' => [ 'GetDeliverabilityTestReportResponse$Message' => '<p>An object that contains the message that you sent when you performed this predictive inbox placement test.</p>', ], ], 'MessageData' => [ 'base' => NULL, 'refs' => [ 'Content$Data' => '<p>The content of the message itself.</p>', ], ], 'MessageHeader' => [ 'base' => '<p>Contains the name and value of a message header that you add to an email.</p>', 'refs' => [ 'MessageHeaderList$member' => NULL, ], ], 'MessageHeaderList' => [ 'base' => '<p>A list of message headers. The list of message headers has to meet the following criteria:</p> <ul> <li> <p>Can contain no more than 15 headers in one message.</p> </li> </ul>', 'refs' => [ 'BulkEmailEntry$ReplacementHeaders' => '<p>The list of message headers associated with the <code>BulkEmailEntry</code> data type.</p> <ul> <li> <p>Headers Not Present in <code>BulkEmailEntry</code>: If a header is specified in <a href="https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_Template.html"> <code>Template</code> </a> but not in <code>BulkEmailEntry</code>, the header from <code>Template</code> will be added to the outgoing email.</p> </li> <li> <p>Headers Present in <code>BulkEmailEntry</code>: If a header is specified in <code>BulkEmailEntry</code>, it takes precedence over any header of the same name specified in <a href="https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_Template.html"> <code>Template</code> </a>:</p> <ul> <li> <p>If the header is also defined within <code>Template</code>, the value from <code>BulkEmailEntry</code> will replace the header\'s value in the email.</p> </li> <li> <p>If the header is not defined within <code>Template</code>, it will simply be added to the email as specified in <code>BulkEmailEntry</code>.</p> </li> </ul> </li> </ul>', 'Message$Headers' => '<p>The list of message headers that will be added to the email message.</p>', 'Template$Headers' => '<p>The list of message headers that will be added to the email message.</p>', ], ], 'MessageHeaderName' => [ 'base' => '<p>The name of the message header. The message header name has to meet the following criteria:</p> <ul> <li> <p>Can contain any printable ASCII character (33 - 126) except for colon (:).</p> </li> <li> <p>Can contain no more than 126 characters.</p> </li> </ul>', 'refs' => [ 'MessageHeader$Name' => '<p>The name of the message header. The message header name has to meet the following criteria:</p> <ul> <li> <p>Can contain any printable ASCII character (33 - 126) except for colon (:).</p> </li> <li> <p>Can contain no more than 126 characters.</p> </li> </ul>', ], ], 'MessageHeaderValue' => [ 'base' => '<p>The value of the message header. The message header value has to meet the following criteria:</p> <ul> <li> <p>Can contain any printable ASCII character.</p> </li> </ul>', 'refs' => [ 'MessageHeader$Value' => '<p>The value of the message header. The message header value has to meet the following criteria:</p> <ul> <li> <p>Can contain any printable ASCII character.</p> </li> <li> <p>Can contain no more than 870 characters.</p> </li> </ul>', ], ], 'MessageInsightsDataSource' => [ 'base' => '<p>An object that contains filters applied when performing the Message Insights export.</p>', 'refs' => [ 'ExportDataSource$MessageInsightsDataSource' => NULL, ], ], 'MessageInsightsExportMaxResults' => [ 'base' => NULL, 'refs' => [ 'MessageInsightsDataSource$MaxResults' => '<p>The maximum number of results.</p>', ], ], 'MessageInsightsFilters' => [ 'base' => '<p>An object containing Message Insights filters.</p> <p>If you specify multiple filters, the filters are joined by AND.</p> <p>If you specify multiple values for a filter, the values are joined by OR. Filter values are case-sensitive.</p> <p> <code>FromEmailAddress</code>, <code>Destination</code>, and <code>Subject</code> filters support partial match. A partial match is performed by using the <code>*</code> wildcard character placed at the beginning (suffix match), the end (prefix match) or both ends of the string (contains match). In order to match the literal characters <code>*</code> or <code>\\</code>, they must be escaped using the <code>\\</code> character. If no wildcard character is present, an exact match is performed. </p>', 'refs' => [ 'MessageInsightsDataSource$Include' => '<p>Filters for results to be included in the export file.</p>', 'MessageInsightsDataSource$Exclude' => '<p>Filters for results to be excluded from the export file.</p>', ], ], 'MessageRejected' => [ 'base' => '<p>The message can\'t be sent because it contains invalid content.</p>', 'refs' => [], ], 'MessageTag' => [ 'base' => '<p>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. </p>', 'refs' => [ 'MessageTagList$member' => NULL, ], ], 'MessageTagList' => [ 'base' => '<p>A list of message tags.</p>', 'refs' => [ 'BulkEmailEntry$ReplacementTags' => '<p>A list of tags, in the form of name/value pairs, to apply to an email that you send using the <code>SendBulkTemplatedEmail</code> operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.</p>', 'GetMessageInsightsResponse$EmailTags' => '<p> A list of tags, in the form of name/value pairs, that were applied to the email you sent, along with Amazon SES <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-using-event-publishing.html">Auto-Tags</a>. </p>', 'SendBulkEmailRequest$DefaultEmailTags' => '<p>A list of tags, in the form of name/value pairs, to apply to an email that you send using the <code>SendEmail</code> operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.</p>', 'SendEmailRequest$EmailTags' => '<p>A list of tags, in the form of name/value pairs, to apply to an email that you send using the <code>SendEmail</code> operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events. </p>', ], ], 'MessageTagName' => [ 'base' => '<p>The name of the message tag. The message tag name has to meet the following criteria:</p> <ul> <li> <p>It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).</p> </li> <li> <p>It can contain no more than 256 characters.</p> </li> </ul>', 'refs' => [ 'MessageTag$Name' => '<p>The name of the message tag. The message tag name has to meet the following criteria:</p> <ul> <li> <p>It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).</p> </li> <li> <p>It can contain no more than 256 characters.</p> </li> </ul>', ], ], 'MessageTagValue' => [ 'base' => '<p>The value of the message tag. The message tag value has to meet the following criteria:</p> <ul> <li> <p>It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).</p> </li> <li> <p>It can contain no more than 256 characters.</p> </li> </ul>', 'refs' => [ 'MessageTag$Value' => '<p>The value of the message tag. The message tag value has to meet the following criteria:</p> <ul> <li> <p>It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).</p> </li> <li> <p>It can contain no more than 256 characters.</p> </li> </ul>', ], ], 'Metric' => [ 'base' => '<p>The metric to export, can be one of the following:</p> <ul> <li> <p> <code>SEND</code> - Emails sent eligible for tracking in the VDM dashboard. This excludes emails sent to the mailbox simulator and emails addressed to more than one recipient.</p> </li> <li> <p> <code>COMPLAINT</code> - Complaints received for your account. This excludes complaints from the mailbox simulator, those originating from your account-level suppression list (if enabled), and those for emails addressed to more than one recipient</p> </li> <li> <p> <code>PERMANENT_BOUNCE</code> - Permanent bounces - i.e., feedback received for emails sent to non-existent mailboxes. Excludes bounces from the mailbox simulator, those originating from your account-level suppression list (if enabled), and those for emails addressed to more than one recipient.</p> </li> <li> <p> <code>TRANSIENT_BOUNCE</code> - Transient bounces - i.e., feedback received for delivery failures excluding issues with non-existent mailboxes. Excludes bounces from the mailbox simulator, and those for emails addressed to more than one recipient.</p> </li> <li> <p> <code>OPEN</code> - Unique open events for emails including open trackers. Excludes opens for emails addressed to more than one recipient.</p> </li> <li> <p> <code>CLICK</code> - Unique click events for emails including wrapped links. Excludes clicks for emails addressed to more than one recipient.</p> </li> <li> <p> <code>DELIVERY</code> - Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator and for emails addressed to more than one recipient.</p> </li> <li> <p> <code>DELIVERY_OPEN</code> - Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails without open trackers.</p> </li> <li> <p> <code>DELIVERY_CLICK</code> - Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails without click trackers.</p> </li> <li> <p> <code>DELIVERY_COMPLAINT</code> - Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails addressed to recipients hosted by ISPs with which Amazon SES does not have a feedback loop agreement.</p> </li> </ul>', 'refs' => [ 'BatchGetMetricDataQuery$Metric' => '<p>The queried metric. This can be one of the following:</p> <ul> <li> <p> <code>SEND</code> – Emails sent eligible for tracking in the VDM dashboard. This excludes emails sent to the mailbox simulator and emails addressed to more than one recipient.</p> </li> <li> <p> <code>COMPLAINT</code> – Complaints received for your account. This excludes complaints from the mailbox simulator, those originating from your account-level suppression list (if enabled), and those for emails addressed to more than one recipient</p> </li> <li> <p> <code>PERMANENT_BOUNCE</code> – Permanent bounces - i.e. feedback received for emails sent to non-existent mailboxes. Excludes bounces from the mailbox simulator, those originating from your account-level suppression list (if enabled), and those for emails addressed to more than one recipient.</p> </li> <li> <p> <code>TRANSIENT_BOUNCE</code> – Transient bounces - i.e. feedback received for delivery failures excluding issues with non-existent mailboxes. Excludes bounces from the mailbox simulator, and those for emails addressed to more than one recipient.</p> </li> <li> <p> <code>OPEN</code> – Unique open events for emails including open trackers. Excludes opens for emails addressed to more than one recipient.</p> </li> <li> <p> <code>CLICK</code> – Unique click events for emails including wrapped links. Excludes clicks for emails addressed to more than one recipient.</p> </li> <li> <p> <code>DELIVERY</code> – Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator and for emails addressed to more than one recipient.</p> </li> <li> <p> <code>DELIVERY_OPEN</code> – Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails without open trackers.</p> </li> <li> <p> <code>DELIVERY_CLICK</code> – Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails without click trackers.</p> </li> <li> <p> <code>DELIVERY_COMPLAINT</code> – Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails addressed to recipients hosted by ISPs with which Amazon SES does not have a feedback loop agreement.</p> </li> </ul>', 'ExportMetric$Name' => NULL, ], ], 'MetricAggregation' => [ 'base' => '<p>The aggregation to apply to a metric, can be one of the following:</p> <ul> <li> <p> <code>VOLUME</code> - The volume of events for this metric.</p> </li> <li> <p> <code>RATE</code> - The rate for this metric relative to the <code>SEND</code> metric volume.</p> </li> </ul>', 'refs' => [ 'ExportMetric$Aggregation' => NULL, ], ], 'MetricDataError' => [ 'base' => '<p>An error corresponding to the unsuccessful processing of a single metric data query.</p>', 'refs' => [ 'MetricDataErrorList$member' => NULL, ], ], 'MetricDataErrorList' => [ 'base' => NULL, 'refs' => [ 'BatchGetMetricDataResponse$Errors' => '<p>A list of <code>MetricDataError</code> encountered while processing your metric data batch request.</p>', ], ], 'MetricDataResult' => [ 'base' => '<p>The result of a single metric data query.</p>', 'refs' => [ 'MetricDataResultList$member' => NULL, ], ], 'MetricDataResultList' => [ 'base' => NULL, 'refs' => [ 'BatchGetMetricDataResponse$Results' => '<p>A list of successfully retrieved <code>MetricDataResult</code>.</p>', ], ], 'MetricDimensionName' => [ 'base' => '<p>The <code>BatchGetMetricDataQuery</code> dimension name. This can be one of the following:</p> <ul> <li> <p> <code>EMAIL_IDENTITY</code> – The email identity used when sending messages.</p> </li> <li> <p> <code>CONFIGURATION_SET</code> – The configuration set used when sending messages (if one was used).</p> </li> <li> <p> <code>ISP</code> – The recipient ISP (e.g. <code>Gmail</code>, <code>Yahoo</code>, etc.).</p> </li> </ul>', 'refs' => [ 'Dimensions$key' => NULL, 'ExportDimensions$key' => NULL, ], ], 'MetricDimensionValue' => [ 'base' => '<p>A list of values associated with the <code>MetricDimensionName</code> to filter metrics by. Can either be <code>*</code> as a wildcard for all values or a list of up to 10 specific values. If one <code>Dimension</code> has the <code>*</code> value, other dimensions can only contain one value. </p>', 'refs' => [ 'Dimensions$value' => NULL, 'ExportDimensionValue$member' => NULL, ], ], 'MetricNamespace' => [ 'base' => NULL, 'refs' => [ 'BatchGetMetricDataQuery$Namespace' => '<p>The query namespace - e.g. <code>VDM</code> </p>', 'MetricsDataSource$Namespace' => '<p>The metrics namespace - e.g., <code>VDM</code>.</p>', ], ], 'MetricValueList' => [ 'base' => NULL, 'refs' => [ 'MetricDataResult$Values' => '<p>A list of values (cumulative / sum) for the metric data results.</p>', ], ], 'MetricsDataSource' => [ 'base' => '<p>An object that contains details about the data source for the metrics export.</p>', 'refs' => [ 'ExportDataSource$MetricsDataSource' => NULL, ], ], 'MultiRegionEndpoint' => [ 'base' => '<p>An object that contains multi-region endpoint (global-endpoint) properties.</p>', 'refs' => [ 'MultiRegionEndpoints$member' => NULL, ], ], 'MultiRegionEndpoints' => [ 'base' => NULL, 'refs' => [ 'ListMultiRegionEndpointsResponse$MultiRegionEndpoints' => '<p>An array that contains key multi-region endpoint (global-endpoint) properties.</p>', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'GetDedicatedIpsRequest$NextToken' => '<p>A token returned from a previous call to <code>GetDedicatedIps</code> to indicate the position of the dedicated IP pool in the list of IP pools.</p>', 'GetDedicatedIpsResponse$NextToken' => '<p>A token that indicates that there are additional dedicated IP addresses to list. To view additional addresses, issue another request to <code>GetDedicatedIps</code>, passing this token in the <code>NextToken</code> parameter.</p>', 'ListConfigurationSetsRequest$NextToken' => '<p>A token returned from a previous call to <code>ListConfigurationSets</code> to indicate the position in the list of configuration sets.</p>', 'ListConfigurationSetsResponse$NextToken' => '<p>A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to <code>ListConfigurationSets</code>, and pass this token in the <code>NextToken</code> parameter.</p>', 'ListContactListsRequest$NextToken' => '<p>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.</p>', 'ListContactListsResponse$NextToken' => '<p>A string token indicating that there might be additional contact lists available to be listed. Copy this token to a subsequent call to <code>ListContactLists</code> with the same parameters to retrieve the next page of contact lists.</p>', 'ListContactsRequest$NextToken' => '<p>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.</p>', 'ListContactsResponse$NextToken' => '<p>A string token indicating that there might be additional contacts available to be listed. Copy this token to a subsequent call to <code>ListContacts</code> with the same parameters to retrieve the next page of contacts.</p>', 'ListCustomVerificationEmailTemplatesRequest$NextToken' => '<p>A token returned from a previous call to <code>ListCustomVerificationEmailTemplates</code> to indicate the position in the list of custom verification email templates.</p>', 'ListCustomVerificationEmailTemplatesResponse$NextToken' => '<p>A token indicating that there are additional custom verification email templates available to be listed. Pass this token to a subsequent call to <code>ListCustomVerificationEmailTemplates</code> to retrieve the next 50 custom verification email templates.</p>', 'ListDedicatedIpPoolsRequest$NextToken' => '<p>A token returned from a previous call to <code>ListDedicatedIpPools</code> to indicate the position in the list of dedicated IP pools.</p>', 'ListDedicatedIpPoolsResponse$NextToken' => '<p>A token that indicates that there are additional IP pools to list. To view additional IP pools, issue another request to <code>ListDedicatedIpPools</code>, passing this token in the <code>NextToken</code> parameter.</p>', 'ListDeliverabilityTestReportsRequest$NextToken' => '<p>A token returned from a previous call to <code>ListDeliverabilityTestReports</code> to indicate the position in the list of predictive inbox placement tests.</p>', 'ListDeliverabilityTestReportsResponse$NextToken' => '<p>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 <code>ListDeliverabilityTestReports</code>, and pass this token in the <code>NextToken</code> parameter.</p>', 'ListDomainDeliverabilityCampaignsRequest$NextToken' => '<p>A token that’s returned from a previous call to the <code>ListDomainDeliverabilityCampaigns</code> operation. This token indicates the position of a campaign in the list of campaigns.</p>', 'ListDomainDeliverabilityCampaignsResponse$NextToken' => '<p>A token that’s returned from a previous call to the <code>ListDomainDeliverabilityCampaigns</code> operation. This token indicates the position of the campaign in the list of campaigns.</p>', 'ListEmailIdentitiesRequest$NextToken' => '<p>A token returned from a previous call to <code>ListEmailIdentities</code> to indicate the position in the list of identities.</p>', 'ListEmailIdentitiesResponse$NextToken' => '<p>A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to <code>ListEmailIdentities</code>, and pass this token in the <code>NextToken</code> parameter.</p>', 'ListEmailTemplatesRequest$NextToken' => '<p>A token returned from a previous call to <code>ListEmailTemplates</code> to indicate the position in the list of email templates.</p>', 'ListEmailTemplatesResponse$NextToken' => '<p>A token indicating that there are additional email templates available to be listed. Pass this token to a subsequent <code>ListEmailTemplates</code> call to retrieve the next 10 email templates.</p>', 'ListExportJobsRequest$NextToken' => '<p>The pagination token returned from a previous call to <code>ListExportJobs</code> to indicate the position in the list of export jobs.</p>', 'ListExportJobsResponse$NextToken' => '<p>A string token indicating that there might be additional export jobs available to be listed. Use this token to a subsequent call to <code>ListExportJobs</code> with the same parameters to retrieve the next page of export jobs.</p>', 'ListImportJobsRequest$NextToken' => '<p>A string token indicating that there might be additional import jobs available to be listed. Copy this token to a subsequent call to <code>ListImportJobs</code> with the same parameters to retrieve the next page of import jobs.</p>', 'ListImportJobsResponse$NextToken' => '<p>A string token indicating that there might be additional import jobs available to be listed. Copy this token to a subsequent call to <code>ListImportJobs</code> with the same parameters to retrieve the next page of import jobs.</p>', 'ListRecommendationsRequest$NextToken' => '<p>A token returned from a previous call to <code>ListRecommendations</code> to indicate the position in the list of recommendations.</p>', 'ListRecommendationsResponse$NextToken' => '<p>A string token indicating that there might be additional recommendations available to be listed. Use the token provided in the <code>ListRecommendationsResponse</code> to use in the subsequent call to <code>ListRecommendations</code> with the same parameters to retrieve the next page of recommendations.</p>', 'ListReputationEntitiesRequest$NextToken' => '<p>A token returned from a previous call to <code>ListReputationEntities</code> to indicate the position in the list of reputation entities.</p>', 'ListReputationEntitiesResponse$NextToken' => '<p>A token that indicates that there are additional reputation entities to list. To view additional reputation entities, issue another request to <code>ListReputationEntities</code>, and pass this token in the <code>NextToken</code> parameter.</p>', 'ListResourceTenantsRequest$NextToken' => '<p>A token returned from a previous call to <code>ListResourceTenants</code> to indicate the position in the list of resource tenants.</p>', 'ListResourceTenantsResponse$NextToken' => '<p>A token that indicates that there are additional tenants to list. To view additional tenants, issue another request to <code>ListResourceTenants</code>, and pass this token in the <code>NextToken</code> parameter.</p>', 'ListSuppressedDestinationsRequest$NextToken' => '<p>A token returned from a previous call to <code>ListSuppressedDestinations</code> to indicate the position in the list of suppressed email addresses.</p>', 'ListSuppressedDestinationsResponse$NextToken' => '<p>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 <code>ListSuppressedDestinations</code>, and pass this token in the <code>NextToken</code> parameter.</p>', 'ListTenantResourcesRequest$NextToken' => '<p>A token returned from a previous call to <code>ListTenantResources</code> to indicate the position in the list of tenant resources.</p>', 'ListTenantResourcesResponse$NextToken' => '<p>A token that indicates that there are additional resources to list. To view additional resources, issue another request to <code>ListTenantResources</code>, and pass this token in the <code>NextToken</code> parameter.</p>', 'ListTenantsRequest$NextToken' => '<p>A token returned from a previous call to <code>ListTenants</code> to indicate the position in the list of tenants.</p>', 'ListTenantsResponse$NextToken' => '<p>A token that indicates that there are additional tenants to list. To view additional tenants, issue another request to <code>ListTenants</code>, and pass this token in the <code>NextToken</code> parameter.</p>', ], ], 'NextTokenV2' => [ 'base' => NULL, 'refs' => [ 'ListMultiRegionEndpointsRequest$NextToken' => '<p>A token returned from a previous call to <code>ListMultiRegionEndpoints</code> to indicate the position in the list of multi-region endpoints (global-endpoints).</p>', 'ListMultiRegionEndpointsResponse$NextToken' => '<p>A token indicating that there are additional multi-region endpoints (global-endpoints) available to be listed. Pass this token to a subsequent <code>ListMultiRegionEndpoints</code> call to retrieve the next page.</p>', ], ], 'NotFoundException' => [ 'base' => '<p>The resource you attempted to access doesn\'t exist.</p>', 'refs' => [], ], 'OutboundMessageId' => [ 'base' => NULL, 'refs' => [ 'BulkEmailEntryResult$MessageId' => '<p>The unique message identifier returned from the <code>SendBulkTemplatedEmail</code> operation.</p>', 'GetMessageInsightsRequest$MessageId' => '<p> A <code>MessageId</code> is a unique identifier for a message, and is returned when sending emails through Amazon SES. </p>', 'GetMessageInsightsResponse$MessageId' => '<p>A unique identifier for the message.</p>', 'SendCustomVerificationEmailResponse$MessageId' => '<p>The unique message identifier returned from the <code>SendCustomVerificationEmail</code> operation.</p>', 'SendEmailResponse$MessageId' => '<p>A unique identifier for the message that is generated when the message is accepted.</p> <note> <p>It\'s possible for Amazon SES to accept a message without sending it. For example, this can happen when the message that you\'re trying to send has an attachment that contains a virus, or when you send a templated email that contains invalid personalization content.</p> </note>', 'SuppressedDestinationAttributes$MessageId' => '<p>The unique identifier of the email message that caused the email address to be added to the suppression list for your account.</p>', ], ], 'OverallVolume' => [ 'base' => '<p>An object that contains information about email that was sent from the selected domain.</p>', 'refs' => [ 'GetDomainStatisticsReportResponse$OverallVolume' => '<p>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 <code>StartDate</code> to the <code>EndDate</code>.</p>', ], ], 'PageSizeV2' => [ 'base' => NULL, 'refs' => [ 'ListMultiRegionEndpointsRequest$PageSize' => '<p>The number of results to show in a single call to <code>ListMultiRegionEndpoints</code>. If the number of results is larger than the number you specified in this parameter, the response includes a <code>NextToken</code> element that you can use to retrieve the next page of results. </p>', ], ], 'Percentage' => [ 'base' => '<p>An object that contains information about inbox placement percentages.</p>', 'refs' => [ 'DomainDeliverabilityCampaign$ReadRate' => '<p>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.</p>', 'DomainDeliverabilityCampaign$DeleteRate' => '<p>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.</p>', 'DomainDeliverabilityCampaign$ReadDeleteRate' => '<p>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.</p>', 'DomainIspPlacement$InboxPercentage' => '<p>The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients\' inboxes.</p>', 'DomainIspPlacement$SpamPercentage' => '<p>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.</p>', 'OverallVolume$ReadRatePercent' => '<p>The percentage of emails that were sent from the domain that were read by their recipients.</p>', 'PlacementStatistics$InboxPercentage' => '<p>The percentage of emails that arrived in recipients\' inboxes during the predictive inbox placement test.</p>', 'PlacementStatistics$SpamPercentage' => '<p>The percentage of emails that arrived in recipients\' spam or junk mail folders during the predictive inbox placement test.</p>', 'PlacementStatistics$MissingPercentage' => '<p>The percentage of emails that didn\'t arrive in recipients\' inboxes at all during the predictive inbox placement test.</p>', 'PlacementStatistics$SpfPercentage' => '<p>The percentage of emails that were authenticated by using Sender Policy Framework (SPF) during the predictive inbox placement test.</p>', 'PlacementStatistics$DkimPercentage' => '<p>The percentage of emails that were authenticated by using DomainKeys Identified Mail (DKIM) during the predictive inbox placement test.</p>', ], ], 'Percentage100Wrapper' => [ 'base' => NULL, 'refs' => [ 'DedicatedIp$WarmupPercentage' => '<p>Indicates the progress of your dedicated IP warm-up:</p> <ul> <li> <p> <code>0-100</code> – For standard dedicated IP addresses, this shows the warm-up completion percentage. A value of 100 means the IP address is fully warmed up and ready for use.</p> </li> <li> <p> <code>-1</code> – Appears for IP addresses in managed dedicated pools where Amazon SES automatically handles the warm-up process, making the percentage not applicable.</p> </li> </ul>', 'PutDedicatedIpWarmupAttributesRequest$WarmupPercentage' => '<p>The warm-up percentage that you want to associate with the dedicated IP address.</p>', ], ], 'PinpointDestination' => [ 'base' => '<p>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 <i>Amazon Pinpoint User Guide</i>.</p>', 'refs' => [ 'EventDestination$PinpointDestination' => '<p>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 <i>Amazon Pinpoint User Guide</i>.</p>', 'EventDestinationDefinition$PinpointDestination' => '<p>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 <i>Amazon Pinpoint User Guide</i>.</p>', ], ], 'PlacementStatistics' => [ 'base' => '<p>An object that contains inbox placement data for an email provider.</p>', 'refs' => [ 'GetDeliverabilityTestReportResponse$OverallPlacement' => '<p>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.</p>', 'IspPlacement$PlacementStatistics' => '<p>An object that contains inbox placement metrics for a specific email provider.</p>', ], ], 'Policy' => [ 'base' => '<p>The text of the policy in JSON format. The policy cannot exceed 4 KB.</p> <p>For information about the syntax of sending authorization policies, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>.</p>', 'refs' => [ 'CreateEmailIdentityPolicyRequest$Policy' => '<p>The text of the policy in JSON format. The policy cannot exceed 4 KB.</p> <p>For information about the syntax of sending authorization policies, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html">Amazon SES Developer Guide</a>.</p>', 'PolicyMap$value' => NULL, 'UpdateEmailIdentityPolicyRequest$Policy' => '<p>The text of the policy in JSON format. The policy cannot exceed 4 KB.</p> <p> For information about the syntax of sending authorization policies, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html">Amazon SES Developer Guide</a>.</p>', ], ], 'PolicyMap' => [ 'base' => '<p>An object that contains mapping between <code>PolicyName</code> and <code>Policy</code> text.</p>', 'refs' => [ 'GetEmailIdentityPoliciesResponse$Policies' => '<p>A map of policy names to policies.</p>', 'GetEmailIdentityResponse$Policies' => '<p>A map of policy names to policies.</p>', ], ], 'PolicyName' => [ 'base' => '<p>The name of the policy.</p> <p>The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.</p>', 'refs' => [ 'CreateEmailIdentityPolicyRequest$PolicyName' => '<p>The name of the policy.</p> <p>The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.</p>', 'DeleteEmailIdentityPolicyRequest$PolicyName' => '<p>The name of the policy.</p> <p>The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.</p>', 'PolicyMap$key' => NULL, 'UpdateEmailIdentityPolicyRequest$PolicyName' => '<p>The name of the policy.</p> <p>The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.</p>', ], ], 'PoolName' => [ 'base' => '<p>The name of a dedicated IP pool.</p>', 'refs' => [ 'CreateDedicatedIpPoolRequest$PoolName' => '<p>The name of the dedicated IP pool.</p>', 'DedicatedIp$PoolName' => '<p>The name of the dedicated IP pool that the IP address is associated with.</p>', 'DedicatedIpPool$PoolName' => '<p>The name of the dedicated IP pool.</p>', 'DeleteDedicatedIpPoolRequest$PoolName' => '<p>The name of the dedicated IP pool that you want to delete.</p>', 'DeliveryOptions$SendingPoolName' => '<p>The name of the dedicated IP pool to associate with the configuration set.</p>', 'GetDedicatedIpPoolRequest$PoolName' => '<p>The name of the dedicated IP pool to retrieve.</p>', 'GetDedicatedIpsRequest$PoolName' => '<p>The name of the IP pool that the dedicated IP address is associated with.</p>', 'ListOfDedicatedIpPools$member' => NULL, 'PutDedicatedIpInPoolRequest$DestinationPoolName' => '<p>The name of the IP pool that you want to add the dedicated IP address to. You have to specify an IP pool that already exists.</p>', 'PutDedicatedIpPoolScalingAttributesRequest$PoolName' => '<p>The name of the dedicated IP pool.</p>', ], ], 'PrimaryNameServer' => [ 'base' => NULL, 'refs' => [ 'SOARecord$PrimaryNameServer' => '<p>Primary name server specified in the SOA record.</p>', ], ], 'PrivateKey' => [ 'base' => NULL, 'refs' => [ 'DkimSigningAttributes$DomainSigningPrivateKey' => '<p>[Bring Your Own DKIM] A private key that\'s used to generate a DKIM signature.</p> <p>The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding.</p>', ], ], 'ProcessedRecordsCount' => [ 'base' => NULL, 'refs' => [ 'ExportStatistics$ProcessedRecordsCount' => '<p>The number of records that were processed to generate the final export file.</p>', 'GetImportJobResponse$ProcessedRecordsCount' => '<p>The current number of records processed.</p>', 'ImportJobSummary$ProcessedRecordsCount' => '<p>The current number of records processed.</p>', ], ], 'PutAccountDedicatedIpWarmupAttributesRequest' => [ 'base' => '<p>A request to enable or disable the automatic IP address warm-up feature.</p>', 'refs' => [], ], 'PutAccountDedicatedIpWarmupAttributesResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'PutAccountDetailsRequest' => [ 'base' => '<p>A request to submit new account details.</p>', 'refs' => [], ], 'PutAccountDetailsResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'PutAccountSendingAttributesRequest' => [ 'base' => '<p>A request to change the ability of your account to send email.</p>', 'refs' => [], ], 'PutAccountSendingAttributesResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'PutAccountSuppressionAttributesRequest' => [ 'base' => '<p>A request to change your account\'s suppression preferences.</p>', 'refs' => [], ], 'PutAccountSuppressionAttributesResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'PutAccountVdmAttributesRequest' => [ 'base' => '<p>A request to submit new account VDM attributes.</p>', 'refs' => [], ], 'PutAccountVdmAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutConfigurationSetArchivingOptionsRequest' => [ 'base' => '<p>A request to associate a configuration set with a MailManager archive.</p>', 'refs' => [], ], 'PutConfigurationSetArchivingOptionsResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'PutConfigurationSetDeliveryOptionsRequest' => [ 'base' => '<p>A request to associate a configuration set with a dedicated IP pool.</p>', 'refs' => [], ], 'PutConfigurationSetDeliveryOptionsResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'PutConfigurationSetReputationOptionsRequest' => [ 'base' => '<p>A request to enable or disable tracking of reputation metrics for a configuration set.</p>', 'refs' => [], ], 'PutConfigurationSetReputationOptionsResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'PutConfigurationSetSendingOptionsRequest' => [ 'base' => '<p>A request to enable or disable the ability of Amazon SES to send emails that use a specific configuration set.</p>', 'refs' => [], ], 'PutConfigurationSetSendingOptionsResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'PutConfigurationSetSuppressionOptionsRequest' => [ 'base' => '<p>A request to change the account suppression list preferences for a specific configuration set.</p>', 'refs' => [], ], 'PutConfigurationSetSuppressionOptionsResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'PutConfigurationSetTrackingOptionsRequest' => [ 'base' => '<p>A request to add a custom domain for tracking open and click events to a configuration set.</p>', 'refs' => [], ], 'PutConfigurationSetTrackingOptionsResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'PutConfigurationSetVdmOptionsRequest' => [ 'base' => '<p>A request to add specific VDM settings to a configuration set.</p>', 'refs' => [], ], 'PutConfigurationSetVdmOptionsResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'PutDedicatedIpInPoolRequest' => [ 'base' => '<p>A request to move a dedicated IP address to a dedicated IP pool.</p>', 'refs' => [], ], 'PutDedicatedIpInPoolResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'PutDedicatedIpPoolScalingAttributesRequest' => [ 'base' => '<p>A request to convert a dedicated IP pool to a different scaling mode.</p>', 'refs' => [], ], 'PutDedicatedIpPoolScalingAttributesResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'PutDedicatedIpWarmupAttributesRequest' => [ 'base' => '<p>A request to change the warm-up attributes for a dedicated IP address. This operation is useful when you want to resume the warm-up process for an existing IP address.</p>', 'refs' => [], ], 'PutDedicatedIpWarmupAttributesResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'PutDeliverabilityDashboardOptionRequest' => [ 'base' => '<p>Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon SES API v2. You also gain the ability to perform predictive inbox placement tests.</p> <p>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 <a href="http://aws.amazon.com/pinpoint/pricing/">Amazon Pinpoint Pricing</a>.</p>', 'refs' => [], ], 'PutDeliverabilityDashboardOptionResponse' => [ 'base' => '<p>A response that indicates whether the Deliverability dashboard is enabled.</p>', 'refs' => [], ], 'PutEmailIdentityConfigurationSetAttributesRequest' => [ 'base' => '<p>A request to associate a configuration set with an email identity.</p>', 'refs' => [], ], 'PutEmailIdentityConfigurationSetAttributesResponse' => [ 'base' => '<p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>', 'refs' => [], ], 'PutEmailIdentityDkimAttributesRequest' => [ 'base' => '<p>A request to enable or disable DKIM signing of email that you send from an email identity.</p>', 'refs' => [], ], 'PutEmailIdentityDkimAttributesResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'PutEmailIdentityDkimSigningAttributesRequest' => [ 'base' => '<p>A request to change the DKIM attributes for an email identity.</p>', 'refs' => [], ], 'PutEmailIdentityDkimSigningAttributesResponse' => [ 'base' => '<p>If the action is successful, the service sends back an HTTP 200 response.</p> <p>The following data is returned in JSON format by the service.</p>', 'refs' => [], ], 'PutEmailIdentityFeedbackAttributesRequest' => [ 'base' => '<p>A request to set the attributes that control how bounce and complaint events are processed.</p>', 'refs' => [], ], 'PutEmailIdentityFeedbackAttributesResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'PutEmailIdentityMailFromAttributesRequest' => [ 'base' => '<p>A request to configure the custom MAIL FROM domain for a verified identity.</p>', 'refs' => [], ], 'PutEmailIdentityMailFromAttributesResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'PutSuppressedDestinationRequest' => [ 'base' => '<p>A request to add an email destination to the suppression list for your account.</p>', 'refs' => [], ], 'PutSuppressedDestinationResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'QueryErrorCode' => [ 'base' => NULL, 'refs' => [ 'MetricDataError$Code' => '<p>The query error code. Can be one of:</p> <ul> <li> <p> <code>INTERNAL_FAILURE</code> – Amazon SES has failed to process one of the queries.</p> </li> <li> <p> <code>ACCESS_DENIED</code> – You have insufficient access to retrieve metrics based on the given query.</p> </li> </ul>', ], ], 'QueryErrorMessage' => [ 'base' => NULL, 'refs' => [ 'MetricDataError$Message' => '<p>The error message associated with the current query error.</p>', ], ], 'QueryIdentifier' => [ 'base' => NULL, 'refs' => [ 'BatchGetMetricDataQuery$Id' => '<p>The query identifier.</p>', 'MetricDataError$Id' => '<p>The query identifier.</p>', 'MetricDataResult$Id' => '<p>The query identifier.</p>', ], ], 'RawAttachmentData' => [ 'base' => NULL, 'refs' => [ 'Attachment$RawContent' => '<p> The raw data of the attachment. It needs to be base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services SDK, the SDK takes care of the base 64-encoding for you.</p>', ], ], 'RawMessage' => [ 'base' => '<p>Represents the raw content of an email message.</p>', 'refs' => [ 'EmailContent$Raw' => '<p>The raw email message. The message has to meet the following criteria:</p> <ul> <li> <p>The message has to contain a header and a body, separated by one blank line.</p> </li> <li> <p>All of the required header fields must be present in the message.</p> </li> <li> <p>Each part of a multipart MIME message must be formatted properly.</p> </li> <li> <p>If you include attachments, they must be in a file format that the Amazon SES API v2 supports. </p> </li> <li> <p>The raw data of the message needs to base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services SDK, the SDK takes care of the base 64-encoding for you.</p> </li> <li> <p>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.</p> </li> <li> <p>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>.</p> </li> </ul>', ], ], 'RawMessageData' => [ 'base' => '<p>The raw email message. The message has to meet the following criteria:</p> <ul> <li> <p>The message has to contain a header and a body, separated by one blank line.</p> </li> <li> <p>All of the required header fields must be present in the message.</p> </li> <li> <p>Each part of a multipart MIME message must be formatted properly.</p> </li> <li> <p>Attachments must be in a file format that the Amazon SES API v2 supports. </p> </li> <li> <p>The entire message must be Base64 encoded.</p> </li> <li> <p>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.</p> </li> <li> <p>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>.</p> </li> </ul>', 'refs' => [ 'RawMessage$Data' => '<p>The raw email message. The message has to meet the following criteria:</p> <ul> <li> <p>The message has to contain a header and a body, separated by one blank line.</p> </li> <li> <p>All of the required header fields must be present in the message.</p> </li> <li> <p>Each part of a multipart MIME message must be formatted properly.</p> </li> <li> <p>Attachments must be in a file format that the Amazon SES supports.</p> </li> <li> <p>The raw data of the message needs to base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services SDK, the SDK takes care of the base 64-encoding for you.</p> </li> <li> <p>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.</p> </li> <li> <p>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>.</p> </li> </ul>', ], ], 'RblName' => [ 'base' => '<p>The name of a blacklist that an IP address was found on.</p>', 'refs' => [ 'BlacklistEntry$RblName' => '<p>The name of the blacklist that the IP address appears on.</p>', ], ], 'Recommendation' => [ 'base' => '<p>A recommendation generated for your account.</p>', 'refs' => [ 'RecommendationsList$member' => NULL, ], ], 'RecommendationDescription' => [ 'base' => NULL, 'refs' => [ 'Recommendation$Description' => '<p>The recommendation description / disambiguator - e.g. <code>DKIM1</code> and <code>DKIM2</code> are different recommendations about your DKIM setup.</p>', ], ], 'RecommendationImpact' => [ 'base' => NULL, 'refs' => [ 'Recommendation$Impact' => '<p>The recommendation impact, with values like <code>HIGH</code> or <code>LOW</code>.</p>', 'ReputationEntity$ReputationImpact' => '<p>The reputation impact level for this entity, representing the highest impact reputation finding currently active. Reputation findings can be retrieved using the <code>ListRecommendations</code> operation.</p>', ], ], 'RecommendationStatus' => [ 'base' => NULL, 'refs' => [ 'Recommendation$Status' => '<p>The recommendation status, with values like <code>OPEN</code> or <code>FIXED</code>.</p>', ], ], 'RecommendationType' => [ 'base' => NULL, 'refs' => [ 'Recommendation$Type' => '<p>The recommendation type, with values like <code>DKIM</code>, <code>SPF</code>, <code>DMARC</code>, <code>BIMI</code>, or <code>COMPLAINT</code>.</p>', ], ], 'RecommendationsList' => [ 'base' => NULL, 'refs' => [ 'ListRecommendationsResponse$Recommendations' => '<p>The recommendations applicable to your account.</p>', ], ], 'Region' => [ 'base' => '<p>The name of an AWS-Region.</p>', 'refs' => [ 'Regions$member' => NULL, 'Route$Region' => '<p>The name of an AWS-Region.</p>', 'RouteDetails$Region' => '<p>The name of an AWS-Region to be a secondary region for the multi-region endpoint (global-endpoint).</p>', ], ], 'Regions' => [ 'base' => NULL, 'refs' => [ 'MultiRegionEndpoint$Regions' => '<p>Primary and secondary regions between which multi-region endpoint splits sending traffic.</p>', ], ], 'RenderedEmailTemplate' => [ 'base' => '<p>The complete MIME message rendered by applying the data in the TemplateData parameter to the template specified in the TemplateName parameter.</p>', 'refs' => [ 'TestRenderEmailTemplateResponse$RenderedTemplate' => '<p>The complete MIME message rendered by applying the data in the <code>TemplateData</code> parameter to the template specified in the TemplateName parameter.</p>', ], ], 'ReplacementEmailContent' => [ 'base' => '<p>The <code>ReplaceEmailContent</code> object to be used for a specific <code>BulkEmailEntry</code>. The <code>ReplacementTemplate</code> can be specified within this object.</p>', 'refs' => [ 'BulkEmailEntry$ReplacementEmailContent' => '<p>The <code>ReplacementEmailContent</code> associated with a <code>BulkEmailEntry</code>.</p>', ], ], 'ReplacementTemplate' => [ 'base' => '<p>An object which contains <code>ReplacementTemplateData</code> to be used for a specific <code>BulkEmailEntry</code>.</p>', 'refs' => [ 'ReplacementEmailContent$ReplacementTemplate' => '<p>The <code>ReplacementTemplate</code> associated with <code>ReplacementEmailContent</code>.</p>', ], ], 'ReportId' => [ 'base' => '<p>A unique string that identifies a Deliverability dashboard report.</p>', 'refs' => [ 'CreateDeliverabilityTestReportResponse$ReportId' => '<p>A unique string that identifies the predictive inbox placement test.</p>', 'DeliverabilityTestReport$ReportId' => '<p>A unique string that identifies the predictive inbox placement test.</p>', 'GetDeliverabilityTestReportRequest$ReportId' => '<p>A unique string that identifies the predictive inbox placement test.</p>', ], ], 'ReportName' => [ 'base' => '<p>A name that helps you identify a report generated by the Deliverability dashboard.</p>', 'refs' => [ 'CreateDeliverabilityTestReportRequest$ReportName' => '<p>A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.</p>', 'DeliverabilityTestReport$ReportName' => '<p>A name that helps you identify a predictive inbox placement test report.</p>', ], ], 'ReputationEntitiesList' => [ 'base' => '<p>A list of reputation entities.</p>', 'refs' => [ 'ListReputationEntitiesResponse$ReputationEntities' => '<p>An array that contains information about the reputation entities in your account.</p>', ], ], 'ReputationEntity' => [ 'base' => '<p>An object that contains information about a reputation entity, including its reference, type, policy, status records, and reputation impact.</p>', 'refs' => [ 'GetReputationEntityResponse$ReputationEntity' => '<p>The reputation entity information, including status records, policy configuration, and reputation impact.</p>', 'ReputationEntitiesList$member' => NULL, ], ], 'ReputationEntityFilter' => [ 'base' => '<p>An object that contains filters to apply when listing reputation entities.</p>', 'refs' => [ 'ListReputationEntitiesRequest$Filter' => '<p>An object that contains filters to apply when listing reputation entities. You can filter by entity type, reputation impact, sending status, or entity reference prefix.</p>', ], ], 'ReputationEntityFilterKey' => [ 'base' => '<p>The filter key to use when listing reputation entities. This can be one of the following:</p> <ul> <li> <p> <code>ENTITY_TYPE</code> – Filter by entity type.</p> </li> <li> <p> <code>REPUTATION_IMPACT</code> – Filter by reputation impact level.</p> </li> <li> <p> <code>SENDING_STATUS</code> – Filter by aggregate sending status.</p> </li> <li> <p> <code>ENTITY_REFERENCE_PREFIX</code> – Filter by entity reference prefix.</p> </li> </ul>', 'refs' => [ 'ReputationEntityFilter$key' => NULL, ], ], 'ReputationEntityFilterValue' => [ 'base' => '<p>The filter value to match against the specified filter key.</p>', 'refs' => [ 'ReputationEntityFilter$value' => NULL, ], ], 'ReputationEntityReference' => [ 'base' => '<p>The unique identifier for a reputation entity. For resource-type entities, this is the Amazon Resource Name (ARN) of the resource.</p>', 'refs' => [ 'GetReputationEntityRequest$ReputationEntityReference' => '<p>The unique identifier for the reputation entity. For resource-type entities, this is the Amazon Resource Name (ARN) of the resource.</p>', 'ReputationEntity$ReputationEntityReference' => '<p>The unique identifier for the reputation entity. For resource-type entities, this is the Amazon Resource Name (ARN) of the resource.</p>', 'UpdateReputationEntityCustomerManagedStatusRequest$ReputationEntityReference' => '<p>The unique identifier for the reputation entity. For resource-type entities, this is the Amazon Resource Name (ARN) of the resource.</p>', 'UpdateReputationEntityPolicyRequest$ReputationEntityReference' => '<p>The unique identifier for the reputation entity. For resource-type entities, this is the Amazon Resource Name (ARN) of the resource.</p>', ], ], 'ReputationEntityType' => [ 'base' => '<p>The type of reputation entity. Currently, only <code>RESOURCE</code> type entities are supported, which represent resources in your Amazon SES account that have reputation tracking capabilities.</p>', 'refs' => [ 'GetReputationEntityRequest$ReputationEntityType' => '<p>The type of reputation entity. Currently, only <code>RESOURCE</code> type entities are supported.</p>', 'ReputationEntity$ReputationEntityType' => '<p>The type of reputation entity. Currently, only <code>RESOURCE</code> type entities are supported.</p>', 'UpdateReputationEntityCustomerManagedStatusRequest$ReputationEntityType' => '<p>The type of reputation entity. Currently, only <code>RESOURCE</code> type entities are supported.</p>', 'UpdateReputationEntityPolicyRequest$ReputationEntityType' => '<p>The type of reputation entity. Currently, only <code>RESOURCE</code> type entities are supported.</p>', ], ], 'ReputationOptions' => [ 'base' => '<p>Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current Amazon Web Services Region. </p>', 'refs' => [ 'CreateConfigurationSetRequest$ReputationOptions' => '<p>An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.</p>', 'GetConfigurationSetResponse$ReputationOptions' => '<p>An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.</p>', ], ], 'ResourceTenantMetadata' => [ 'base' => '<p>A structure that contains information about a tenant associated with a resource.</p>', 'refs' => [ 'ResourceTenantMetadataList$member' => NULL, ], ], 'ResourceTenantMetadataList' => [ 'base' => '<p>A list of tenant metadata objects associated with a resource.</p>', 'refs' => [ 'ListResourceTenantsResponse$ResourceTenants' => '<p>An array that contains information about each tenant associated with the resource.</p>', ], ], 'ResourceType' => [ 'base' => '<p>The type of resource that can be associated with a tenant. Can be one of the following:</p> <ul> <li> <p> <code>EMAIL_IDENTITY</code> - An email address or domain that you use to send email.</p> </li> <li> <p> <code>CONFIGURATION_SET</code> - A set of rules that you can apply to emails you send.</p> </li> <li> <p> <code>EMAIL_TEMPLATE</code> - A template that defines the content of an email message.</p> </li> </ul>', 'refs' => [ 'TenantResource$ResourceType' => '<p>The type of resource associated with the tenant. Valid values are <code>EMAIL_IDENTITY</code>, <code>CONFIGURATION_SET</code>, or <code>EMAIL_TEMPLATE</code>.</p>', ], ], 'ReviewDetails' => [ 'base' => '<p>An object that contains information about your account details review.</p>', 'refs' => [ 'AccountDetails$ReviewDetails' => '<p>Information about the review of the latest details you submitted.</p>', ], ], 'ReviewStatus' => [ 'base' => NULL, 'refs' => [ 'ReviewDetails$Status' => '<p>The status of the latest review of your account. The status can be one of the following:</p> <ul> <li> <p> <code>PENDING</code> – We have received your appeal and are in the process of reviewing it.</p> </li> <li> <p> <code>GRANTED</code> – Your appeal has been reviewed and your production access has been granted.</p> </li> <li> <p> <code>DENIED</code> – Your appeal has been reviewed and your production access has been denied.</p> </li> <li> <p> <code>FAILED</code> – An internal error occurred and we didn\'t receive your appeal. You can submit your appeal again.</p> </li> </ul>', ], ], 'Route' => [ 'base' => '<p>An object which contains an AWS-Region and routing status.</p>', 'refs' => [ 'Routes$member' => NULL, ], ], 'RouteDetails' => [ 'base' => '<p>An object that contains route configuration. Includes secondary region name.</p>', 'refs' => [ 'RoutesDetails$member' => NULL, ], ], 'Routes' => [ 'base' => '<p>A list of routes between which the traffic will be split when sending through the multi-region endpoint (global-endpoint).</p>', 'refs' => [ 'GetMultiRegionEndpointResponse$Routes' => '<p>Contains routes information for the multi-region endpoint (global-endpoint).</p>', ], ], 'RoutesDetails' => [ 'base' => '<p>A list of route configuration details. Must contain exactly one route configuration.</p>', 'refs' => [ 'Details$RoutesDetails' => '<p>A list of route configuration details. Must contain exactly one route configuration.</p>', ], ], 'S3Url' => [ 'base' => '<p>An Amazon S3 URL in the format s3://<i>&lt;bucket_name&gt;</i>/<i>&lt;object&gt;</i> or a pre-signed URL.</p>', 'refs' => [ 'ExportDestination$S3Url' => '<p>An Amazon S3 pre-signed URL that points to the generated export file.</p>', 'ImportDataSource$S3Url' => '<p>An Amazon S3 URL in the format s3://<i>&lt;bucket_name&gt;</i>/<i>&lt;object&gt;</i>.</p>', ], ], 'SOARecord' => [ 'base' => '<p>An object that contains information about the start of authority (SOA) record associated with the identity.</p>', 'refs' => [ 'VerificationInfo$SOARecord' => '<p>An object that contains information about the start of authority (SOA) record associated with the identity.</p>', ], ], 'ScalingMode' => [ 'base' => NULL, 'refs' => [ 'CreateDedicatedIpPoolRequest$ScalingMode' => '<p>The type of scaling mode.</p>', 'DedicatedIpPool$ScalingMode' => '<p>The type of the dedicated IP pool.</p> <ul> <li> <p> <code>STANDARD</code> – A dedicated IP pool where you can control which IPs are part of the pool.</p> </li> <li> <p> <code>MANAGED</code> – A dedicated IP pool where the reputation and number of IPs are automatically managed by Amazon SES.</p> </li> </ul>', 'PutDedicatedIpPoolScalingAttributesRequest$ScalingMode' => '<p>The scaling mode to apply to the dedicated IP pool.</p> <note> <p>Changing the scaling mode from <code>MANAGED</code> to <code>STANDARD</code> is not supported.</p> </note>', ], ], 'Selector' => [ 'base' => NULL, 'refs' => [ 'DkimSigningAttributes$DomainSigningSelector' => '<p>[Bring Your Own DKIM] A string that\'s used to identify a public key in the DNS configuration for a domain.</p>', ], ], 'SendBulkEmailRequest' => [ 'base' => '<p>Represents a request to send email messages to multiple destinations using Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html">Amazon SES Developer Guide</a>.</p>', 'refs' => [], ], 'SendBulkEmailResponse' => [ 'base' => '<p>The following data is returned in JSON format by the service.</p>', 'refs' => [], ], 'SendCustomVerificationEmailRequest' => [ 'base' => '<p>Represents a request to send a custom verification email to a specified recipient.</p>', 'refs' => [], ], 'SendCustomVerificationEmailResponse' => [ 'base' => '<p>The following element is returned by the service.</p>', 'refs' => [], ], 'SendEmailRequest' => [ 'base' => '<p>Represents a request to send a single formatted email using Amazon SES. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-formatted.html">Amazon SES Developer Guide</a>.</p>', 'refs' => [], ], 'SendEmailResponse' => [ 'base' => '<p>A unique message ID that you receive when an email is accepted for sending.</p>', 'refs' => [], ], 'SendQuota' => [ 'base' => '<p>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.</p>', 'refs' => [ 'GetAccountResponse$SendQuota' => '<p>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.</p>', ], ], 'SendingOptions' => [ 'base' => '<p>Used to enable or disable email sending for messages that use this configuration set in the current Amazon Web Services Region.</p>', 'refs' => [ 'CreateConfigurationSetRequest$SendingOptions' => '<p>An object that defines whether or not Amazon SES can send email that you send using the configuration set.</p>', 'GetConfigurationSetResponse$SendingOptions' => '<p>An object that defines whether or not Amazon SES can send email that you send using the configuration set.</p>', ], ], 'SendingPausedException' => [ 'base' => '<p>The message can\'t be sent because the account\'s ability to send email is currently paused.</p>', 'refs' => [], ], 'SendingPoolName' => [ 'base' => '<p>The name of the dedicated IP pool to associate with the configuration set.</p>', 'refs' => [ 'PutConfigurationSetDeliveryOptionsRequest$SendingPoolName' => '<p>The name of the dedicated IP pool to associate with the configuration set.</p>', ], ], 'SendingStatus' => [ 'base' => '<p>The sending status for a reputation entity. This can be one of the following:</p> <ul> <li> <p> <code>ENABLED</code> – Sending is allowed for this entity.</p> </li> <li> <p> <code>DISABLED</code> – Sending is prevented for this entity.</p> </li> <li> <p> <code>REINSTATED</code> – Sending is allowed even if there are active reputation findings.</p> </li> </ul>', 'refs' => [ 'CreateTenantResponse$SendingStatus' => '<p>The status of email sending capability for the tenant.</p>', 'ReputationEntity$SendingStatusAggregate' => '<p>The aggregate sending status that determines whether the entity is allowed to send emails. This status is derived from both the customer-managed and Amazon Web Services Amazon SES-managed statuses. If either the customer-managed status or the Amazon Web Services Amazon SES-managed status is <code>DISABLED</code>, the aggregate status will be <code>DISABLED</code> and the entity will not be allowed to send emails. When the customer-managed status is set to <code>REINSTATED</code>, the entity can continue sending even if there are active reputation findings, provided the Amazon Web Services Amazon SES-managed status also permits sending. The entity can only send emails when both statuses permit sending.</p>', 'StatusRecord$Status' => '<p>The current sending status. This can be one of the following:</p> <ul> <li> <p> <code>ENABLED</code> – Sending is allowed.</p> </li> <li> <p> <code>DISABLED</code> – Sending is prevented.</p> </li> <li> <p> <code>REINSTATED</code> – Sending is allowed even with active reputation findings.</p> </li> </ul>', 'Tenant$SendingStatus' => '<p>The status of sending capability for the tenant.</p>', 'UpdateReputationEntityCustomerManagedStatusRequest$SendingStatus' => '<p>The new customer-managed sending status for the reputation entity. This can be one of the following:</p> <ul> <li> <p> <code>ENABLED</code> – Allow sending for this entity.</p> </li> <li> <p> <code>DISABLED</code> – Prevent sending for this entity.</p> </li> <li> <p> <code>REINSTATED</code> – Allow sending even if there are active reputation findings.</p> </li> </ul>', ], ], 'SentLast24Hours' => [ 'base' => NULL, 'refs' => [ 'SendQuota$SentLast24Hours' => '<p>The number of emails sent from your Amazon SES account in the current Amazon Web Services Region over the past 24 hours.</p>', ], ], 'SerialNumber' => [ 'base' => NULL, 'refs' => [ 'SOARecord$SerialNumber' => '<p>Serial number from the SOA record.</p>', ], ], 'SnsDestination' => [ 'base' => '<p>An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notifications when certain email events occur.</p>', 'refs' => [ 'EventDestination$SnsDestination' => '<p>An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notifications when certain email events occur.</p>', 'EventDestinationDefinition$SnsDestination' => '<p>An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notifications when certain email events occur.</p>', ], ], 'Status' => [ 'base' => '<p>The status of the multi-region endpoint (global-endpoint).</p> <ul> <li> <p> <code>CREATING</code> – The resource is being provisioned.</p> </li> <li> <p> <code>READY</code> – The resource is ready to use.</p> </li> <li> <p> <code>FAILED</code> – The resource failed to be provisioned.</p> </li> <li> <p> <code>DELETING</code> – The resource is being deleted as requested.</p> </li> </ul>', 'refs' => [ 'CreateMultiRegionEndpointResponse$Status' => '<p>A status of the multi-region endpoint (global-endpoint) right after the create request.</p> <ul> <li> <p> <code>CREATING</code> – The resource is being provisioned.</p> </li> <li> <p> <code>READY</code> – The resource is ready to use.</p> </li> <li> <p> <code>FAILED</code> – The resource failed to be provisioned.</p> </li> <li> <p> <code>DELETING</code> – The resource is being deleted as requested.</p> </li> </ul>', 'DeleteMultiRegionEndpointResponse$Status' => '<p>A status of the multi-region endpoint (global-endpoint) right after the delete request.</p> <ul> <li> <p> <code>CREATING</code> – The resource is being provisioned.</p> </li> <li> <p> <code>READY</code> – The resource is ready to use.</p> </li> <li> <p> <code>FAILED</code> – The resource failed to be provisioned.</p> </li> <li> <p> <code>DELETING</code> – The resource is being deleted as requested.</p> </li> </ul>', 'GetMultiRegionEndpointResponse$Status' => '<p>The status of the multi-region endpoint (global-endpoint).</p> <ul> <li> <p> <code>CREATING</code> – The resource is being provisioned.</p> </li> <li> <p> <code>READY</code> – The resource is ready to use.</p> </li> <li> <p> <code>FAILED</code> – The resource failed to be provisioned.</p> </li> <li> <p> <code>DELETING</code> – The resource is being deleted as requested.</p> </li> </ul>', 'MultiRegionEndpoint$Status' => '<p>The status of the multi-region endpoint (global-endpoint).</p> <ul> <li> <p> <code>CREATING</code> – The resource is being provisioned.</p> </li> <li> <p> <code>READY</code> – The resource is ready to use.</p> </li> <li> <p> <code>FAILED</code> – The resource failed to be provisioned.</p> </li> <li> <p> <code>DELETING</code> – The resource is being deleted as requested.</p> </li> </ul>', ], ], 'StatusCause' => [ 'base' => '<p>A description of the reason for a status change, such as automated actions taken due to reputation findings or manual status updates.</p>', 'refs' => [ 'StatusRecord$Cause' => '<p>A description of the reason for the current status, or null if no specific cause is available.</p>', ], ], 'StatusRecord' => [ 'base' => '<p>An object that contains status information for a reputation entity, including the current status, cause description, and timestamp.</p>', 'refs' => [ 'ReputationEntity$CustomerManagedStatus' => '<p>The customer-managed status record for this reputation entity, including the current status, cause description, and last updated timestamp.</p>', 'ReputationEntity$AwsSesManagedStatus' => '<p>The Amazon Web Services Amazon SES-managed status record for this reputation entity, including the current status, cause description, and last updated timestamp.</p>', ], ], 'Subject' => [ 'base' => NULL, 'refs' => [ 'DomainDeliverabilityCampaign$Subject' => '<p>The subject line, or title, of the email message.</p>', ], ], 'SubscriptionStatus' => [ 'base' => NULL, 'refs' => [ 'ListContactsFilter$FilteredStatus' => '<p>The status by which you are filtering: <code>OPT_IN</code> or <code>OPT_OUT</code>.</p>', 'Topic$DefaultSubscriptionStatus' => '<p>The default subscription status to be applied to a contact if the contact has not noted their preference for subscribing to a topic.</p>', 'TopicPreference$SubscriptionStatus' => '<p>The contact\'s subscription status to a topic which is either <code>OPT_IN</code> or <code>OPT_OUT</code>.</p>', ], ], 'SuccessRedirectionURL' => [ 'base' => '<p>The URL that the recipient of the verification email is sent to if his or her address is successfully verified.</p>', 'refs' => [ 'CreateCustomVerificationEmailTemplateRequest$SuccessRedirectionURL' => '<p>The URL that the recipient of the verification email is sent to if his or her address is successfully verified.</p>', 'CustomVerificationEmailTemplateMetadata$SuccessRedirectionURL' => '<p>The URL that the recipient of the verification email is sent to if his or her address is successfully verified.</p>', 'GetCustomVerificationEmailTemplateResponse$SuccessRedirectionURL' => '<p>The URL that the recipient of the verification email is sent to if his or her address is successfully verified.</p>', 'UpdateCustomVerificationEmailTemplateRequest$SuccessRedirectionURL' => '<p>The URL that the recipient of the verification email is sent to if his or her address is successfully verified.</p>', ], ], 'SuppressedDestination' => [ 'base' => '<p>An object that contains information about an email address that is on the suppression list for your account.</p>', 'refs' => [ 'GetSuppressedDestinationResponse$SuppressedDestination' => '<p>An object containing information about the suppressed email address.</p>', ], ], 'SuppressedDestinationAttributes' => [ 'base' => '<p>An object that contains additional attributes that are related an email address that is on the suppression list for your account.</p>', 'refs' => [ 'SuppressedDestination$Attributes' => '<p>An optional value that can contain additional information about the reasons that the address was added to the suppression list for your account.</p>', ], ], 'SuppressedDestinationSummaries' => [ 'base' => NULL, 'refs' => [ 'ListSuppressedDestinationsResponse$SuppressedDestinationSummaries' => '<p>A list of summaries, each containing a summary for a suppressed email destination.</p>', ], ], 'SuppressedDestinationSummary' => [ 'base' => '<p>A summary that describes the suppressed email address.</p>', 'refs' => [ 'SuppressedDestinationSummaries$member' => NULL, ], ], 'SuppressionAttributes' => [ 'base' => '<p>An object that contains information about the email address suppression preferences for your account in the current Amazon Web Services Region.</p>', 'refs' => [ 'GetAccountResponse$SuppressionAttributes' => '<p>An object that contains information about the email address suppression preferences for your account in the current Amazon Web Services Region.</p>', ], ], 'SuppressionListDestination' => [ 'base' => '<p>An object that contains details about the action of suppression list.</p>', 'refs' => [ 'ImportDestination$SuppressionListDestination' => '<p>An object that contains the action of the import job towards suppression list.</p>', ], ], 'SuppressionListImportAction' => [ 'base' => '<p>The type of action to perform on the address. The following are possible values:</p> <ul> <li> <p>PUT: add the addresses to the suppression list.</p> </li> <li> <p>DELETE: remove the address from the suppression list.</p> </li> </ul>', 'refs' => [ 'SuppressionListDestination$SuppressionListImportAction' => '<p>The type of action to perform on the address. The following are possible values:</p> <ul> <li> <p>PUT: add the addresses to the suppression list. If the record already exists, it will override it with the new value.</p> </li> <li> <p>DELETE: remove the addresses from the suppression list.</p> </li> </ul>', ], ], 'SuppressionListReason' => [ 'base' => '<p>The reason that the address was added to the suppression list for your account. The value can be one of the following:</p> <ul> <li> <p> <code>COMPLAINT</code> – Amazon SES added an email address to the suppression list for your account because a message sent to that address results in a complaint.</p> </li> <li> <p> <code>BOUNCE</code> – Amazon SES added an email address to the suppression list for your account because a message sent to that address results in a hard bounce.</p> </li> </ul>', 'refs' => [ 'PutSuppressedDestinationRequest$Reason' => '<p>The factors that should cause the email address to be added to the suppression list for your account.</p>', 'SuppressedDestination$Reason' => '<p>The reason that the address was added to the suppression list for your account.</p>', 'SuppressedDestinationSummary$Reason' => '<p>The reason that the address was added to the suppression list for your account.</p>', 'SuppressionListReasons$member' => NULL, ], ], 'SuppressionListReasons' => [ 'base' => NULL, 'refs' => [ 'ListSuppressedDestinationsRequest$Reasons' => '<p>The factors that caused the email address to be added to .</p>', 'PutAccountSuppressionAttributesRequest$SuppressedReasons' => '<p>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:</p> <ul> <li> <p> <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.</p> </li> <li> <p> <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.</p> </li> </ul>', 'PutConfigurationSetSuppressionOptionsRequest$SuppressedReasons' => '<p>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:</p> <ul> <li> <p> <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.</p> </li> <li> <p> <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.</p> </li> </ul>', 'SuppressionAttributes$SuppressedReasons' => '<p>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:</p> <ul> <li> <p> <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.</p> </li> <li> <p> <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.</p> </li> </ul>', 'SuppressionOptions$SuppressedReasons' => '<p>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:</p> <ul> <li> <p> <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.</p> </li> <li> <p> <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.</p> </li> </ul>', ], ], 'SuppressionOptions' => [ 'base' => '<p>An object that contains information about the suppression list preferences for your account.</p>', 'refs' => [ 'CreateConfigurationSetRequest$SuppressionOptions' => NULL, 'GetConfigurationSetResponse$SuppressionOptions' => '<p>An object that contains information about the suppression list preferences for your account.</p>', ], ], 'Tag' => [ 'base' => '<p>An object that defines the tags that are associated with a resource. A <i>tag</i> 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.</p> <p>Each tag consists of a required <i>tag key</i> and an associated <i>tag value</i>, 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:</p> <ul> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>For each associated resource, each tag key must be unique and it can have only one value.</p> </li> <li> <p>The <code>aws:</code> prefix is reserved for use by Amazon Web Services; you can’t use it in any tag keys or values that you define. In addition, you can\'t edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource.</p> </li> <li> <p>You can associate tags with public or shared resources, but the tags are available only for your Amazon Web Services account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified Amazon Web Services Region for your Amazon Web Services account.</p> </li> </ul>', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '<p>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.</p>', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => '<p>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.</p> <p>To remove more than one tag from the resource, append the <code>TagKeys</code> parameter and argument for each additional tag to remove, separated by an ampersand. For example: <code>/v2/email/tags?ResourceArn=ResourceArn&amp;TagKeys=Key1&amp;TagKeys=Key2</code> </p>', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateConfigurationSetRequest$Tags' => '<p>An array of objects that define the tags (keys and values) to associate with the configuration set.</p>', 'CreateContactListRequest$Tags' => '<p>The tags associated with a contact list.</p>', 'CreateDedicatedIpPoolRequest$Tags' => '<p>An object that defines the tags (keys and values) that you want to associate with the pool.</p>', 'CreateDeliverabilityTestReportRequest$Tags' => '<p>An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.</p>', 'CreateEmailIdentityRequest$Tags' => '<p>An array of objects that define the tags (keys and values) to associate with the email identity.</p>', 'CreateMultiRegionEndpointRequest$Tags' => '<p>An array of objects that define the tags (keys and values) to associate with the multi-region endpoint (global-endpoint).</p>', 'CreateTenantRequest$Tags' => '<p>An array of objects that define the tags (keys and values) to associate with the tenant</p>', 'CreateTenantResponse$Tags' => '<p>An array of objects that define the tags (keys and values) associated with the tenant.</p>', 'GetConfigurationSetResponse$Tags' => '<p>An array of objects that define the tags (keys and values) that are associated with the configuration set.</p>', 'GetContactListResponse$Tags' => '<p>The tags associated with a contact list.</p>', 'GetDeliverabilityTestReportResponse$Tags' => '<p>An array of objects that define the tags (keys and values) that are associated with the predictive inbox placement test.</p>', 'GetEmailIdentityResponse$Tags' => '<p>An array of objects that define the tags (keys and values) that are associated with the email identity.</p>', 'ListTagsForResourceResponse$Tags' => '<p>An array that lists all the tags that are associated with the resource. Each tag consists of a required tag key (<code>Key</code>) and an associated tag value (<code>Value</code>)</p>', 'TagResourceRequest$Tags' => '<p>A list of the tags that you want to add to the resource. A tag consists of a required tag key (<code>Key</code>) and an associated tag value (<code>Value</code>). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.</p>', 'Tenant$Tags' => '<p>An array of objects that define the tags (keys and values) associated with the tenant.</p>', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '<p>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.</p>', ], ], 'Template' => [ 'base' => '<p>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 <i>email template</i> is a type of message template that contains content that you want to reuse in email messages that you send. You can specifiy the email template by providing the name or ARN of an <i>email template</i> previously saved in your Amazon SES account or by providing the full template content.</p>', 'refs' => [ 'BulkEmailContent$Template' => '<p>The template to use for the bulk email message.</p>', 'EmailContent$Template' => '<p>The template to use for the email message.</p>', ], ], 'TemplateContent' => [ 'base' => '<p>The content of the custom verification email template.</p>', 'refs' => [ 'CreateCustomVerificationEmailTemplateRequest$TemplateContent' => '<p>The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom-faq">Custom verification email frequently asked questions</a> in the <i>Amazon SES Developer Guide</i>.</p>', 'GetCustomVerificationEmailTemplateResponse$TemplateContent' => '<p>The content of the custom verification email.</p>', 'UpdateCustomVerificationEmailTemplateRequest$TemplateContent' => '<p>The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom-faq">Custom verification email frequently asked questions</a> in the <i>Amazon SES Developer Guide</i>.</p>', ], ], 'Tenant' => [ 'base' => '<p>A structure that contains details about a tenant.</p>', 'refs' => [ 'GetTenantResponse$Tenant' => '<p>A structure that contains details about the tenant.</p>', ], ], 'TenantId' => [ 'base' => NULL, 'refs' => [ 'CreateTenantResponse$TenantId' => '<p>A unique identifier for the tenant.</p>', 'ResourceTenantMetadata$TenantId' => '<p>A unique identifier for the tenant associated with the resource.</p>', 'Tenant$TenantId' => '<p>A unique identifier for the tenant.</p>', 'TenantInfo$TenantId' => '<p>A unique identifier for the tenant.</p>', ], ], 'TenantInfo' => [ 'base' => '<p>A structure that contains basic information about a tenant.</p>', 'refs' => [ 'TenantInfoList$member' => NULL, ], ], 'TenantInfoList' => [ 'base' => '<p>A list of tenant information objects.</p>', 'refs' => [ 'ListTenantsResponse$Tenants' => '<p>An array that contains basic information about each tenant.</p>', ], ], 'TenantName' => [ 'base' => '<p>The name of a tenant. The name can contain up to 64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_) only.</p>', 'refs' => [ 'CreateTenantRequest$TenantName' => '<p>The name of the tenant to create. The name can contain up to 64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_) only.</p>', 'CreateTenantResourceAssociationRequest$TenantName' => '<p>The name of the tenant to associate the resource with.</p>', 'CreateTenantResponse$TenantName' => '<p>The name of the tenant.</p>', 'DeleteTenantRequest$TenantName' => '<p>The name of the tenant to delete.</p>', 'DeleteTenantResourceAssociationRequest$TenantName' => '<p>The name of the tenant to remove the resource association from.</p>', 'GetTenantRequest$TenantName' => '<p>The name of the tenant to retrieve information about.</p>', 'ListTenantResourcesRequest$TenantName' => '<p>The name of the tenant to list resources for.</p>', 'ResourceTenantMetadata$TenantName' => '<p>The name of the tenant associated with the resource.</p>', 'SendBulkEmailRequest$TenantName' => '<p>The name of the tenant through which this bulk email will be sent.</p> <note> <p> The email sending operation will only succeed if all referenced resources (identities, configuration sets, and templates) are associated with this tenant. </p> </note>', 'SendEmailRequest$TenantName' => '<p>The name of the tenant through which this email will be sent.</p> <note> <p>The email sending operation will only succeed if all referenced resources (identities, configuration sets, and templates) are associated with this tenant. </p> </note>', 'Tenant$TenantName' => '<p>The name of the tenant.</p>', 'TenantInfo$TenantName' => '<p>The name of the tenant.</p>', ], ], 'TenantResource' => [ 'base' => '<p>A structure that contains information about a resource associated with a tenant.</p>', 'refs' => [ 'TenantResourceList$member' => NULL, ], ], 'TenantResourceList' => [ 'base' => '<p>A list of resources associated with a tenant.</p>', 'refs' => [ 'ListTenantResourcesResponse$TenantResources' => '<p>An array that contains information about each resource associated with the tenant.</p>', ], ], 'TestRenderEmailTemplateRequest' => [ 'base' => '<p>&gt;Represents a request to create a preview of the MIME content of an email when provided with a template and a set of replacement data.</p>', 'refs' => [], ], 'TestRenderEmailTemplateResponse' => [ 'base' => '<p>The following element is returned by the service.</p>', 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'BatchGetMetricDataQuery$StartDate' => '<p>Represents the start date for the query interval.</p>', 'BatchGetMetricDataQuery$EndDate' => '<p>Represents the end date for the query interval.</p>', 'BlacklistEntry$ListingTime' => '<p>The time when the blacklisting event occurred.</p>', 'Contact$LastUpdatedTimestamp' => '<p>A timestamp noting the last time the contact\'s information was updated.</p>', 'ContactList$LastUpdatedTimestamp' => '<p>A timestamp noting the last time the contact list was updated.</p>', 'CreateTenantResponse$CreatedTimestamp' => '<p>The date and time when the tenant was created.</p>', 'DailyVolume$StartDate' => '<p>The date that the DailyVolume metrics apply to, in Unix time.</p>', 'DeliverabilityTestReport$CreateDate' => '<p>The date and time when the predictive inbox placement test was created.</p>', 'DkimAttributes$LastKeyGenerationTimestamp' => '<p>[Easy DKIM] The last time a key pair was generated for this identity.</p>', 'DomainDeliverabilityCampaign$FirstSeenDateTime' => '<p>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.</p>', 'DomainDeliverabilityCampaign$LastSeenDateTime' => '<p>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.</p>', 'DomainDeliverabilityTrackingOption$SubscriptionStartDate' => '<p>The date when you enabled the Deliverability dashboard for the domain.</p>', 'EmailTemplateMetadata$CreatedTimestamp' => '<p>The time and date the template was created.</p>', 'ExportJobSummary$CreatedTimestamp' => '<p>The timestamp of when the export job was created.</p>', 'ExportJobSummary$CompletedTimestamp' => '<p>The timestamp of when the export job was completed.</p>', 'GetContactListResponse$CreatedTimestamp' => '<p>A timestamp noting when the contact list was created.</p>', 'GetContactListResponse$LastUpdatedTimestamp' => '<p>A timestamp noting the last time the contact list was updated.</p>', 'GetContactResponse$CreatedTimestamp' => '<p>A timestamp noting when the contact was created.</p>', 'GetContactResponse$LastUpdatedTimestamp' => '<p>A timestamp noting the last time the contact\'s information was updated.</p>', 'GetDeliverabilityDashboardOptionsResponse$SubscriptionExpiryDate' => '<p>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.</p>', 'GetDomainStatisticsReportRequest$StartDate' => '<p>The first day (in Unix time) that you want to obtain domain deliverability metrics for.</p>', 'GetDomainStatisticsReportRequest$EndDate' => '<p>The last day (in Unix time) that you want to obtain domain deliverability metrics for. The <code>EndDate</code> that you specify has to be less than or equal to 30 days after the <code>StartDate</code>.</p>', 'GetExportJobResponse$CreatedTimestamp' => '<p>The timestamp of when the export job was created.</p>', 'GetExportJobResponse$CompletedTimestamp' => '<p>The timestamp of when the export job was completed.</p>', 'GetImportJobResponse$CreatedTimestamp' => '<p>The time stamp of when the import job was created.</p>', 'GetImportJobResponse$CompletedTimestamp' => '<p>The time stamp of when the import job was completed.</p>', 'GetMultiRegionEndpointResponse$CreatedTimestamp' => '<p>The time stamp of when the multi-region endpoint (global-endpoint) was created.</p>', 'GetMultiRegionEndpointResponse$LastUpdatedTimestamp' => '<p>The time stamp of when the multi-region endpoint (global-endpoint) was last updated.</p>', 'ImportJobSummary$CreatedTimestamp' => '<p>The date and time when the import job was created.</p>', 'InsightsEvent$Timestamp' => '<p>The timestamp of the event.</p>', 'ListDomainDeliverabilityCampaignsRequest$StartDate' => '<p>The first day that you want to obtain deliverability data for.</p>', 'ListDomainDeliverabilityCampaignsRequest$EndDate' => '<p>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 <code>StartDate</code> parameter.</p>', 'ListSuppressedDestinationsRequest$StartDate' => '<p>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.</p>', 'ListSuppressedDestinationsRequest$EndDate' => '<p>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.</p>', 'MessageInsightsDataSource$StartDate' => '<p>Represents the start date for the export interval as a timestamp. The start date is inclusive.</p>', 'MessageInsightsDataSource$EndDate' => '<p>Represents the end date for the export interval as a timestamp. The end date is inclusive.</p>', 'MetricsDataSource$StartDate' => '<p>Represents the start date for the export interval as a timestamp.</p>', 'MetricsDataSource$EndDate' => '<p>Represents the end date for the export interval as a timestamp.</p>', 'MultiRegionEndpoint$CreatedTimestamp' => '<p>The time stamp of when the multi-region endpoint (global-endpoint) was created.</p>', 'MultiRegionEndpoint$LastUpdatedTimestamp' => '<p>The time stamp of when the multi-region endpoint (global-endpoint) was last updated.</p>', 'Recommendation$CreatedTimestamp' => '<p>The first time this issue was encountered and the recommendation was generated.</p>', 'Recommendation$LastUpdatedTimestamp' => '<p>The last time the recommendation was updated.</p>', 'ResourceTenantMetadata$AssociatedTimestamp' => '<p>The date and time when the resource was associated with the tenant.</p>', 'StatusRecord$LastUpdatedTimestamp' => '<p>The timestamp when this status was last updated.</p>', 'SuppressedDestination$LastUpdateTime' => '<p>The date and time when the suppressed destination was last updated, shown in Unix time format.</p>', 'SuppressedDestinationSummary$LastUpdateTime' => '<p>The date and time when the suppressed destination was last updated, shown in Unix time format.</p>', 'Tenant$CreatedTimestamp' => '<p>The date and time when the tenant was created.</p>', 'TenantInfo$CreatedTimestamp' => '<p>The date and time when the tenant was created.</p>', 'TimestampList$member' => NULL, 'VerificationInfo$LastCheckedTimestamp' => '<p>The last time a verification attempt was made for this identity.</p>', 'VerificationInfo$LastSuccessTimestamp' => '<p>The last time a successful verification was made for this identity.</p>', ], ], 'TimestampList' => [ 'base' => NULL, 'refs' => [ 'MetricDataResult$Timestamps' => '<p>A list of timestamps for the metric data results.</p>', ], ], 'TlsPolicy' => [ 'base' => '<p>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.</p>', 'refs' => [ 'DeliveryOptions$TlsPolicy' => '<p>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.</p>', 'PutConfigurationSetDeliveryOptionsRequest$TlsPolicy' => '<p>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.</p>', ], ], 'TooManyRequestsException' => [ 'base' => '<p>Too many requests have been made to the operation.</p>', 'refs' => [], ], 'Topic' => [ 'base' => '<p>An interest group, theme, or label within a list. Lists can have multiple topics.</p>', 'refs' => [ 'Topics$member' => NULL, ], ], 'TopicFilter' => [ 'base' => '<p>Used for filtering by a specific topic preference.</p>', 'refs' => [ 'ListContactsFilter$TopicFilter' => '<p>Used for filtering by a specific topic preference.</p>', ], ], 'TopicName' => [ 'base' => NULL, 'refs' => [ 'ListManagementOptions$TopicName' => '<p>The name of the topic.</p>', 'Topic$TopicName' => '<p>The name of the topic.</p>', 'TopicFilter$TopicName' => '<p>The name of a topic on which you wish to apply the filter.</p>', 'TopicPreference$TopicName' => '<p>The name of the topic.</p>', ], ], 'TopicPreference' => [ 'base' => '<p>The contact\'s preference for being opted-in to or opted-out of a topic.</p>', 'refs' => [ 'TopicPreferenceList$member' => NULL, ], ], 'TopicPreferenceList' => [ 'base' => NULL, 'refs' => [ 'Contact$TopicPreferences' => '<p>The contact\'s preference for being opted-in to or opted-out of a topic.</p>', 'Contact$TopicDefaultPreferences' => '<p>The default topic preferences applied to the contact.</p>', 'CreateContactRequest$TopicPreferences' => '<p>The contact\'s preferences for being opted-in to or opted-out of topics.</p>', 'GetContactResponse$TopicPreferences' => '<p>The contact\'s preference for being opted-in to or opted-out of a topic.&gt;</p>', 'GetContactResponse$TopicDefaultPreferences' => '<p>The default topic preferences applied to the contact.</p>', 'UpdateContactRequest$TopicPreferences' => '<p>The contact\'s preference for being opted-in to or opted-out of a topic.</p>', ], ], 'Topics' => [ 'base' => NULL, 'refs' => [ 'CreateContactListRequest$Topics' => '<p>An interest group, theme, or label within a list. A contact list can have multiple topics.</p>', 'GetContactListResponse$Topics' => '<p>An interest group, theme, or label within a list. A contact list can have multiple topics.</p>', 'UpdateContactListRequest$Topics' => '<p>An interest group, theme, or label within a list. A contact list can have multiple topics.</p>', ], ], 'TrackingOptions' => [ 'base' => '<p>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.</p> <p>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.</p>', 'refs' => [ 'CreateConfigurationSetRequest$TrackingOptions' => '<p>An object that defines the open and click tracking options for emails that you send using the configuration set.</p>', 'GetConfigurationSetResponse$TrackingOptions' => '<p>An object that defines the open and click tracking options for emails that you send using the configuration set.</p>', ], ], 'UnsubscribeAll' => [ 'base' => NULL, 'refs' => [ 'Contact$UnsubscribeAll' => '<p>A boolean value status noting if the contact is unsubscribed from all contact list topics.</p>', 'CreateContactRequest$UnsubscribeAll' => '<p>A boolean value status noting if the contact is unsubscribed from all contact list topics.</p>', 'GetContactResponse$UnsubscribeAll' => '<p>A boolean value status noting if the contact is unsubscribed from all contact list topics.</p>', 'UpdateContactRequest$UnsubscribeAll' => '<p>A boolean value status noting if the contact is unsubscribed from all contact list topics.</p>', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConfigurationSetEventDestinationRequest' => [ 'base' => '<p>A request to change the settings for an event destination for a configuration set.</p>', 'refs' => [], ], 'UpdateConfigurationSetEventDestinationResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'UpdateContactListRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContactListResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContactRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContactResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCustomVerificationEmailTemplateRequest' => [ 'base' => '<p>Represents a request to update an existing custom verification email template.</p>', 'refs' => [], ], 'UpdateCustomVerificationEmailTemplateResponse' => [ 'base' => '<p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>', 'refs' => [], ], 'UpdateEmailIdentityPolicyRequest' => [ 'base' => '<p>Represents a request to update a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html">Amazon SES Developer Guide</a>.</p>', 'refs' => [], ], 'UpdateEmailIdentityPolicyResponse' => [ 'base' => '<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>', 'refs' => [], ], 'UpdateEmailTemplateRequest' => [ 'base' => '<p>Represents a request to update an email template. For more information, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html">Amazon SES Developer Guide</a>.</p>', 'refs' => [], ], 'UpdateEmailTemplateResponse' => [ 'base' => '<p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>', 'refs' => [], ], 'UpdateReputationEntityCustomerManagedStatusRequest' => [ 'base' => '<p>Represents a request to update the customer-managed sending status for a reputation entity.</p>', 'refs' => [], ], 'UpdateReputationEntityCustomerManagedStatusResponse' => [ 'base' => '<p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>', 'refs' => [], ], 'UpdateReputationEntityPolicyRequest' => [ 'base' => '<p>Represents a request to update the reputation management policy for a reputation entity.</p>', 'refs' => [], ], 'UpdateReputationEntityPolicyResponse' => [ 'base' => '<p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>', 'refs' => [], ], 'UseCaseDescription' => [ 'base' => NULL, 'refs' => [ 'AccountDetails$UseCaseDescription' => '<p>A description of the types of email that you plan to send.</p>', 'PutAccountDetailsRequest$UseCaseDescription' => '<p>A description of the types of email that you plan to send.</p>', ], ], 'UseDefaultIfPreferenceUnavailable' => [ 'base' => NULL, 'refs' => [ 'TopicFilter$UseDefaultIfPreferenceUnavailable' => '<p>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.</p>', ], ], 'VdmAttributes' => [ 'base' => '<p>The VDM attributes that apply to your Amazon SES account.</p>', 'refs' => [ 'GetAccountResponse$VdmAttributes' => '<p>The VDM attributes that apply to your Amazon SES account.</p>', 'PutAccountVdmAttributesRequest$VdmAttributes' => '<p>The VDM attributes that you wish to apply to your Amazon SES account.</p>', ], ], 'VdmOptions' => [ 'base' => '<p>An object that defines the VDM settings that apply to emails that you send using the configuration set.</p>', 'refs' => [ 'CreateConfigurationSetRequest$VdmOptions' => '<p>An object that defines the VDM options for emails that you send using the configuration set.</p>', 'GetConfigurationSetResponse$VdmOptions' => '<p>An object that contains information about the VDM preferences for your configuration set.</p>', 'PutConfigurationSetVdmOptionsRequest$VdmOptions' => '<p>The VDM options to apply to the configuration set.</p>', ], ], 'VerificationError' => [ 'base' => NULL, 'refs' => [ 'VerificationInfo$ErrorType' => '<p>Provides the reason for the failure describing why Amazon SES was not able to successfully verify the identity. Below are the possible values: </p> <ul> <li> <p> <code>INVALID_VALUE</code> – Amazon SES was able to find the record, but the value contained within the record was invalid. Ensure you have published the correct values for the record.</p> </li> <li> <p> <code>TYPE_NOT_FOUND</code> – The queried hostname exists but does not have the requested type of DNS record. Ensure that you have published the correct type of DNS record.</p> </li> <li> <p> <code>HOST_NOT_FOUND</code> – The queried hostname does not exist or was not reachable at the time of the request. Ensure that you have published the required DNS record(s). </p> </li> <li> <p> <code>SERVICE_ERROR</code> – A temporary issue is preventing Amazon SES from determining the verification status of the domain.</p> </li> <li> <p> <code>DNS_SERVER_ERROR</code> – The DNS server encountered an issue and was unable to complete the request.</p> </li> <li> <p> <code>REPLICATION_ACCESS_DENIED</code> – The verification failed because the user does not have the required permissions to replicate the DKIM key from the primary region. Ensure you have the necessary permissions in both primary and replica regions. </p> </li> <li> <p> <code>REPLICATION_PRIMARY_NOT_FOUND</code> – The verification failed because no corresponding identity was found in the specified primary region. Ensure the identity exists in the primary region before attempting replication. </p> </li> <li> <p> <code>REPLICATION_PRIMARY_BYO_DKIM_NOT_SUPPORTED</code> – The verification failed because the identity in the primary region is configured with Bring Your Own DKIM (BYODKIM). DKIM key replication is only supported for identities using Easy DKIM. </p> </li> <li> <p> <code>REPLICATION_REPLICA_AS_PRIMARY_NOT_SUPPORTED</code> – The verification failed because the specified primary identity is a replica of another identity, and multi-level replication is not supported; the primary identity must be a non-replica identity. </p> </li> <li> <p> <code>REPLICATION_PRIMARY_INVALID_REGION</code> – The verification failed due to an invalid primary region specified. Ensure you provide a valid Amazon Web Services region where Amazon SES is available and different from the replica region. </p> </li> </ul>', ], ], 'VerificationInfo' => [ 'base' => '<p>An object that contains additional information about the verification status for the identity.</p>', 'refs' => [ 'GetEmailIdentityResponse$VerificationInfo' => '<p>An object that contains additional information about the verification status for the identity.</p>', ], ], 'VerificationStatus' => [ 'base' => NULL, 'refs' => [ 'GetEmailIdentityResponse$VerificationStatus' => '<p>The verification status of the identity. The status can be one of the following:</p> <ul> <li> <p> <code>PENDING</code> – The verification process was initiated, but Amazon SES hasn\'t yet been able to verify the identity.</p> </li> <li> <p> <code>SUCCESS</code> – The verification process completed successfully.</p> </li> <li> <p> <code>FAILED</code> – The verification process failed.</p> </li> <li> <p> <code>TEMPORARY_FAILURE</code> – A temporary issue is preventing Amazon SES from determining the verification status of the identity.</p> </li> <li> <p> <code>NOT_STARTED</code> – The verification process hasn\'t been initiated for the identity.</p> </li> </ul>', 'IdentityInfo$VerificationStatus' => '<p>The verification status of the identity. The status can be one of the following:</p> <ul> <li> <p> <code>PENDING</code> – The verification process was initiated, but Amazon SES hasn\'t yet been able to verify the identity.</p> </li> <li> <p> <code>SUCCESS</code> – The verification process completed successfully.</p> </li> <li> <p> <code>FAILED</code> – The verification process failed.</p> </li> <li> <p> <code>TEMPORARY_FAILURE</code> – A temporary issue is preventing Amazon SES from determining the verification status of the identity.</p> </li> <li> <p> <code>NOT_STARTED</code> – The verification process hasn\'t been initiated for the identity.</p> </li> </ul>', ], ], 'Volume' => [ 'base' => '<p>An object that contains information about inbox placement volume.</p>', 'refs' => [ 'DomainDeliverabilityCampaign$InboxCount' => '<p>The number of email messages that were delivered to recipients’ inboxes.</p>', 'DomainDeliverabilityCampaign$SpamCount' => '<p>The number of email messages that were delivered to recipients\' spam or junk mail folders.</p>', 'DomainDeliverabilityCampaign$ProjectedVolume' => '<p>The projected number of recipients that the email message was sent to.</p>', 'DomainIspPlacement$InboxRawCount' => '<p>The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients\' inboxes.</p>', 'DomainIspPlacement$SpamRawCount' => '<p>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.</p>', 'VolumeStatistics$InboxRawCount' => '<p>The total number of emails that arrived in recipients\' inboxes.</p>', 'VolumeStatistics$SpamRawCount' => '<p>The total number of emails that arrived in recipients\' spam or junk mail folders.</p>', 'VolumeStatistics$ProjectedInbox' => '<p>An estimate of the percentage of emails sent from the current domain that will arrive in recipients\' inboxes.</p>', 'VolumeStatistics$ProjectedSpam' => '<p>An estimate of the percentage of emails sent from the current domain that will arrive in recipients\' spam or junk mail folders.</p>', ], ], 'VolumeStatistics' => [ 'base' => '<p>An object that contains information about the amount of email that was delivered to recipients.</p>', 'refs' => [ 'DailyVolume$VolumeStatistics' => '<p>An object that contains inbox placement metrics for a specific day in the analysis period.</p>', 'OverallVolume$VolumeStatistics' => '<p>An object that contains information about the numbers of messages that arrived in recipients\' inboxes and junk mail folders.</p>', ], ], 'WarmupStatus' => [ 'base' => '<p>The warmup status of a dedicated IP.</p>', 'refs' => [ 'DedicatedIp$WarmupStatus' => '<p>The warm-up status of a dedicated IP address. The status can have one of the following values:</p> <ul> <li> <p> <code>IN_PROGRESS</code> – The IP address isn\'t ready to use because the dedicated IP warm-up process is ongoing.</p> </li> <li> <p> <code>DONE</code> – The dedicated IP warm-up process is complete, and the IP address is ready to use.</p> </li> <li> <p> <code>NOT_APPLICABLE</code> – The warm-up status doesn\'t apply to this IP address. This status is used for IP addresses in managed dedicated IP pools, where Amazon SES automatically handles the warm-up process.</p> </li> </ul>', ], ], 'WebsiteURL' => [ 'base' => NULL, 'refs' => [ 'AccountDetails$WebsiteURL' => '<p>The URL of your website. This information helps us better understand the type of content that you plan to send.</p>', 'PutAccountDetailsRequest$WebsiteURL' => '<p>The URL of your website. This information helps us better understand the type of content that you plan to send.</p>', ], ], ],];
