aws sesv2110 CLI commands available for Amazon SES V2.
| Command | API Operation | Sample |
|---|---|---|
batch-get-metric-dataRetrieves batches of metric data collected based on your sending activity. You can execute this operation no more than 16 times per second, and with at most 160 queries from the batches per second (cumulative). | BatchGetMetricData | |
cancel-export-jobCancels an export job. | CancelExportJob | |
create-configuration-setCreate a configuration set. Configuration sets are groups of rules that you can apply to the emails that you send. You apply a configuration set to an email by specifying the name of the configuration set when you call the Amazon SES API v2. When you apply a configuration set to an email, all of the | CreateConfigurationSet | |
create-configuration-set-event-destinationCreate an event destination. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon EventBridge and associate a rule to send the event to the s | CreateConfigurationSetEventDestination | |
create-contactCreates a contact, which is an end-user who is receiving the email, and adds them to a contact list. | CreateContact | |
create-contact-listCreates a contact list. | CreateContactList | |
create-custom-verification-email-templateCreates a new custom verification email template. For more information about custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. | CreateCustomVerificationEmailTemplate | |
create-dedicated-ip-poolCreate 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 th | CreateDedicatedIpPool | |
create-deliverability-test-reportCreate 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 | CreateDeliverabilityTestReport | |
create-email-identityStarts the process of verifying an email identity. An identity is an email address or domain that you use when you send email. Before you can use an identity to send email, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the identity, and that you've g | CreateEmailIdentity | |
create-email-identity-policyCreates the specified sending authorization policy for the given identity (an email address or a domain). This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize ot | CreateEmailIdentityPolicy | |
create-email-templateCreates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. | CreateEmailTemplate | |
create-export-jobCreates an export job for a data source and destination. You can execute this operation no more than once per second. | CreateExportJob | |
create-import-jobCreates an import job for a data destination. | CreateImportJob | |
create-multi-region-endpointCreates a multi-region endpoint (global-endpoint). 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 t | CreateMultiRegionEndpoint | |
create-tenantCreate a tenant. Tenants 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 differ | CreateTenant | |
create-tenant-resource-associationAssociate a resource with a tenant. 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. A single resource can be associated with multiple tenants, allowing for | CreateTenantResourceAssociation | |
delete-configuration-setDelete an existing configuration set. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the | DeleteConfigurationSet | |
delete-configuration-set-event-destinationDelete an event destination. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon EventBridge and associate a rule to send the event to the | DeleteConfigurationSetEventDestination | |
delete-contactRemoves a contact from a contact list. | DeleteContact | |
delete-contact-listDeletes a contact list and all of the contacts on that list. | DeleteContactList | |
delete-custom-verification-email-templateDeletes an existing custom verification email template. For more information about custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. | DeleteCustomVerificationEmailTemplate | |
delete-dedicated-ip-poolDelete a dedicated IP pool. | DeleteDedicatedIpPool | |
delete-email-identityDeletes an email identity. An identity can be either an email address or a domain name. | DeleteEmailIdentity | |
delete-email-identity-policyDeletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist. This API is for the identity owner only. If you have not verified the identity, this API will return an er | DeleteEmailIdentityPolicy | |
delete-email-templateDeletes an email template. You can execute this operation no more than once per second. | DeleteEmailTemplate | |
delete-multi-region-endpointDeletes a multi-region endpoint (global-endpoint). Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is executed can be deleted. | DeleteMultiRegionEndpoint | |
delete-suppressed-destinationRemoves an email address from the suppression list for your account. | DeleteSuppressedDestination | |
delete-tenantDelete an existing tenant. When you delete a tenant, its associations with resources are removed, but the resources themselves are not deleted. | DeleteTenant | |
delete-tenant-resource-associationDelete an association between a tenant and a resource. 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 operati | DeleteTenantResourceAssociation | |
get-accountObtain information about the email-sending status and capabilities of your Amazon SES account in the current Amazon Web Services Region. | GetAccount | |
get-blacklist-reportsRetrieve a list of the blacklists that your dedicated IP addresses appear on. | GetBlacklistReports | |
get-configuration-setGet information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by inc | GetConfigurationSet | |
get-configuration-set-event-destinationsRetrieve a list of event destinations that are associated with a configuration set. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon Eve | GetConfigurationSetEventDestinations | |
get-contactReturns a contact from a contact list. | GetContact | |
get-contact-listReturns contact list metadata. It does not return any information about the contacts present in the list. | GetContactList | |
get-custom-verification-email-templateReturns the custom email verification template for the template name you specify. For more information about custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. | GetCustomVerificationEmailTemplate | |
get-dedicated-ipGet 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. | GetDedicatedIp | |
get-dedicated-ip-poolRetrieve information about the dedicated pool. | GetDedicatedIpPool | |
get-dedicated-ipsList the dedicated IP addresses that are associated with your Amazon Web Services account. | GetDedicatedIps | |
get-deliverability-dashboard-optionsRetrieve 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 pla | GetDeliverabilityDashboardOptions | |
get-deliverability-test-reportRetrieve the results of a predictive inbox placement test. | GetDeliverabilityTestReport | |
get-domain-deliverability-campaignRetrieve 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. | GetDomainDeliverabilityCampaign | |
get-domain-statistics-reportRetrieve inbox placement and engagement rates for the domains that you use to send email. | GetDomainStatisticsReport | |
get-email-address-insightsProvides validation insights about a specific email address, including syntax validation, DNS record checks, mailbox existence, and other deliverability factors. | GetEmailAddressInsights | |
get-email-identityProvides information about a specific identity, including the identity's verification status, sending authorization policies, its DKIM authentication status, and its custom Mail-From settings. | GetEmailIdentity | |
get-email-identity-policiesReturns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time. This API is for the identity owner only. If you have not verified t | GetEmailIdentityPolicies | |
get-email-templateDisplays the template object (which includes the subject line, HTML part and text part) for the template you specify. You can execute this operation no more than once per second. | GetEmailTemplate | |
get-export-jobProvides information about an export job. | GetExportJob | |
get-import-jobProvides information about an import job. | GetImportJob | |
get-message-insightsProvides information about a specific message, including the from address, the subject, the recipient address, email tags, as well as events associated with the message. You can execute this operation no more than once per second. | GetMessageInsights | |
get-multi-region-endpointDisplays the multi-region endpoint (global-endpoint) configuration. Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is executed can be displayed. | GetMultiRegionEndpoint | |
get-reputation-entityRetrieve 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. Reputation entities represent resources in your Amazon SES account that have reputation tracking | GetReputationEntity | |
get-suppressed-destinationRetrieves information about a specific email address that's on the suppression list for your account. | GetSuppressedDestination | |
get-tenantGet information about a specific tenant, including the tenant's name, ID, ARN, creation timestamp, tags, and sending status. | GetTenant | |
list-configuration-setsList all of the configuration sets associated with your account in the current region. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you | ListConfigurationSets | |
list-contact-listsLists all of the contact lists available. 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. | ListContactLists | |
list-contactsLists the contacts present in a specific contact list. | ListContacts | |
list-custom-verification-email-templatesLists the existing custom verification email templates for your account in the current Amazon Web Services Region. For more information about custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide. You can execute this operation no more t | ListCustomVerificationEmailTemplates | |
list-dedicated-ip-poolsList all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region. | ListDedicatedIpPools | |
list-deliverability-test-reportsShow a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport operation to view the results. | ListDeliverabilityTestReports | |
list-domain-deliverability-campaignsRetrieve 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. | ListDomainDeliverabilityCampaigns | |
list-email-identitiesReturns 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 wit | ListEmailIdentities | |
list-email-templatesLists the email templates present in your Amazon SES account in the current Amazon Web Services Region. You can execute this operation no more than once per second. | ListEmailTemplates | |
list-export-jobsLists all of the export jobs. | ListExportJobs | |
list-import-jobsLists all of the import jobs. | ListImportJobs | |
list-multi-region-endpointsList the multi-region endpoints (global-endpoints). Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is executed will be listed. | ListMultiRegionEndpoints | |
list-recommendationsLists the recommendations present in your Amazon SES account in the current Amazon Web Services Region. You can execute this operation no more than once per second. | ListRecommendations | |
list-reputation-entitiesList 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. Reputation entities represent resources in your account that have reputation tracking and manageme | ListReputationEntities | |
list-resource-tenantsList all tenants associated with a specific resource. 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. | ListResourceTenants | |
list-suppressed-destinationsRetrieves a list of email addresses that are on the suppression list for your account. | ListSuppressedDestinations | |
list-tags-for-resourceRetrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a label that you optionally define and associate with a resource. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category f | ListTagsForResource | |
list-tenant-resourcesList all resources associated with a specific tenant. 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. | ListTenantResources | |
list-tenantsList all tenants associated with your account in the current Amazon Web Services Region. This operation returns basic information about each tenant, such as tenant name, ID, ARN, and creation timestamp. | ListTenants | |
put-account-dedicated-ip-warmup-attributesEnable or disable the automatic warm-up feature for dedicated IP addresses. | PutAccountDedicatedIpWarmupAttributes | |
put-account-detailsUpdate your Amazon SES account details. | PutAccountDetails | |
put-account-sending-attributesEnable or disable the ability of your account to send email. | PutAccountSendingAttributes | |
put-account-suppression-attributesChange the settings for the account-level suppression list. | PutAccountSuppressionAttributes | |
put-account-vdm-attributesUpdate your Amazon SES account VDM attributes. You can execute this operation no more than once per second. | PutAccountVdmAttributes | |
put-configuration-set-archiving-optionsAssociate the configuration set with a MailManager archive. When you send email using the SendEmail or SendBulkEmail operations the message as it will be given to the receiving SMTP server will be archived, along with the recipient information. | PutConfigurationSetArchivingOptions | |
put-configuration-set-delivery-optionsAssociate 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. | PutConfigurationSetDeliveryOptions | |
put-configuration-set-reputation-optionsEnable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific Amazon Web Services Region. | PutConfigurationSetReputationOptions | |
put-configuration-set-sending-optionsEnable or disable email sending for messages that use a particular configuration set in a specific Amazon Web Services Region. | PutConfigurationSetSendingOptions | |
put-configuration-set-suppression-optionsSpecify the account suppression list preferences for a configuration set. | PutConfigurationSetSuppressionOptions | |
put-configuration-set-tracking-optionsSpecify a custom domain to use for open and click tracking elements in email that you send. | PutConfigurationSetTrackingOptions | |
put-configuration-set-vdm-optionsSpecify VDM preferences for email that you send using the configuration set. You can execute this operation no more than once per second. | PutConfigurationSetVdmOptions | |
put-dedicated-ip-in-poolMove a dedicated IP address to an existing dedicated IP pool. The dedicated IP address that you specify must already exist, and must be associated with your Amazon Web Services account. The dedicated IP pool you specify must already exist. You can create a new pool by using the CreateDedicatedIpPo | PutDedicatedIpInPool | |
put-dedicated-ip-pool-scaling-attributesUsed to convert a dedicated IP pool to a different scaling mode. MANAGED pools cannot be converted to STANDARD scaling mode. | PutDedicatedIpPoolScalingAttributes | |
put-dedicated-ip-warmup-attributes | PutDedicatedIpWarmupAttributes | |
put-deliverability-dashboard-optionEnable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the ability to perform predictive inbox placement tests. When you use the Deliverab | PutDeliverabilityDashboardOption | |
put-email-identity-configuration-set-attributesUsed to associate a configuration set with an email identity. | PutEmailIdentityConfigurationSetAttributes | |
put-email-identity-dkim-attributesUsed to enable or disable DKIM authentication for an email identity. | PutEmailIdentityDkimAttributes | |
put-email-identity-dkim-signing-attributesUsed to configure or change the DKIM authentication settings for an email domain identity. You can use this operation to do any of the following: Update the signing attributes for an identity that uses Bring Your Own DKIM (BYODKIM). Update the key length that should be used for Easy DKIM. Chan | PutEmailIdentityDkimSigningAttributes | |
put-email-identity-feedback-attributesUsed to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event. If the value is true, you receive email notifications when bounce or complaint events occur. These notifications | PutEmailIdentityFeedbackAttributes | |
put-email-identity-mail-from-attributesUsed to enable or disable the custom Mail-From domain configuration for an email identity. | PutEmailIdentityMailFromAttributes | |
put-suppressed-destinationAdds an email address to the suppression list for your account. | PutSuppressedDestination | |
send-bulk-emailComposes an email message to multiple destinations. | SendBulkEmail | |
send-custom-verification-emailAdds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address. To use this operation, you must first create a c | SendCustomVerificationEmail | |
send-emailSends an email message. You can use the Amazon SES API v2 to send the following types of messages: Simple – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon SES assembles the message for you. Raw – A raw, MI | SendEmail | |
tag-resourceAdd one or more tags (keys and values) to a specified resource. A tag is a label that you optionally define and associate with a resource. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 | TagResource | |
test-render-email-templateCreates a preview of the MIME content of an email when provided with a template and a set of replacement data. You can execute this operation no more than once per second. | TestRenderEmailTemplate | |
untag-resourceRemove one or more tags (keys and values) from a specified resource. | UntagResource | |
update-configuration-set-event-destinationUpdate the configuration of an event destination for a configuration set. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon EventBridge a | UpdateConfigurationSetEventDestination | |
update-contactUpdates a contact's preferences for a list. You must specify all existing topic preferences in the TopicPreferences object, not just the ones that need updating; otherwise, all your existing preferences will be removed. | UpdateContact | |
update-contact-listUpdates contact list metadata. This operation does a complete replacement. | UpdateContactList | |
update-custom-verification-email-templateUpdates an existing custom verification email template. For more information about custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide. You can execute this operation no more than once per second. | UpdateCustomVerificationEmailTemplate | |
update-email-identity-policyUpdates the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist. This API is for the identity owner only. If you have not verified the identity, this API will return an er | UpdateEmailIdentityPolicy | |
update-email-templateUpdates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide. You can execute this operation no more than once per second. | UpdateEmailTemplate | |
update-reputation-entity-customer-managed-statusUpdate the customer-managed sending status for a reputation entity. This allows you to enable, disable, or reinstate sending for the entity. The customer-managed status works in conjunction with the Amazon Web Services Amazon SES-managed status to determine the overall sending capability. When you u | UpdateReputationEntityCustomerManagedStatus | |
update-reputation-entity-policyUpdate 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. Reputation management policies are Amazon Web Services Amazon SES-managed (predefined pol | UpdateReputationEntityPolicy |
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterOur bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterSESv2