This document contains reference information for the Amazon Pinpoint Email API, version 1.0. This document is best used in conjunction with the Amazon Pinpoint Developer Guide.
The Amazon Pinpoint API is available in the US East (N. Virginia) Region at the following endpoint: email.us-east-1.amazonaws.com
Create a configuration set. Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. 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.
", "CreateConfigurationSetEventDestination": "Create an event destination. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
A single configuration set can include more than one event destination.
", "CreateDedicatedIpPool": "Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Pinpoint account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, Amazon Pinpoint sends it using only the IP addresses in the associated pool.
", "CreateEmailIdentity": "Verifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is an email address or domain that you use when you send email. Before you can use an identity to send email with Amazon Pinpoint, you first have to verify it. By verifying an address, you demonstrate that you're the owner of the address, and that you've given Amazon Pinpoint permission to send email from the address.
When you verify an email address, Amazon Pinpoint sends an email to the address. Your email address is verified as soon as you follow the link in the verification email.
When you verify a domain, 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 Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.
", "DeleteConfigurationSet": "Delete an existing configuration set.
In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
", "DeleteConfigurationSetEventDestination": "Delete an event destination.
In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
", "DeleteDedicatedIpPool": "Delete a dedicated IP pool.
", "DeleteEmailIdentity": "Deletes an email identity that you previously verified for use with Amazon Pinpoint. An identity can be either an email address or a domain name.
", "GetAccount": "Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.
", "GetConfigurationSet": "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.
In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
", "GetConfigurationSetEventDestinations": "Retrieve a list of event destinations that are associated with a configuration set.
In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
", "GetDedicatedIp": "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.
", "GetDedicatedIps": "List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
", "GetEmailIdentity": "Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.
", "ListConfigurationSets": "List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
", "ListDedicatedIpPools": "List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.
", "ListEmailIdentities": "Returns a list of all of the email identities that are associated with your Amazon Pinpoint 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.
", "PutAccountDedicatedIpWarmupAttributes": "Enable or disable the automatic warm-up feature for dedicated IP addresses.
", "PutAccountSendingAttributes": "Enable or disable the ability of your account to send email.
", "PutConfigurationSetDeliveryOptions": "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.
", "PutConfigurationSetReputationOptions": "Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.
", "PutConfigurationSetSendingOptions": "Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
", "PutConfigurationSetTrackingOptions": "Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.
", "PutDedicatedIpInPool": "Move a dedicated IP address to an existing dedicated IP pool.
The dedicated IP address that you specify must already exist, and must be associated with your Amazon Pinpoint account.
The dedicated IP pool you specify must already exist. You can create a new pool by using the CreateDedicatedIpPool operation.
Used to enable or disable DKIM authentication for an email identity.
", "PutEmailIdentityFeedbackAttributes": "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.
When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.
When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. 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, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).
", "PutEmailIdentityMailFromAttributes": "Used to enable or disable the custom Mail-From domain configuration for an email identity.
", "SendEmail": "Sends an email message. You can use the Amazon Pinpoint Email API to send two types of messages:
Simple – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon Pinpoint assembles the message for you.
Raw – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message.
Update the configuration of an event destination for a configuration set.
In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
" }, "shapes": { "AccountSuspendedException": { "base": "The message can't be sent because the account's ability to send email has been permanently restricted.
", "refs": { } }, "AlreadyExistsException": { "base": "The resource specified in your request already exists.
", "refs": { } }, "AmazonResourceName": { "base": null, "refs": { "KinesisFirehoseDestination$IamRoleArn": "The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email events to the Amazon Kinesis Data Firehose stream.
", "KinesisFirehoseDestination$DeliveryStreamArn": "The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events to.
", "PinpointDestination$ApplicationArn": "The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email events to.
", "SnsDestination$TopicArn": "The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
" } }, "BadRequestException": { "base": "The input you provided is invalid.
", "refs": { } }, "BehaviorOnMxFailure": { "base": "The action that you want Amazon Pinpoint to take if it can't read the required MX record for a custom MAIL FROM domain. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.
These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states.
The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.
These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states.
The action that you want Amazon Pinpoint to take if it can't read the required MX record when you send an email. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.
These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states.
Represents the body of the email message.
", "refs": { "Message$Body": "The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both.
" } }, "Charset": { "base": null, "refs": { "Content$Charset": "The character set for the content. Because of the constraints of the SMTP protocol, Amazon Pinpoint uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8, ISO-8859-1, or Shift_JIS.
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.
", "refs": { "EventDestination$CloudWatchDestination": "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.
", "EventDestinationDefinition$CloudWatchDestination": "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.
" } }, "CloudWatchDimensionConfiguration": { "base": "An object that defines the dimension configuration to use when you send Amazon Pinpoint email events to Amazon CloudWatch.
", "refs": { "CloudWatchDimensionConfigurations$member": null } }, "CloudWatchDimensionConfigurations": { "base": null, "refs": { "CloudWatchDestination$DimensionConfigurations": "An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.
" } }, "ConfigurationSetName": { "base": "The name of a configuration set.
In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
", "refs": { "ConfigurationSetNameList$member": null, "CreateConfigurationSetEventDestinationRequest$ConfigurationSetName": "The name of the configuration set that you want to add an event destination to.
", "CreateConfigurationSetRequest$ConfigurationSetName": "The name of the configuration set.
", "DeleteConfigurationSetEventDestinationRequest$ConfigurationSetName": "The name of the configuration set that contains the event destination that you want to delete.
", "DeleteConfigurationSetRequest$ConfigurationSetName": "The name of the configuration set that you want to delete.
", "GetConfigurationSetEventDestinationsRequest$ConfigurationSetName": "The name of the configuration set that contains the event destination.
", "GetConfigurationSetRequest$ConfigurationSetName": "The name of the configuration set that you want to obtain more information about.
", "GetConfigurationSetResponse$ConfigurationSetName": "The name of the configuration set.
", "PutConfigurationSetDeliveryOptionsRequest$ConfigurationSetName": "The name of the configuration set that you want to associate with a dedicated IP pool.
", "PutConfigurationSetReputationOptionsRequest$ConfigurationSetName": "The name of the configuration set that you want to enable or disable reputation metric tracking for.
", "PutConfigurationSetSendingOptionsRequest$ConfigurationSetName": "The name of the configuration set that you want to enable or disable email sending for.
", "PutConfigurationSetTrackingOptionsRequest$ConfigurationSetName": "The name of the configuration set that you want to add a custom tracking domain to.
", "SendEmailRequest$ConfigurationSetName": "The name of the configuration set that you want to use when sending the email.
", "UpdateConfigurationSetEventDestinationRequest$ConfigurationSetName": "The name of the configuration set that contains the event destination that you want to modify.
" } }, "ConfigurationSetNameList": { "base": null, "refs": { "ListConfigurationSetsResponse$ConfigurationSets": "An array that contains all of the configuration sets in your Amazon Pinpoint account in the current AWS Region.
" } }, "Content": { "base": "An object that represents the content of the email, and optionally a character set specification.
", "refs": { "Body$Text": "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.
", "Body$Html": "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.
", "Message$Subject": "The subject line of the email. The subject line can only contain 7-bit ASCII characters. However, you can specify non-ASCII characters in the subject line by using encoded-word syntax, as described in RFC 2047.
" } }, "CreateConfigurationSetEventDestinationRequest": { "base": "A request to add an event destination to a configuration set.
", "refs": { } }, "CreateConfigurationSetEventDestinationResponse": { "base": "An HTTP 200 response if the request succeeds, or an error message if the request fails.
", "refs": { } }, "CreateConfigurationSetRequest": { "base": "A request to create a configuration set.
", "refs": { } }, "CreateConfigurationSetResponse": { "base": "An HTTP 200 response if the request succeeds, or an error message if the request fails.
", "refs": { } }, "CreateDedicatedIpPoolRequest": { "base": "A request to create a new dedicated IP pool.
", "refs": { } }, "CreateDedicatedIpPoolResponse": { "base": "An HTTP 200 response if the request succeeds, or an error message if the request fails.
", "refs": { } }, "CreateEmailIdentityRequest": { "base": "A request to begin the verification process for an email identity (an email address or domain).
", "refs": { } }, "CreateEmailIdentityResponse": { "base": "If the email identity is a domain, this object contains tokens that you can use to create a set of CNAME records. To sucessfully verify your domain, you have to add these records to the DNS configuration for your domain.
If the email identity is an email address, this object is empty.
", "refs": { } }, "CustomRedirectDomain": { "base": "The domain that you want to use for tracking open and click events.
", "refs": { "PutConfigurationSetTrackingOptionsRequest$CustomRedirectDomain": "The domain that you want to use to track open and click events.
", "TrackingOptions$CustomRedirectDomain": "The domain that you want to use for tracking open and click events.
" } }, "DedicatedIp": { "base": "Contains information about a dedicated IP address that is associated with your Amazon Pinpoint account.
", "refs": { "DedicatedIpList$member": null, "GetDedicatedIpResponse$DedicatedIp": "An object that contains information about a dedicated IP address.
" } }, "DedicatedIpList": { "base": "A list of dedicated IP addresses that are associated with your Amazon Pinpoint account.
", "refs": { "GetDedicatedIpsResponse$DedicatedIps": "A list of dedicated IP addresses that are reserved for use by your Amazon Pinpoint account.
" } }, "DefaultDimensionValue": { "base": "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:
It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
It can contain no more than 256 characters.
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:
It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
It can contain no more than 256 characters.
A request to delete an event destination from a configuration set.
", "refs": { } }, "DeleteConfigurationSetEventDestinationResponse": { "base": "An HTTP 200 response if the request succeeds, or an error message if the request fails.
", "refs": { } }, "DeleteConfigurationSetRequest": { "base": "A request to delete a configuration set.
", "refs": { } }, "DeleteConfigurationSetResponse": { "base": "An HTTP 200 response if the request succeeds, or an error message if the request fails.
", "refs": { } }, "DeleteDedicatedIpPoolRequest": { "base": "A request to delete a dedicated IP pool.
", "refs": { } }, "DeleteDedicatedIpPoolResponse": { "base": "An HTTP 200 response if the request succeeds, or an error message if the request fails.
", "refs": { } }, "DeleteEmailIdentityRequest": { "base": "A request to delete an existing email identity. When you delete an identity, you lose the ability to use Amazon Pinpoint to send email from that identity. You can restore your ability to send email by completing the verification process for the identity again.
", "refs": { } }, "DeleteEmailIdentityResponse": { "base": "An HTTP 200 response if the request succeeds, or an error message if the request fails.
", "refs": { } }, "DeliveryOptions": { "base": "Used to associate a configuration set with a dedicated IP pool.
", "refs": { "CreateConfigurationSetRequest$DeliveryOptions": "An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
", "GetConfigurationSetResponse$DeliveryOptions": "An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
" } }, "Destination": { "base": "An object that describes the recipients for an email.
", "refs": { "SendEmailRequest$Destination": "An object that contains the recipients of the email message.
" } }, "DimensionName": { "base": "The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:
It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
It can contain no more than 256 characters.
The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:
It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
It can contain no more than 256 characters.
The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon Pinpoint to use your own email headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags.
The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon Pinpoint to use your own email headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags.
An object that contains information about the DKIM configuration for an email identity.
", "refs": { "CreateEmailIdentityResponse$DkimAttributes": "An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.
", "GetEmailIdentityResponse$DkimAttributes": "An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.
" } }, "DkimStatus": { "base": "The DKIM authentication status of the identity. The status can be one of the following:
PENDING – The DKIM verification process was initiated, and Amazon Pinpoint is still waiting for the required CNAME records to appear in the DNS configuration for the domain.
SUCCESS – The DKIM authentication process completed successfully.
FAILED – The DKIM authentication process failed. This can happen when Amazon Pinpoint fails to find the required CNAME records in the DNS configuration of the domain.
TEMPORARY_FAILURE – A temporary issue is preventing Amazon Pinpoint from determining the DKIM authentication status of the domain.
NOT_STARTED – The DKIM verification process hasn't been initiated for the domain.
Describes whether or not Amazon Pinpoint has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:
PENDING – Amazon Pinpoint hasn't yet located the DKIM records in the DNS configuration for the domain, but will continue to attempt to locate them.
SUCCESS – Amazon Pinpoint located the DKIM records in the DNS configuration for the domain and determined that they're correct. Amazon Pinpoint can now send DKIM-signed email from the identity.
FAILED – Amazon Pinpoint was unable to locate the DKIM records in the DNS settings for the domain, and won't continue to search for them.
TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the DKIM status for the domain.
NOT_STARTED – Amazon Pinpoint hasn't yet started searching for the DKIM records in the DKIM records for the domain.
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 Pinpoint detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. Amazon Pinpoint usually detects these records within about 72 hours of adding them to the DNS configuration for your domain.
" } }, "EmailAddress": { "base": null, "refs": { "EmailAddressList$member": null, "SendEmailRequest$FromEmailAddress": "The email address that you want to use as the \"From\" address for the email. The address that you specify has to be verified.
", "SendEmailRequest$FeedbackForwardingEmailAddress": "The address that Amazon Pinpoint should send bounce and complaint notifications to.
" } }, "EmailAddressList": { "base": null, "refs": { "Destination$ToAddresses": "An array that contains the email addresses of the \"To\" recipients for the email.
", "Destination$CcAddresses": "An array that contains the email addresses of the \"CC\" (carbon copy) recipients for the email.
", "Destination$BccAddresses": "An array that contains the email addresses of the \"BCC\" (blind carbon copy) recipients for the email.
", "SendEmailRequest$ReplyToAddresses": "The \"Reply-to\" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.
" } }, "EmailContent": { "base": "An object that defines the entire content of the email, including the message headers and the body content. You can create a simple email message, in which you specify the subject and the text and HTML versions of the message body. You can also create raw messages, in which you specify a complete MIME-formatted message. Raw messages can include attachments and custom headers.
", "refs": { "SendEmailRequest$Content": "An object that contains the body of the message. You can send either a Simple message or a Raw message.
" } }, "Enabled": { "base": null, "refs": { "CreateEmailIdentityResponse$VerifiedForSendingStatus": "Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.
", "DkimAttributes$SigningEnabled": "If the value is true, then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. If the value is false, then the messages that Amazon Pinpoint sends from the identity aren't DKIM-signed.
If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition.
If false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.
If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition.
If false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.
Indicates whether or not email sending is enabled for your Amazon Pinpoint account in the current AWS Region.
", "GetAccountResponse$DedicatedIpAutoWarmupEnabled": "Indicates whether or not the automatic warm-up feature is enabled for dedicated IP addresses that are associated with your account.
", "GetAccountResponse$ProductionAccessEnabled": "Indicates whether or not your account has production access in the current AWS Region.
If the value is false, then your account is in the sandbox. When your account is in the sandbox, you can only send email to verified identities. Additionally, the maximum number of emails you can send in a 24-hour period (your sending quota) is 200, and the maximum number of emails you can send per second (your maximum sending rate) is 1.
If the value is true, then your account has production access. When your account has production access, you can send email to any address. The sending quota and maximum sending rate for your account vary based on your specific use case.
The feedback forwarding configuration for the identity.
If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.
When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. 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, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).
Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.
", "IdentityInfo$SendingEnabled": "Indicates whether or not you can send email from the identity.
In Amazon Pinpoint, an identity is an email address or domain that you send email from. Before you can send email from an identity, you have to demostrate that you own the identity, and that you authorize Amazon Pinpoint to send email from that identity.
", "PutAccountDedicatedIpWarmupAttributesRequest$AutoWarmupEnabled": "Enables or disables the automatic warm-up feature for dedicated IP addresses that are associated with your Amazon Pinpoint account in the current AWS Region. Set to true to enable the automatic warm-up feature, or set to false to disable it.
Enables or disables your account's ability to send email. Set to true to enable email sending, or set to false to disable email sending.
If AWS paused your account's ability to send email, you can't use this operation to resume your account's ability to send email.
If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.
If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.
Sets the DKIM signing configuration for the identity.
When you set this value true, then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. When you set this value to false, then the messages that Amazon Pinpoint sends from the identity aren't DKIM-signed.
Sets the feedback forwarding configuration for the identity.
If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.
When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. 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, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).
If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.
If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.
In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
", "refs": { "EventDestinations$member": null } }, "EventDestinationDefinition": { "base": "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.
", "refs": { "CreateConfigurationSetEventDestinationRequest$EventDestination": "An object that defines the event destination.
", "UpdateConfigurationSetEventDestinationRequest$EventDestination": "An object that defines the event destination.
" } }, "EventDestinationName": { "base": "The name of an event destination.
In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
", "refs": { "CreateConfigurationSetEventDestinationRequest$EventDestinationName": "A name that identifies the event destination within the configuration set.
", "DeleteConfigurationSetEventDestinationRequest$EventDestinationName": "The name of the event destination that you want to delete.
", "EventDestination$Name": "A name that identifies the event destination.
", "UpdateConfigurationSetEventDestinationRequest$EventDestinationName": "The name of the event destination that you want to modify.
" } }, "EventDestinations": { "base": null, "refs": { "GetConfigurationSetEventDestinationsResponse$EventDestinations": "An array that includes all of the events destinations that have been configured for the configuration set.
" } }, "EventType": { "base": "An email sending event type. For example, email sends, opens, and bounces are all email events.
", "refs": { "EventTypes$member": null } }, "EventTypes": { "base": null, "refs": { "EventDestination$MatchingEventTypes": "The types of events that Amazon Pinpoint sends to the specified event destinations.
", "EventDestinationDefinition$MatchingEventTypes": "An array that specifies which events Amazon Pinpoint should send to the destinations in this EventDestinationDefinition.
The reputation status of your Amazon Pinpoint account. The status can be one of the following:
HEALTHY – There are no reputation-related issues that currently impact your account.
PROBATION – We've identified some issues with your Amazon Pinpoint account. We're placing your account under review while you work on correcting these issues.
SHUTDOWN – 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.
A request to obtain information about the email-sending capabilities of your Amazon Pinpoint account.
", "refs": { } }, "GetAccountResponse": { "base": "A list of details about the email-sending capabilities of your Amazon Pinpoint account in the current AWS Region.
", "refs": { } }, "GetConfigurationSetEventDestinationsRequest": { "base": "A request to obtain information about the event destinations for a configuration set.
", "refs": { } }, "GetConfigurationSetEventDestinationsResponse": { "base": "Information about an event destination for a configuration set.
", "refs": { } }, "GetConfigurationSetRequest": { "base": "A request to obtain information about a configuration set.
", "refs": { } }, "GetConfigurationSetResponse": { "base": "Information about a configuration set.
", "refs": { } }, "GetDedicatedIpRequest": { "base": "A request to obtain more information about a dedicated IP address.
", "refs": { } }, "GetDedicatedIpResponse": { "base": "Information about a dedicated IP address.
", "refs": { } }, "GetDedicatedIpsRequest": { "base": "A request to obtain more information about dedicated IP pools.
", "refs": { } }, "GetDedicatedIpsResponse": { "base": "Information about the dedicated IP addresses that are associated with your Amazon Pinpoint account.
", "refs": { } }, "GetEmailIdentityRequest": { "base": "A request to return details about an email identity.
", "refs": { } }, "GetEmailIdentityResponse": { "base": "Details about an email identity.
", "refs": { } }, "Identity": { "base": null, "refs": { "CreateEmailIdentityRequest$EmailIdentity": "The email address or domain that you want to verify.
", "DeleteEmailIdentityRequest$EmailIdentity": "The identity (that is, the email address or domain) that you want to delete from your Amazon Pinpoint account.
", "GetEmailIdentityRequest$EmailIdentity": "The email identity that you want to retrieve details for.
", "IdentityInfo$IdentityName": "The address or domain of the identity.
", "PutEmailIdentityDkimAttributesRequest$EmailIdentity": "The email identity that you want to change the DKIM settings for.
", "PutEmailIdentityFeedbackAttributesRequest$EmailIdentity": "The email identity that you want to configure bounce and complaint feedback forwarding for.
", "PutEmailIdentityMailFromAttributesRequest$EmailIdentity": "The verified email identity that you want to set up the custom MAIL FROM domain for.
" } }, "IdentityInfo": { "base": "Information about an email identity.
", "refs": { "IdentityInfoList$member": null } }, "IdentityInfoList": { "base": null, "refs": { "ListEmailIdentitiesResponse$EmailIdentities": "An array that includes all of the identities associated with your Amazon Pinpoint account.
" } }, "IdentityType": { "base": "The email identity type. The identity type can be one of the following:
EMAIL_ADDRESS – The identity is an email address.
DOMAIN – The identity is a domain.
The email identity type.
", "GetEmailIdentityResponse$IdentityType": "The email identity type.
", "IdentityInfo$IdentityType": "The email identity type. The identity type can be one of the following:
EMAIL_ADDRESS – The identity is an email address.
DOMAIN – The identity is a domain.
MANAGED_DOMAIN – The identity is a domain that is managed by AWS.
A dedicated IP address that is associated with your Amazon Pinpoint account.
", "refs": { "DedicatedIp$Ip": "An IP address that is reserved for use by your Amazon Pinpoint account.
", "GetDedicatedIpRequest$Ip": "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 Pinpoint account.
", "PutDedicatedIpInPoolRequest$Ip": "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 Pinpoint account.
", "PutDedicatedIpWarmupAttributesRequest$Ip": "The dedicated IP address that you want to update the warm-up attributes for.
" } }, "KinesisFirehoseDestination": { "base": "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.
", "refs": { "EventDestination$KinesisFirehoseDestination": "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.
", "EventDestinationDefinition$KinesisFirehoseDestination": "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.
" } }, "LastFreshStart": { "base": "The date and 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.
", "refs": { "ReputationOptions$LastFreshStart": "The date and 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.
" } }, "LimitExceededException": { "base": "There are too many instances of the specified resource type.
", "refs": { } }, "ListConfigurationSetsRequest": { "base": "A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current AWS Region.
", "refs": { } }, "ListConfigurationSetsResponse": { "base": "A list of configuration sets in your Amazon Pinpoint account in the current AWS Region.
", "refs": { } }, "ListDedicatedIpPoolsRequest": { "base": "A request to obtain a list of dedicated IP pools.
", "refs": { } }, "ListDedicatedIpPoolsResponse": { "base": "A list of dedicated IP pools.
", "refs": { } }, "ListEmailIdentitiesRequest": { "base": "A request to list all of the email identities associated with your Amazon Pinpoint 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.
", "refs": { } }, "ListEmailIdentitiesResponse": { "base": "A list of all of the identities that you've attempted to verify for use with Amazon Pinpoint, regardless of whether or not those identities were successfully verified.
", "refs": { } }, "ListOfDedicatedIpPools": { "base": "A list of dedicated IP pools that are associated with your Amazon Pinpoint account.
", "refs": { "ListDedicatedIpPoolsResponse$DedicatedIpPools": "A list of all of the dedicated IP pools that are associated with your Amazon Pinpoint account.
" } }, "MailFromAttributes": { "base": "A list of attributes that are associated with a MAIL FROM domain.
", "refs": { "GetEmailIdentityResponse$MailFromAttributes": "An object that contains information about the Mail-From attributes for the email identity.
" } }, "MailFromDomainName": { "base": "The domain that you want to use as a MAIL FROM domain.
", "refs": { "MailFromAttributes$MailFromDomain": "The name of a domain that an email identity uses as a custom MAIL FROM domain.
", "PutEmailIdentityMailFromAttributesRequest$MailFromDomain": "The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria:
It has to be a subdomain of the verified identity.
It can't be used to receive email.
It can't be used in a \"From\" address if the MAIL FROM domain is a destination for feedback forwarding emails.
The message can't be sent because the sending domain isn't verified.
", "refs": { } }, "MailFromDomainStatus": { "base": "The status of the MAIL FROM domain. This status can have the following values:
PENDING – Amazon Pinpoint hasn't started searching for the MX record yet.
SUCCESS – Amazon Pinpoint detected the required MX record for the MAIL FROM domain.
FAILED – Amazon Pinpoint can't find the required MX record, or the record no longer exists.
TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the status of the MAIL FROM domain.
The status of the MAIL FROM domain. This status can have the following values:
PENDING – Amazon Pinpoint hasn't started searching for the MX record yet.
SUCCESS – Amazon Pinpoint detected the required MX record for the MAIL FROM domain.
FAILED – Amazon Pinpoint can't find the required MX record, or the record no longer exists.
TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the status of the MAIL FROM domain.
The maximum number of emails that you can send in the current AWS Region over a 24-hour period. This value is also called your sending quota.
" } }, "MaxItems": { "base": null, "refs": { "GetDedicatedIpsRequest$PageSize": "The number of results to show in a single call to GetDedicatedIpsRequest. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.
The number of results to show in a single call to ListConfigurationSets. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.
The number of results to show in a single call to ListDedicatedIpPools. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.
The number of results to show in a single call to ListEmailIdentities. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.
The value you specify has to be at least 0, and can be no more than 1000.
" } }, "MaxSendRate": { "base": null, "refs": { "SendQuota$MaxSendRate": "The maximum number of emails that you can send per second in the current AWS Region. This value is also called your maximum sending rate or your maximum TPS (transactions per second) rate.
" } }, "Message": { "base": "Represents the email message that you're sending. The Message object consists of a subject line and a message body.
The simple email message. The message consists of a subject and a message body.
" } }, "MessageData": { "base": null, "refs": { "Content$Data": "The content of the message itself.
" } }, "MessageRejected": { "base": "The message can't be sent because it contains invalid content.
", "refs": { } }, "MessageTag": { "base": "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.
", "refs": { "MessageTagList$member": null } }, "MessageTagList": { "base": "A list of message tags.
", "refs": { "SendEmailRequest$EmailTags": "A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
The name of the message tag. The message tag name has to meet the following criteria:
It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
It can contain no more than 256 characters.
The name of the message tag. The message tag name has to meet the following criteria:
It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
It can contain no more than 256 characters.
The value of the message tag. The message tag value has to meet the following criteria:
It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
It can contain no more than 256 characters.
The value of the message tag. The message tag value has to meet the following criteria:
It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
It can contain no more than 256 characters.
A token returned from a previous call to GetDedicatedIps to indicate the position of the dedicated IP pool in the list of IP pools.
A token that indicates that there are additional dedicated IP addresses to list. To view additional addresses, issue another request to GetDedicatedIps, passing this token in the NextToken parameter.
A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets.
A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListConfigurationSets, and pass this token in the NextToken parameter.
A token returned from a previous call to ListDedicatedIpPools to indicate the position in the list of dedicated IP pools.
A token that indicates that there are additional IP pools to list. To view additional IP pools, issue another request to ListDedicatedIpPools, passing this token in the NextToken parameter.
A token returned from a previous call to ListEmailIdentities to indicate the position in the list of identities.
A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListEmailIdentities, and pass this token in the NextToken parameter.
The resource you attempted to access doesn't exist.
", "refs": { } }, "OutboundMessageId": { "base": null, "refs": { "SendEmailResponse$MessageId": "A unique identifier for the message that is generated when Amazon Pinpoint accepts the message.
It is possible for Amazon Pinpoint to accept a message without sending it. This can happen when the message you're trying to send has an attachment doesn't pass a virus check, or when you send a templated email that contains invalid personalization content, for example.
Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.
", "PutDedicatedIpWarmupAttributesRequest$WarmupPercentage": "The warm-up percentage that you want to associate with the dedicated IP address.
" } }, "PinpointDestination": { "base": "An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.
", "refs": { "EventDestination$PinpointDestination": "An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.
", "EventDestinationDefinition$PinpointDestination": "An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.
" } }, "PoolName": { "base": "The name of a dedicated IP pool.
", "refs": { "CreateDedicatedIpPoolRequest$PoolName": "The name of the dedicated IP pool.
", "DedicatedIp$PoolName": "The name of the dedicated IP pool that the IP address is associated with.
", "DeleteDedicatedIpPoolRequest$PoolName": "The name of the dedicated IP pool that you want to delete.
", "DeliveryOptions$SendingPoolName": "The name of the dedicated IP pool that you want to associate with the configuration set.
", "GetDedicatedIpsRequest$PoolName": "The name of the IP pool that the dedicated IP address is associated with.
", "ListOfDedicatedIpPools$member": null, "PutDedicatedIpInPoolRequest$DestinationPoolName": "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.
" } }, "PutAccountDedicatedIpWarmupAttributesRequest": { "base": "A request to enable or disable the automatic IP address warm-up feature.
", "refs": { } }, "PutAccountDedicatedIpWarmupAttributesResponse": { "base": "An HTTP 200 response if the request succeeds, or an error message if the request fails.
", "refs": { } }, "PutAccountSendingAttributesRequest": { "base": "A request to change the ability of your account to send email.
", "refs": { } }, "PutAccountSendingAttributesResponse": { "base": "An HTTP 200 response if the request succeeds, or an error message if the request fails.
", "refs": { } }, "PutConfigurationSetDeliveryOptionsRequest": { "base": "A request to associate a configuration set with a dedicated IP pool.
", "refs": { } }, "PutConfigurationSetDeliveryOptionsResponse": { "base": "An HTTP 200 response if the request succeeds, or an error message if the request fails.
", "refs": { } }, "PutConfigurationSetReputationOptionsRequest": { "base": "A request to enable or disable tracking of reputation metrics for a configuration set.
", "refs": { } }, "PutConfigurationSetReputationOptionsResponse": { "base": "An HTTP 200 response if the request succeeds, or an error message if the request fails.
", "refs": { } }, "PutConfigurationSetSendingOptionsRequest": { "base": "A request to enable or disable the ability of Amazon Pinpoint to send emails that use a specific configuration set.
", "refs": { } }, "PutConfigurationSetSendingOptionsResponse": { "base": "An HTTP 200 response if the request succeeds, or an error message if the request fails.
", "refs": { } }, "PutConfigurationSetTrackingOptionsRequest": { "base": "A request to add a custom domain for tracking open and click events to a configuration set.
", "refs": { } }, "PutConfigurationSetTrackingOptionsResponse": { "base": "An HTTP 200 response if the request succeeds, or an error message if the request fails.
", "refs": { } }, "PutDedicatedIpInPoolRequest": { "base": "A request to move a dedicated IP address to a dedicated IP pool.
", "refs": { } }, "PutDedicatedIpInPoolResponse": { "base": null, "refs": { } }, "PutDedicatedIpWarmupAttributesRequest": { "base": "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.
", "refs": { } }, "PutDedicatedIpWarmupAttributesResponse": { "base": "An HTTP 200 response if the request succeeds, or an error message if the request fails.
", "refs": { } }, "PutEmailIdentityDkimAttributesRequest": { "base": "A request to enable or disable DKIM signing of email that you send from an email identity.
", "refs": { } }, "PutEmailIdentityDkimAttributesResponse": { "base": "An HTTP 200 response if the request succeeds, or an error message if the request fails.
", "refs": { } }, "PutEmailIdentityFeedbackAttributesRequest": { "base": "A request to set the attributes that control how bounce and complaint events are processed.
", "refs": { } }, "PutEmailIdentityFeedbackAttributesResponse": { "base": "An HTTP 200 response if the request succeeds, or an error message if the request fails.
", "refs": { } }, "PutEmailIdentityMailFromAttributesRequest": { "base": "A request to configure the custom MAIL FROM domain for a verified identity.
", "refs": { } }, "PutEmailIdentityMailFromAttributesResponse": { "base": "An HTTP 200 response if the request succeeds, or an error message if the request fails.
", "refs": { } }, "RawMessage": { "base": "The raw email message.
", "refs": { "EmailContent$Raw": "The raw email message. The message has to meet the following criteria:
The message has to contain a header and a body, separated by one blank line.
All of the required header fields must be present in the message.
Each part of a multipart MIME message must be formatted properly.
If you include attachments, they must be in a file format that Amazon Pinpoint supports.
The entire message must be Base64 encoded.
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.
The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.
The raw email message. The message has to meet the following criteria:
The message has to contain a header and a body, separated by one blank line.
All of the required header fields must be present in the message.
Each part of a multipart MIME message must be formatted properly.
Attachments must be in a file format that Amazon Pinpoint supports.
The entire message must be Base64 encoded.
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.
The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.
The raw email message. The message has to meet the following criteria:
The message has to contain a header and a body, separated by one blank line.
All of the required header fields must be present in the message.
Each part of a multipart MIME message must be formatted properly.
Attachments must be in a file format that Amazon Pinpoint supports.
The entire message must be Base64 encoded.
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.
The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.
Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region.
", "refs": { "CreateConfigurationSetRequest$ReputationOptions": "An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.
", "GetConfigurationSetResponse$ReputationOptions": "An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.
" } }, "SendEmailRequest": { "base": "A request to send an email message.
", "refs": { } }, "SendEmailResponse": { "base": "A unique message ID that you receive when Amazon Pinpoint accepts an email for sending.
", "refs": { } }, "SendQuota": { "base": "An object that contains information about the per-day and per-second sending limits for your Amazon Pinpoint account in the current AWS Region.
", "refs": { "GetAccountResponse$SendQuota": "An object that contains information about the per-day and per-second sending limits for your Amazon Pinpoint account in the current AWS Region.
" } }, "SendingOptions": { "base": "Used to enable or disable email sending for messages that use this configuration set in the current AWS Region.
", "refs": { "CreateConfigurationSetRequest$SendingOptions": "An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.
", "GetConfigurationSetResponse$SendingOptions": "An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.
" } }, "SendingPausedException": { "base": "The message can't be sent because the account's ability to send email is currently paused.
", "refs": { } }, "SendingPoolName": { "base": "The name of the dedicated IP pool that you want to associate with the configuration set.
", "refs": { "PutConfigurationSetDeliveryOptionsRequest$SendingPoolName": "The name of the dedicated IP pool that you want to associate with the configuration set.
" } }, "SentLast24Hours": { "base": null, "refs": { "SendQuota$SentLast24Hours": "The number of emails sent from your Amazon Pinpoint account in the current AWS Region over the past 24 hours.
" } }, "SnsDestination": { "base": "An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
", "refs": { "EventDestination$SnsDestination": "An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
", "EventDestinationDefinition$SnsDestination": "An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
" } }, "TooManyRequestsException": { "base": "Too many requests have been made to the operation.
", "refs": { } }, "TrackingOptions": { "base": "An object that defines the tracking options for a configuration set. When you use Amazon Pinpoint to send an email, it contains an invisible image that's used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them.
These images and links include references to a domain operated by AWS. You can optionally configure Amazon Pinpoint to use a domain that you operate for these images and links.
", "refs": { "CreateConfigurationSetRequest$TrackingOptions": "An object that defines the open and click tracking options for emails that you send using the configuration set.
", "GetConfigurationSetResponse$TrackingOptions": "An object that defines the open and click tracking options for emails that you send using the configuration set.
" } }, "UpdateConfigurationSetEventDestinationRequest": { "base": "A request to change the settings for an event destination for a configuration set.
", "refs": { } }, "UpdateConfigurationSetEventDestinationResponse": { "base": "An HTTP 200 response if the request succeeds, or an error message if the request fails.
", "refs": { } }, "WarmupStatus": { "base": "The warmup status of a dedicated IP.
", "refs": { "DedicatedIp$WarmupStatus": "The warm-up status of a dedicated IP address. The status can have one of the following values:
IN_PROGRESS – The IP address isn't ready to use because the dedicated IP warm-up process is ongoing.
DONE – The dedicated IP warm-up process is complete, and the IP address is ready to use.