BatchGetMetricData

$result = $client->batchGetMetricData([/* ... */]);
$promise = $client->batchGetMetricDataAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->batchGetMetricData([
    'Queries' => [ // REQUIRED
        [
            'Dimensions' => ['<string>', ...],
            'EndDate' => <integer || string || DateTime>, // REQUIRED
            'Id' => '<string>', // REQUIRED
            'Metric' => 'SEND|COMPLAINT|PERMANENT_BOUNCE|TRANSIENT_BOUNCE|OPEN|CLICK|DELIVERY|DELIVERY_OPEN|DELIVERY_CLICK|DELIVERY_COMPLAINT', // REQUIRED
            'Namespace' => 'VDM', // REQUIRED
            'StartDate' => <integer || string || DateTime>, // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Errors' => [
        [
            'Code' => 'INTERNAL_FAILURE|ACCESS_DENIED',
            'Id' => '<string>',
            'Message' => '<string>',
        ],
        // ...
    ],
    'Results' => [
        [
            'Id' => '<string>',
            'Timestamps' => [<DateTime>, ...],
            'Values' => [<integer>, ...],
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

InternalServiceErrorException:

The request couldn't be processed because an error occurred with the Amazon SES API v2.

TooManyRequestsException:

Too many requests have been made to the operation.

NotFoundException:

The resource you attempted to access doesn't exist.

CancelExportJob

$result = $client->cancelExportJob([/* ... */]);
$promise = $client->cancelExportJobAsync([/* ... */]);

Cancels an export job.

Parameter Syntax

$result = $client->cancelExportJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

BadRequestException:

The input you provided is invalid.

TooManyRequestsException:

Too many requests have been made to the operation.

Examples

Example 1: Cancel export job

Cancels the export job with ID ef28cf62-9d8e-4b60-9283-b09816c99a99

$result = $client->cancelExportJob([
    'JobId' => 'ef28cf62-9d8e-4b60-9283-b09816c99a99',
]);

CreateConfigurationSet

$result = $client->createConfigurationSet([/* ... */]);
$promise = $client->createConfigurationSetAsync([/* ... */]);

Create a configuration set. Configuration sets are groups of rules that you can apply to the emails that you send. You apply a configuration set to an email by specifying the name of the configuration set when you call the Amazon SES API v2. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Parameter Syntax

$result = $client->createConfigurationSet([
    'ConfigurationSetName' => '<string>', // REQUIRED
    'DeliveryOptions' => [
        'MaxDeliverySeconds' => <integer>,
        'SendingPoolName' => '<string>',
        'TlsPolicy' => 'REQUIRE|OPTIONAL',
    ],
    'ReputationOptions' => [
        'LastFreshStart' => <integer || string || DateTime>,
        'ReputationMetricsEnabled' => true || false,
    ],
    'SendingOptions' => [
        'SendingEnabled' => true || false,
    ],
    'SuppressionOptions' => [
        'SuppressedReasons' => ['<string>', ...],
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TrackingOptions' => [
        'CustomRedirectDomain' => '<string>', // REQUIRED
        'HttpsPolicy' => 'REQUIRE|REQUIRE_OPEN_ONLY|OPTIONAL',
    ],
    'VdmOptions' => [
        'DashboardOptions' => [
            'EngagementMetrics' => 'ENABLED|DISABLED',
        ],
        'GuardianOptions' => [
            'OptimizedSharedDelivery' => 'ENABLED|DISABLED',
        ],
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AlreadyExistsException:

The resource specified in your request already exists.

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

LimitExceededException:

There are too many instances of the specified resource type.

BadRequestException:

The input you provided is invalid.

ConcurrentModificationException:

The resource is being modified by another operation or thread.

CreateConfigurationSetEventDestination

$result = $client->createConfigurationSetEventDestination([/* ... */]);
$promise = $client->createConfigurationSetEventDestinationAsync([/* ... */]);

Create an event destination. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon EventBridge and associate a rule to send the event to the specified target.

A single configuration set can include more than one event destination.

Parameter Syntax

$result = $client->createConfigurationSetEventDestination([
    'ConfigurationSetName' => '<string>', // REQUIRED
    'EventDestination' => [ // REQUIRED
        'CloudWatchDestination' => [
            'DimensionConfigurations' => [ // REQUIRED
                [
                    'DefaultDimensionValue' => '<string>', // REQUIRED
                    'DimensionName' => '<string>', // REQUIRED
                    'DimensionValueSource' => 'MESSAGE_TAG|EMAIL_HEADER|LINK_TAG', // REQUIRED
                ],
                // ...
            ],
        ],
        'Enabled' => true || false,
        'EventBridgeDestination' => [
            'EventBusArn' => '<string>', // REQUIRED
        ],
        'KinesisFirehoseDestination' => [
            'DeliveryStreamArn' => '<string>', // REQUIRED
            'IamRoleArn' => '<string>', // REQUIRED
        ],
        'MatchingEventTypes' => ['<string>', ...],
        'PinpointDestination' => [
            'ApplicationArn' => '<string>',
        ],
        'SnsDestination' => [
            'TopicArn' => '<string>', // REQUIRED
        ],
    ],
    'EventDestinationName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

AlreadyExistsException:

The resource specified in your request already exists.

LimitExceededException:

There are too many instances of the specified resource type.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

CreateContact

$result = $client->createContact([/* ... */]);
$promise = $client->createContactAsync([/* ... */]);

Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list.

Parameter Syntax

$result = $client->createContact([
    'AttributesData' => '<string>',
    'ContactListName' => '<string>', // REQUIRED
    'EmailAddress' => '<string>', // REQUIRED
    'TopicPreferences' => [
        [
            'SubscriptionStatus' => 'OPT_IN|OPT_OUT', // REQUIRED
            'TopicName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'UnsubscribeAll' => true || false,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

TooManyRequestsException:

Too many requests have been made to the operation.

NotFoundException:

The resource you attempted to access doesn't exist.

AlreadyExistsException:

The resource specified in your request already exists.

CreateContactList

$result = $client->createContactList([/* ... */]);
$promise = $client->createContactListAsync([/* ... */]);

Creates a contact list.

Parameter Syntax

$result = $client->createContactList([
    'ContactListName' => '<string>', // REQUIRED
    'Description' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Topics' => [
        [
            'DefaultSubscriptionStatus' => 'OPT_IN|OPT_OUT', // REQUIRED
            'Description' => '<string>',
            'DisplayName' => '<string>', // REQUIRED
            'TopicName' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

TooManyRequestsException:

Too many requests have been made to the operation.

AlreadyExistsException:

The resource specified in your request already exists.

LimitExceededException:

There are too many instances of the specified resource type.

CreateCustomVerificationEmailTemplate

$result = $client->createCustomVerificationEmailTemplate([/* ... */]);
$promise = $client->createCustomVerificationEmailTemplateAsync([/* ... */]);

Creates a new custom verification email template.

For more information about custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide.

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

Parameter Syntax

$result = $client->createCustomVerificationEmailTemplate([
    'FailureRedirectionURL' => '<string>', // REQUIRED
    'FromEmailAddress' => '<string>', // REQUIRED
    'SuccessRedirectionURL' => '<string>', // REQUIRED
    'TemplateContent' => '<string>', // REQUIRED
    'TemplateName' => '<string>', // REQUIRED
    'TemplateSubject' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

AlreadyExistsException:

The resource specified in your request already exists.

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

LimitExceededException:

There are too many instances of the specified resource type.

CreateDedicatedIpPool

$result = $client->createDedicatedIpPool([/* ... */]);
$promise = $client->createDedicatedIpPoolAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createDedicatedIpPool([
    'PoolName' => '<string>', // REQUIRED
    'ScalingMode' => 'STANDARD|MANAGED',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AlreadyExistsException:

The resource specified in your request already exists.

LimitExceededException:

There are too many instances of the specified resource type.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

ConcurrentModificationException:

The resource is being modified by another operation or thread.

CreateDeliverabilityTestReport

$result = $client->createDeliverabilityTestReport([/* ... */]);
$promise = $client->createDeliverabilityTestReportAsync([/* ... */]);

Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon SES then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to view the results of the test.

Parameter Syntax

$result = $client->createDeliverabilityTestReport([
    'Content' => [ // REQUIRED
        'Raw' => [
            'Data' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
        ],
        'Simple' => [
            'Body' => [ // REQUIRED
                'Html' => [
                    'Charset' => '<string>',
                    'Data' => '<string>', // REQUIRED
                ],
                'Text' => [
                    'Charset' => '<string>',
                    'Data' => '<string>', // REQUIRED
                ],
            ],
            'Headers' => [
                [
                    'Name' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'Subject' => [ // REQUIRED
                'Charset' => '<string>',
                'Data' => '<string>', // REQUIRED
            ],
        ],
        'Template' => [
            'Headers' => [
                [
                    'Name' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'TemplateArn' => '<string>',
            'TemplateContent' => [
                'Html' => '<string>',
                'Subject' => '<string>',
                'Text' => '<string>',
            ],
            'TemplateData' => '<string>',
            'TemplateName' => '<string>',
        ],
    ],
    'FromEmailAddress' => '<string>', // REQUIRED
    'ReportName' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'DeliverabilityTestStatus' => 'IN_PROGRESS|COMPLETED',
    'ReportId' => '<string>',
]

Result Details

Errors

AccountSuspendedException:

The message can't be sent because the account's ability to send email has been permanently restricted.

SendingPausedException:

The message can't be sent because the account's ability to send email is currently paused.

MessageRejected:

The message can't be sent because it contains invalid content.

MailFromDomainNotVerifiedException:

The message can't be sent because the sending domain isn't verified.

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

LimitExceededException:

There are too many instances of the specified resource type.

BadRequestException:

The input you provided is invalid.

ConcurrentModificationException:

The resource is being modified by another operation or thread.

CreateEmailIdentity

$result = $client->createEmailIdentity([/* ... */]);
$promise = $client->createEmailIdentityAsync([/* ... */]);

Starts the process of verifying an email identity. An identity is an email address or domain that you use when you send email. Before you can use an identity to send email, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the identity, and that you've given Amazon SES API v2 permission to send email from the identity.

When you verify an email address, Amazon SES sends an email to the address. Your email address is verified as soon as you follow the link in the verification email.

When you verify a domain without specifying the DkimSigningAttributes object, this operation provides a set of DKIM tokens. You can convert these tokens into CNAME records, which you then add to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. This verification method is known as Easy DKIM.

Alternatively, you can perform the verification process by providing your own public-private key pair. This verification method is known as Bring Your Own DKIM (BYODKIM). To use BYODKIM, your call to the CreateEmailIdentity operation has to include the DkimSigningAttributes object. When you specify this object, you provide a selector (a component of the DNS record name that identifies the public key to use for DKIM authentication) and a private key.

When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. For some DNS providers, it can take 72 hours or more to complete the domain verification process.

Additionally, you can associate an existing configuration set with the email identity that you're verifying.

Parameter Syntax

$result = $client->createEmailIdentity([
    'ConfigurationSetName' => '<string>',
    'DkimSigningAttributes' => [
        'DomainSigningPrivateKey' => '<string>',
        'DomainSigningSelector' => '<string>',
        'NextSigningKeyLength' => 'RSA_1024_BIT|RSA_2048_BIT',
    ],
    'EmailIdentity' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'DkimAttributes' => [
        'CurrentSigningKeyLength' => 'RSA_1024_BIT|RSA_2048_BIT',
        'LastKeyGenerationTimestamp' => <DateTime>,
        'NextSigningKeyLength' => 'RSA_1024_BIT|RSA_2048_BIT',
        'SigningAttributesOrigin' => 'AWS_SES|EXTERNAL',
        'SigningEnabled' => true || false,
        'Status' => 'PENDING|SUCCESS|FAILED|TEMPORARY_FAILURE|NOT_STARTED',
        'Tokens' => ['<string>', ...],
    ],
    'IdentityType' => 'EMAIL_ADDRESS|DOMAIN|MANAGED_DOMAIN',
    'VerifiedForSendingStatus' => true || false,
]

Result Details

Errors

AlreadyExistsException:

The resource specified in your request already exists.

LimitExceededException:

There are too many instances of the specified resource type.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

ConcurrentModificationException:

The resource is being modified by another operation or thread.

NotFoundException:

The resource you attempted to access doesn't exist.

CreateEmailIdentityPolicy

$result = $client->createEmailIdentityPolicy([/* ... */]);
$promise = $client->createEmailIdentityPolicyAsync([/* ... */]);

Creates the specified sending authorization policy for the given identity (an email address or a domain).

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

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

Parameter Syntax

$result = $client->createEmailIdentityPolicy([
    'EmailIdentity' => '<string>', // REQUIRED
    'Policy' => '<string>', // REQUIRED
    'PolicyName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

AlreadyExistsException:

The resource specified in your request already exists.

TooManyRequestsException:

Too many requests have been made to the operation.

LimitExceededException:

There are too many instances of the specified resource type.

BadRequestException:

The input you provided is invalid.

CreateEmailTemplate

$result = $client->createEmailTemplate([/* ... */]);
$promise = $client->createEmailTemplateAsync([/* ... */]);

Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide.

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

Parameter Syntax

$result = $client->createEmailTemplate([
    'TemplateContent' => [ // REQUIRED
        'Html' => '<string>',
        'Subject' => '<string>',
        'Text' => '<string>',
    ],
    'TemplateName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AlreadyExistsException:

The resource specified in your request already exists.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

LimitExceededException:

There are too many instances of the specified resource type.

CreateExportJob

$result = $client->createExportJob([/* ... */]);
$promise = $client->createExportJobAsync([/* ... */]);

Creates an export job for a data source and destination.

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

Parameter Syntax

$result = $client->createExportJob([
    'ExportDataSource' => [ // REQUIRED
        'MessageInsightsDataSource' => [
            'EndDate' => <integer || string || DateTime>, // REQUIRED
            'Exclude' => [
                'Destination' => ['<string>', ...],
                'FromEmailAddress' => ['<string>', ...],
                'Isp' => ['<string>', ...],
                'LastDeliveryEvent' => ['<string>', ...],
                'LastEngagementEvent' => ['<string>', ...],
                'Subject' => ['<string>', ...],
            ],
            'Include' => [
                'Destination' => ['<string>', ...],
                'FromEmailAddress' => ['<string>', ...],
                'Isp' => ['<string>', ...],
                'LastDeliveryEvent' => ['<string>', ...],
                'LastEngagementEvent' => ['<string>', ...],
                'Subject' => ['<string>', ...],
            ],
            'MaxResults' => <integer>,
            'StartDate' => <integer || string || DateTime>, // REQUIRED
        ],
        'MetricsDataSource' => [
            'Dimensions' => [ // REQUIRED
                '<MetricDimensionName>' => ['<string>', ...],
                // ...
            ],
            'EndDate' => <integer || string || DateTime>, // REQUIRED
            'Metrics' => [ // REQUIRED
                [
                    'Aggregation' => 'RATE|VOLUME',
                    'Name' => 'SEND|COMPLAINT|PERMANENT_BOUNCE|TRANSIENT_BOUNCE|OPEN|CLICK|DELIVERY|DELIVERY_OPEN|DELIVERY_CLICK|DELIVERY_COMPLAINT',
                ],
                // ...
            ],
            'Namespace' => 'VDM', // REQUIRED
            'StartDate' => <integer || string || DateTime>, // REQUIRED
        ],
    ],
    'ExportDestination' => [ // REQUIRED
        'DataFormat' => 'CSV|JSON', // REQUIRED
        'S3Url' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'JobId' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

TooManyRequestsException:

Too many requests have been made to the operation.

NotFoundException:

The resource you attempted to access doesn't exist.

LimitExceededException:

There are too many instances of the specified resource type.

Examples

Example 1: Create Metrics export job

Creates a new export job for Metrics data

$result = $client->createExportJob([
    'ExportDataSource' => [
        'MetricsDataSource' => [
            'Dimensions' => [
                'ISP' => [
                    '*',
                ],
            ],
            'EndDate' => ,
            'Metrics' => [
                [
                    'Aggregation' => 'VOLUME',
                    'Name' => 'SEND',
                ],
                [
                    'Aggregation' => 'VOLUME',
                    'Name' => 'COMPLAINT',
                ],
                [
                    'Aggregation' => 'RATE',
                    'Name' => 'COMPLAINT',
                ],
            ],
            'Namespace' => 'VDM',
            'StartDate' => ,
        ],
    ],
    'ExportDestination' => [
        'DataFormat' => 'CSV',
    ],
]);

Result syntax:

[
    'JobId' => 'ef28cf62-9d8e-4b60-9283-b09816c99a99',
]

Example 2: Create Message Insights export job

Creates a new export job for Message Insights data

$result = $client->createExportJob([
    'ExportDataSource' => [
        'MessageInsightsDataSource' => [
            'EndDate' => ,
            'Exclude' => [
                'FromEmailAddress' => [
                    'hello@example.com',
                ],
            ],
            'Include' => [
                'Subject' => [
                    'Hello',
                ],
            ],
            'StartDate' => ,
        ],
    ],
    'ExportDestination' => [
        'DataFormat' => 'CSV',
    ],
]);

Result syntax:

[
    'JobId' => 'ef28cf62-9d8e-4b60-9283-b09816c99a99',
]

CreateImportJob

$result = $client->createImportJob([/* ... */]);
$promise = $client->createImportJobAsync([/* ... */]);

Creates an import job for a data destination.

Parameter Syntax

$result = $client->createImportJob([
    'ImportDataSource' => [ // REQUIRED
        'DataFormat' => 'CSV|JSON', // REQUIRED
        'S3Url' => '<string>', // REQUIRED
    ],
    'ImportDestination' => [ // REQUIRED
        'ContactListDestination' => [
            'ContactListImportAction' => 'DELETE|PUT', // REQUIRED
            'ContactListName' => '<string>', // REQUIRED
        ],
        'SuppressionListDestination' => [
            'SuppressionListImportAction' => 'DELETE|PUT', // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'JobId' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

LimitExceededException:

There are too many instances of the specified resource type.

TooManyRequestsException:

Too many requests have been made to the operation.

DeleteConfigurationSet

$result = $client->deleteConfigurationSet([/* ... */]);
$promise = $client->deleteConfigurationSetAsync([/* ... */]);

Delete an existing configuration set.

Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Parameter Syntax

$result = $client->deleteConfigurationSet([
    'ConfigurationSetName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

ConcurrentModificationException:

The resource is being modified by another operation or thread.

DeleteConfigurationSetEventDestination

$result = $client->deleteConfigurationSetEventDestination([/* ... */]);
$promise = $client->deleteConfigurationSetEventDestinationAsync([/* ... */]);

Delete an event destination.

Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon EventBridge and associate a rule to send the event to the specified target.

Parameter Syntax

$result = $client->deleteConfigurationSetEventDestination([
    'ConfigurationSetName' => '<string>', // REQUIRED
    'EventDestinationName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

DeleteContact

$result = $client->deleteContact([/* ... */]);
$promise = $client->deleteContactAsync([/* ... */]);

Removes a contact from a contact list.

Parameter Syntax

$result = $client->deleteContact([
    'ContactListName' => '<string>', // REQUIRED
    'EmailAddress' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

TooManyRequestsException:

Too many requests have been made to the operation.

NotFoundException:

The resource you attempted to access doesn't exist.

DeleteContactList

$result = $client->deleteContactList([/* ... */]);
$promise = $client->deleteContactListAsync([/* ... */]);

Deletes a contact list and all of the contacts on that list.

Parameter Syntax

$result = $client->deleteContactList([
    'ContactListName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

NotFoundException:

The resource you attempted to access doesn't exist.

BadRequestException:

The input you provided is invalid.

ConcurrentModificationException:

The resource is being modified by another operation or thread.

DeleteCustomVerificationEmailTemplate

$result = $client->deleteCustomVerificationEmailTemplate([/* ... */]);
$promise = $client->deleteCustomVerificationEmailTemplateAsync([/* ... */]);

Deletes an existing custom verification email template.

For more information about custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide.

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

Parameter Syntax

$result = $client->deleteCustomVerificationEmailTemplate([
    'TemplateName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

DeleteDedicatedIpPool

$result = $client->deleteDedicatedIpPool([/* ... */]);
$promise = $client->deleteDedicatedIpPoolAsync([/* ... */]);

Delete a dedicated IP pool.

Parameter Syntax

$result = $client->deleteDedicatedIpPool([
    'PoolName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

ConcurrentModificationException:

The resource is being modified by another operation or thread.

DeleteEmailIdentity

$result = $client->deleteEmailIdentity([/* ... */]);
$promise = $client->deleteEmailIdentityAsync([/* ... */]);

Deletes an email identity. An identity can be either an email address or a domain name.

Parameter Syntax

$result = $client->deleteEmailIdentity([
    'EmailIdentity' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

ConcurrentModificationException:

The resource is being modified by another operation or thread.

DeleteEmailIdentityPolicy

$result = $client->deleteEmailIdentityPolicy([/* ... */]);
$promise = $client->deleteEmailIdentityPolicyAsync([/* ... */]);

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.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

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

Parameter Syntax

$result = $client->deleteEmailIdentityPolicy([
    'EmailIdentity' => '<string>', // REQUIRED
    'PolicyName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

DeleteEmailTemplate

$result = $client->deleteEmailTemplate([/* ... */]);
$promise = $client->deleteEmailTemplateAsync([/* ... */]);

Deletes an email template.

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

Parameter Syntax

$result = $client->deleteEmailTemplate([
    'TemplateName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

DeleteSuppressedDestination

$result = $client->deleteSuppressedDestination([/* ... */]);
$promise = $client->deleteSuppressedDestinationAsync([/* ... */]);

Removes an email address from the suppression list for your account.

Parameter Syntax

$result = $client->deleteSuppressedDestination([
    'EmailAddress' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

BadRequestException:

The input you provided is invalid.

TooManyRequestsException:

Too many requests have been made to the operation.

GetAccount

$result = $client->getAccount([/* ... */]);
$promise = $client->getAccountAsync([/* ... */]);

Obtain information about the email-sending status and capabilities of your Amazon SES account in the current Amazon Web Services Region.

Parameter Syntax

$result = $client->getAccount([
]);

Parameter Details

Result Syntax

[
    'DedicatedIpAutoWarmupEnabled' => true || false,
    'Details' => [
        'AdditionalContactEmailAddresses' => ['<string>', ...],
        'ContactLanguage' => 'EN|JA',
        'MailType' => 'MARKETING|TRANSACTIONAL',
        'ReviewDetails' => [
            'CaseId' => '<string>',
            'Status' => 'PENDING|FAILED|GRANTED|DENIED',
        ],
        'UseCaseDescription' => '<string>',
        'WebsiteURL' => '<string>',
    ],
    'EnforcementStatus' => '<string>',
    'ProductionAccessEnabled' => true || false,
    'SendQuota' => [
        'Max24HourSend' => <float>,
        'MaxSendRate' => <float>,
        'SentLast24Hours' => <float>,
    ],
    'SendingEnabled' => true || false,
    'SuppressionAttributes' => [
        'SuppressedReasons' => ['<string>', ...],
    ],
    'VdmAttributes' => [
        'DashboardAttributes' => [
            'EngagementMetrics' => 'ENABLED|DISABLED',
        ],
        'GuardianAttributes' => [
            'OptimizedSharedDelivery' => 'ENABLED|DISABLED',
        ],
        'VdmEnabled' => 'ENABLED|DISABLED',
    ],
]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

GetBlacklistReports

$result = $client->getBlacklistReports([/* ... */]);
$promise = $client->getBlacklistReportsAsync([/* ... */]);

Retrieve a list of the blacklists that your dedicated IP addresses appear on.

Parameter Syntax

$result = $client->getBlacklistReports([
    'BlacklistItemNames' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'BlacklistReport' => [
        '<BlacklistItemName>' => [
            [
                'Description' => '<string>',
                'ListingTime' => <DateTime>,
                'RblName' => '<string>',
            ],
            // ...
        ],
        // ...
    ],
]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

NotFoundException:

The resource you attempted to access doesn't exist.

BadRequestException:

The input you provided is invalid.

GetConfigurationSet

$result = $client->getConfigurationSet([/* ... */]);
$promise = $client->getConfigurationSetAsync([/* ... */]);

Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more.

Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Parameter Syntax

$result = $client->getConfigurationSet([
    'ConfigurationSetName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ConfigurationSetName' => '<string>',
    'DeliveryOptions' => [
        'MaxDeliverySeconds' => <integer>,
        'SendingPoolName' => '<string>',
        'TlsPolicy' => 'REQUIRE|OPTIONAL',
    ],
    'ReputationOptions' => [
        'LastFreshStart' => <DateTime>,
        'ReputationMetricsEnabled' => true || false,
    ],
    'SendingOptions' => [
        'SendingEnabled' => true || false,
    ],
    'SuppressionOptions' => [
        'SuppressedReasons' => ['<string>', ...],
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TrackingOptions' => [
        'CustomRedirectDomain' => '<string>',
        'HttpsPolicy' => 'REQUIRE|REQUIRE_OPEN_ONLY|OPTIONAL',
    ],
    'VdmOptions' => [
        'DashboardOptions' => [
            'EngagementMetrics' => 'ENABLED|DISABLED',
        ],
        'GuardianOptions' => [
            'OptimizedSharedDelivery' => 'ENABLED|DISABLED',
        ],
    ],
]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

GetConfigurationSetEventDestinations

$result = $client->getConfigurationSetEventDestinations([/* ... */]);
$promise = $client->getConfigurationSetEventDestinationsAsync([/* ... */]);

Retrieve a list of event destinations that are associated with a configuration set.

Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon EventBridge and associate a rule to send the event to the specified target.

Parameter Syntax

$result = $client->getConfigurationSetEventDestinations([
    'ConfigurationSetName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EventDestinations' => [
        [
            'CloudWatchDestination' => [
                'DimensionConfigurations' => [
                    [
                        'DefaultDimensionValue' => '<string>',
                        'DimensionName' => '<string>',
                        'DimensionValueSource' => 'MESSAGE_TAG|EMAIL_HEADER|LINK_TAG',
                    ],
                    // ...
                ],
            ],
            'Enabled' => true || false,
            'EventBridgeDestination' => [
                'EventBusArn' => '<string>',
            ],
            'KinesisFirehoseDestination' => [
                'DeliveryStreamArn' => '<string>',
                'IamRoleArn' => '<string>',
            ],
            'MatchingEventTypes' => ['<string>', ...],
            'Name' => '<string>',
            'PinpointDestination' => [
                'ApplicationArn' => '<string>',
            ],
            'SnsDestination' => [
                'TopicArn' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

GetContact

$result = $client->getContact([/* ... */]);
$promise = $client->getContactAsync([/* ... */]);

Returns a contact from a contact list.

Parameter Syntax

$result = $client->getContact([
    'ContactListName' => '<string>', // REQUIRED
    'EmailAddress' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AttributesData' => '<string>',
    'ContactListName' => '<string>',
    'CreatedTimestamp' => <DateTime>,
    'EmailAddress' => '<string>',
    'LastUpdatedTimestamp' => <DateTime>,
    'TopicDefaultPreferences' => [
        [
            'SubscriptionStatus' => 'OPT_IN|OPT_OUT',
            'TopicName' => '<string>',
        ],
        // ...
    ],
    'TopicPreferences' => [
        [
            'SubscriptionStatus' => 'OPT_IN|OPT_OUT',
            'TopicName' => '<string>',
        ],
        // ...
    ],
    'UnsubscribeAll' => true || false,
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

TooManyRequestsException:

Too many requests have been made to the operation.

NotFoundException:

The resource you attempted to access doesn't exist.

GetContactList

$result = $client->getContactList([/* ... */]);
$promise = $client->getContactListAsync([/* ... */]);

Returns contact list metadata. It does not return any information about the contacts present in the list.

Parameter Syntax

$result = $client->getContactList([
    'ContactListName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ContactListName' => '<string>',
    'CreatedTimestamp' => <DateTime>,
    'Description' => '<string>',
    'LastUpdatedTimestamp' => <DateTime>,
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Topics' => [
        [
            'DefaultSubscriptionStatus' => 'OPT_IN|OPT_OUT',
            'Description' => '<string>',
            'DisplayName' => '<string>',
            'TopicName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

NotFoundException:

The resource you attempted to access doesn't exist.

BadRequestException:

The input you provided is invalid.

GetCustomVerificationEmailTemplate

$result = $client->getCustomVerificationEmailTemplate([/* ... */]);
$promise = $client->getCustomVerificationEmailTemplateAsync([/* ... */]);

Returns the custom email verification template for the template name you specify.

For more information about custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide.

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

Parameter Syntax

$result = $client->getCustomVerificationEmailTemplate([
    'TemplateName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'FailureRedirectionURL' => '<string>',
    'FromEmailAddress' => '<string>',
    'SuccessRedirectionURL' => '<string>',
    'TemplateContent' => '<string>',
    'TemplateName' => '<string>',
    'TemplateSubject' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

GetDedicatedIp

$result = $client->getDedicatedIp([/* ... */]);
$promise = $client->getDedicatedIpAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getDedicatedIp([
    'Ip' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DedicatedIp' => [
        'Ip' => '<string>',
        'PoolName' => '<string>',
        'WarmupPercentage' => <integer>,
        'WarmupStatus' => 'IN_PROGRESS|DONE',
    ],
]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

NotFoundException:

The resource you attempted to access doesn't exist.

BadRequestException:

The input you provided is invalid.

GetDedicatedIpPool

$result = $client->getDedicatedIpPool([/* ... */]);
$promise = $client->getDedicatedIpPoolAsync([/* ... */]);

Retrieve information about the dedicated pool.

Parameter Syntax

$result = $client->getDedicatedIpPool([
    'PoolName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DedicatedIpPool' => [
        'PoolName' => '<string>',
        'ScalingMode' => 'STANDARD|MANAGED',
    ],
]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

NotFoundException:

The resource you attempted to access doesn't exist.

BadRequestException:

The input you provided is invalid.

GetDedicatedIps

$result = $client->getDedicatedIps([/* ... */]);
$promise = $client->getDedicatedIpsAsync([/* ... */]);

List the dedicated IP addresses that are associated with your Amazon Web Services account.

Parameter Syntax

$result = $client->getDedicatedIps([
    'NextToken' => '<string>',
    'PageSize' => <integer>,
    'PoolName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DedicatedIps' => [
        [
            'Ip' => '<string>',
            'PoolName' => '<string>',
            'WarmupPercentage' => <integer>,
            'WarmupStatus' => 'IN_PROGRESS|DONE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

NotFoundException:

The resource you attempted to access doesn't exist.

BadRequestException:

The input you provided is invalid.

GetDeliverabilityDashboardOptions

$result = $client->getDeliverabilityDashboardOptions([/* ... */]);
$promise = $client->getDeliverabilityDashboardOptionsAsync([/* ... */]);

Retrieve information about the status of the Deliverability dashboard for your account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other Amazon Web Services services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing.

Parameter Syntax

$result = $client->getDeliverabilityDashboardOptions([
]);

Parameter Details

Result Syntax

[
    'AccountStatus' => 'ACTIVE|PENDING_EXPIRATION|DISABLED',
    'ActiveSubscribedDomains' => [
        [
            'Domain' => '<string>',
            'InboxPlacementTrackingOption' => [
                'Global' => true || false,
                'TrackedIsps' => ['<string>', ...],
            ],
            'SubscriptionStartDate' => <DateTime>,
        ],
        // ...
    ],
    'DashboardEnabled' => true || false,
    'PendingExpirationSubscribedDomains' => [
        [
            'Domain' => '<string>',
            'InboxPlacementTrackingOption' => [
                'Global' => true || false,
                'TrackedIsps' => ['<string>', ...],
            ],
            'SubscriptionStartDate' => <DateTime>,
        ],
        // ...
    ],
    'SubscriptionExpiryDate' => <DateTime>,
]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

LimitExceededException:

There are too many instances of the specified resource type.

BadRequestException:

The input you provided is invalid.

GetDeliverabilityTestReport

$result = $client->getDeliverabilityTestReport([/* ... */]);
$promise = $client->getDeliverabilityTestReportAsync([/* ... */]);

Retrieve the results of a predictive inbox placement test.

Parameter Syntax

$result = $client->getDeliverabilityTestReport([
    'ReportId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DeliverabilityTestReport' => [
        'CreateDate' => <DateTime>,
        'DeliverabilityTestStatus' => 'IN_PROGRESS|COMPLETED',
        'FromEmailAddress' => '<string>',
        'ReportId' => '<string>',
        'ReportName' => '<string>',
        'Subject' => '<string>',
    ],
    'IspPlacements' => [
        [
            'IspName' => '<string>',
            'PlacementStatistics' => [
                'DkimPercentage' => <float>,
                'InboxPercentage' => <float>,
                'MissingPercentage' => <float>,
                'SpamPercentage' => <float>,
                'SpfPercentage' => <float>,
            ],
        ],
        // ...
    ],
    'Message' => '<string>',
    'OverallPlacement' => [
        'DkimPercentage' => <float>,
        'InboxPercentage' => <float>,
        'MissingPercentage' => <float>,
        'SpamPercentage' => <float>,
        'SpfPercentage' => <float>,
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

NotFoundException:

The resource you attempted to access doesn't exist.

BadRequestException:

The input you provided is invalid.

GetDomainDeliverabilityCampaign

$result = $client->getDomainDeliverabilityCampaign([/* ... */]);
$promise = $client->getDomainDeliverabilityCampaignAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getDomainDeliverabilityCampaign([
    'CampaignId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DomainDeliverabilityCampaign' => [
        'CampaignId' => '<string>',
        'DeleteRate' => <float>,
        'Esps' => ['<string>', ...],
        'FirstSeenDateTime' => <DateTime>,
        'FromAddress' => '<string>',
        'ImageUrl' => '<string>',
        'InboxCount' => <integer>,
        'LastSeenDateTime' => <DateTime>,
        'ProjectedVolume' => <integer>,
        'ReadDeleteRate' => <float>,
        'ReadRate' => <float>,
        'SendingIps' => ['<string>', ...],
        'SpamCount' => <integer>,
        'Subject' => '<string>',
    ],
]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

NotFoundException:

The resource you attempted to access doesn't exist.

GetDomainStatisticsReport

$result = $client->getDomainStatisticsReport([/* ... */]);
$promise = $client->getDomainStatisticsReportAsync([/* ... */]);

Retrieve inbox placement and engagement rates for the domains that you use to send email.

Parameter Syntax

$result = $client->getDomainStatisticsReport([
    'Domain' => '<string>', // REQUIRED
    'EndDate' => <integer || string || DateTime>, // REQUIRED
    'StartDate' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DailyVolumes' => [
        [
            'DomainIspPlacements' => [
                [
                    'InboxPercentage' => <float>,
                    'InboxRawCount' => <integer>,
                    'IspName' => '<string>',
                    'SpamPercentage' => <float>,
                    'SpamRawCount' => <integer>,
                ],
                // ...
            ],
            'StartDate' => <DateTime>,
            'VolumeStatistics' => [
                'InboxRawCount' => <integer>,
                'ProjectedInbox' => <integer>,
                'ProjectedSpam' => <integer>,
                'SpamRawCount' => <integer>,
            ],
        ],
        // ...
    ],
    'OverallVolume' => [
        'DomainIspPlacements' => [
            [
                'InboxPercentage' => <float>,
                'InboxRawCount' => <integer>,
                'IspName' => '<string>',
                'SpamPercentage' => <float>,
                'SpamRawCount' => <integer>,
            ],
            // ...
        ],
        'ReadRatePercent' => <float>,
        'VolumeStatistics' => [
            'InboxRawCount' => <integer>,
            'ProjectedInbox' => <integer>,
            'ProjectedSpam' => <integer>,
            'SpamRawCount' => <integer>,
        ],
    ],
]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

NotFoundException:

The resource you attempted to access doesn't exist.

BadRequestException:

The input you provided is invalid.

GetEmailIdentity

$result = $client->getEmailIdentity([/* ... */]);
$promise = $client->getEmailIdentityAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getEmailIdentity([
    'EmailIdentity' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ConfigurationSetName' => '<string>',
    'DkimAttributes' => [
        'CurrentSigningKeyLength' => 'RSA_1024_BIT|RSA_2048_BIT',
        'LastKeyGenerationTimestamp' => <DateTime>,
        'NextSigningKeyLength' => 'RSA_1024_BIT|RSA_2048_BIT',
        'SigningAttributesOrigin' => 'AWS_SES|EXTERNAL',
        'SigningEnabled' => true || false,
        'Status' => 'PENDING|SUCCESS|FAILED|TEMPORARY_FAILURE|NOT_STARTED',
        'Tokens' => ['<string>', ...],
    ],
    'FeedbackForwardingStatus' => true || false,
    'IdentityType' => 'EMAIL_ADDRESS|DOMAIN|MANAGED_DOMAIN',
    'MailFromAttributes' => [
        'BehaviorOnMxFailure' => 'USE_DEFAULT_VALUE|REJECT_MESSAGE',
        'MailFromDomain' => '<string>',
        'MailFromDomainStatus' => 'PENDING|SUCCESS|FAILED|TEMPORARY_FAILURE',
    ],
    'Policies' => ['<string>', ...],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'VerificationInfo' => [
        'ErrorType' => 'SERVICE_ERROR|DNS_SERVER_ERROR|HOST_NOT_FOUND|TYPE_NOT_FOUND|INVALID_VALUE',
        'LastCheckedTimestamp' => <DateTime>,
        'LastSuccessTimestamp' => <DateTime>,
        'SOARecord' => [
            'AdminEmail' => '<string>',
            'PrimaryNameServer' => '<string>',
            'SerialNumber' => <integer>,
        ],
    ],
    'VerificationStatus' => 'PENDING|SUCCESS|FAILED|TEMPORARY_FAILURE|NOT_STARTED',
    'VerifiedForSendingStatus' => true || false,
]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

GetEmailIdentityPolicies

$result = $client->getEmailIdentityPolicies([/* ... */]);
$promise = $client->getEmailIdentityPoliciesAsync([/* ... */]);

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.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

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

Parameter Syntax

$result = $client->getEmailIdentityPolicies([
    'EmailIdentity' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Policies' => ['<string>', ...],
]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

GetEmailTemplate

$result = $client->getEmailTemplate([/* ... */]);
$promise = $client->getEmailTemplateAsync([/* ... */]);

Displays the template object (which includes the subject line, HTML part and text part) for the template you specify.

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

Parameter Syntax

$result = $client->getEmailTemplate([
    'TemplateName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TemplateContent' => [
        'Html' => '<string>',
        'Subject' => '<string>',
        'Text' => '<string>',
    ],
    'TemplateName' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

GetExportJob

$result = $client->getExportJob([/* ... */]);
$promise = $client->getExportJobAsync([/* ... */]);

Provides information about an export job.

Parameter Syntax

$result = $client->getExportJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CompletedTimestamp' => <DateTime>,
    'CreatedTimestamp' => <DateTime>,
    'ExportDataSource' => [
        'MessageInsightsDataSource' => [
            'EndDate' => <DateTime>,
            'Exclude' => [
                'Destination' => ['<string>', ...],
                'FromEmailAddress' => ['<string>', ...],
                'Isp' => ['<string>', ...],
                'LastDeliveryEvent' => ['<string>', ...],
                'LastEngagementEvent' => ['<string>', ...],
                'Subject' => ['<string>', ...],
            ],
            'Include' => [
                'Destination' => ['<string>', ...],
                'FromEmailAddress' => ['<string>', ...],
                'Isp' => ['<string>', ...],
                'LastDeliveryEvent' => ['<string>', ...],
                'LastEngagementEvent' => ['<string>', ...],
                'Subject' => ['<string>', ...],
            ],
            'MaxResults' => <integer>,
            'StartDate' => <DateTime>,
        ],
        'MetricsDataSource' => [
            'Dimensions' => [
                '<MetricDimensionName>' => ['<string>', ...],
                // ...
            ],
            'EndDate' => <DateTime>,
            'Metrics' => [
                [
                    'Aggregation' => 'RATE|VOLUME',
                    'Name' => 'SEND|COMPLAINT|PERMANENT_BOUNCE|TRANSIENT_BOUNCE|OPEN|CLICK|DELIVERY|DELIVERY_OPEN|DELIVERY_CLICK|DELIVERY_COMPLAINT',
                ],
                // ...
            ],
            'Namespace' => 'VDM',
            'StartDate' => <DateTime>,
        ],
    ],
    'ExportDestination' => [
        'DataFormat' => 'CSV|JSON',
        'S3Url' => '<string>',
    ],
    'ExportSourceType' => 'METRICS_DATA|MESSAGE_INSIGHTS',
    'FailureInfo' => [
        'ErrorMessage' => '<string>',
        'FailedRecordsS3Url' => '<string>',
    ],
    'JobId' => '<string>',
    'JobStatus' => 'CREATED|PROCESSING|COMPLETED|FAILED|CANCELLED',
    'Statistics' => [
        'ExportedRecordsCount' => <integer>,
        'ProcessedRecordsCount' => <integer>,
    ],
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

Examples

Example 1: Get export job

Gets the export job with ID ef28cf62-9d8e-4b60-9283-b09816c99a99

$result = $client->getExportJob([
    'JobId' => 'ef28cf62-9d8e-4b60-9283-b09816c99a99',
]);

Result syntax:

[
    'CreatedTimestamp' => ,
    'ExportDataSource' => [
        'MetricsDataSource' => [
            'Dimensions' => [
                'ISP' => [
                    '*',
                ],
            ],
            'EndDate' => ,
            'Metrics' => [
                [
                    'Aggregation' => 'VOLUME',
                    'Name' => 'SEND',
                ],
                [
                    'Aggregation' => 'VOLUME',
                    'Name' => 'COMPLAINT',
                ],
                [
                    'Aggregation' => 'RATE',
                    'Name' => 'COMPLAINT',
                ],
            ],
            'Namespace' => 'VDM',
            'StartDate' => ,
        ],
    ],
    'ExportDestination' => [
        'DataFormat' => 'CSV',
    ],
    'ExportSourceType' => 'METRICS_DATA',
    'JobId' => 'ef28cf62-9d8e-4b60-9283-b09816c99a99',
    'JobStatus' => 'PROCESSING',
    'Statistics' => [
        'ExportedRecordsCount' => 5,
        'ProcessedRecordsCount' => 5,
    ],
]

GetImportJob

$result = $client->getImportJob([/* ... */]);
$promise = $client->getImportJobAsync([/* ... */]);

Provides information about an import job.

Parameter Syntax

$result = $client->getImportJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CompletedTimestamp' => <DateTime>,
    'CreatedTimestamp' => <DateTime>,
    'FailedRecordsCount' => <integer>,
    'FailureInfo' => [
        'ErrorMessage' => '<string>',
        'FailedRecordsS3Url' => '<string>',
    ],
    'ImportDataSource' => [
        'DataFormat' => 'CSV|JSON',
        'S3Url' => '<string>',
    ],
    'ImportDestination' => [
        'ContactListDestination' => [
            'ContactListImportAction' => 'DELETE|PUT',
            'ContactListName' => '<string>',
        ],
        'SuppressionListDestination' => [
            'SuppressionListImportAction' => 'DELETE|PUT',
        ],
    ],
    'JobId' => '<string>',
    'JobStatus' => 'CREATED|PROCESSING|COMPLETED|FAILED|CANCELLED',
    'ProcessedRecordsCount' => <integer>,
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

GetMessageInsights

$result = $client->getMessageInsights([/* ... */]);
$promise = $client->getMessageInsightsAsync([/* ... */]);

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.

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

Parameter Syntax

$result = $client->getMessageInsights([
    'MessageId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EmailTags' => [
        [
            'Name' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'FromEmailAddress' => '<string>',
    'Insights' => [
        [
            'Destination' => '<string>',
            'Events' => [
                [
                    'Details' => [
                        'Bounce' => [
                            'BounceSubType' => '<string>',
                            'BounceType' => 'UNDETERMINED|TRANSIENT|PERMANENT',
                            'DiagnosticCode' => '<string>',
                        ],
                        'Complaint' => [
                            'ComplaintFeedbackType' => '<string>',
                            'ComplaintSubType' => '<string>',
                        ],
                    ],
                    'Timestamp' => <DateTime>,
                    'Type' => 'SEND|REJECT|BOUNCE|COMPLAINT|DELIVERY|OPEN|CLICK|RENDERING_FAILURE|DELIVERY_DELAY|SUBSCRIPTION',
                ],
                // ...
            ],
            'Isp' => '<string>',
        ],
        // ...
    ],
    'MessageId' => '<string>',
    'Subject' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

Examples

Example 1: Get Message Insights

Provides information about a specific message.

$result = $client->getMessageInsights([
    'MessageId' => '000000000000ab00-0a000aa0-1234-0a0a-1234-0a0aaa0aa00a-000000',
]);

Result syntax:

[
    'EmailTags' => [
        [
            'Name' => 'ses:operation',
            'Value' => 'SendEmail',
        ],
        [
            'Name' => 'ses:recipient-isp',
            'Value' => 'UNKNOWN_ISP',
        ],
        [
            'Name' => 'ses:source-ip',
            'Value' => '0.0.0.0',
        ],
        [
            'Name' => 'ses:from-domain',
            'Value' => 'example.com',
        ],
        [
            'Name' => 'ses:sender-identity',
            'Value' => 'hello@example.com',
        ],
        [
            'Name' => 'ses:caller-identity',
            'Value' => 'Identity',
        ],
    ],
    'FromEmailAddress' => 'hello@example.com',
    'Insights' => [
        [
            'Destination' => 'recipient@example.com',
            'Events' => [
                [
                    'Timestamp' => ,
                    'Type' => 'SEND',
                ],
                [
                    'Timestamp' => ,
                    'Type' => 'DELIVERY',
                ],
            ],
            'Isp' => 'UNKNOWN_ISP',
        ],
    ],
    'MessageId' => '000000000000ab00-0a000aa0-1234-0a0a-1234-0a0aaa0aa00a-000000',
    'Subject' => 'hello',
]

GetSuppressedDestination

$result = $client->getSuppressedDestination([/* ... */]);
$promise = $client->getSuppressedDestinationAsync([/* ... */]);

Retrieves information about a specific email address that's on the suppression list for your account.

Parameter Syntax

$result = $client->getSuppressedDestination([
    'EmailAddress' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'SuppressedDestination' => [
        'Attributes' => [
            'FeedbackId' => '<string>',
            'MessageId' => '<string>',
        ],
        'EmailAddress' => '<string>',
        'LastUpdateTime' => <DateTime>,
        'Reason' => 'BOUNCE|COMPLAINT',
    ],
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

TooManyRequestsException:

Too many requests have been made to the operation.

NotFoundException:

The resource you attempted to access doesn't exist.

ListConfigurationSets

$result = $client->listConfigurationSets([/* ... */]);
$promise = $client->listConfigurationSetsAsync([/* ... */]);

List all of the configuration sets associated with your account in the current region.

Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Parameter Syntax

$result = $client->listConfigurationSets([
    'NextToken' => '<string>',
    'PageSize' => <integer>,
]);

Parameter Details

Result Syntax

[
    'ConfigurationSets' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

ListContactLists

$result = $client->listContactLists([/* ... */]);
$promise = $client->listContactListsAsync([/* ... */]);

Lists all of the contact lists available.

Parameter Syntax

$result = $client->listContactLists([
    'NextToken' => '<string>',
    'PageSize' => <integer>,
]);

Parameter Details

Result Syntax

[
    'ContactLists' => [
        [
            'ContactListName' => '<string>',
            'LastUpdatedTimestamp' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

TooManyRequestsException:

Too many requests have been made to the operation.

ListContacts

$result = $client->listContacts([/* ... */]);
$promise = $client->listContactsAsync([/* ... */]);

Lists the contacts present in a specific contact list.

Parameter Syntax

$result = $client->listContacts([
    'ContactListName' => '<string>', // REQUIRED
    'Filter' => [
        'FilteredStatus' => 'OPT_IN|OPT_OUT',
        'TopicFilter' => [
            'TopicName' => '<string>',
            'UseDefaultIfPreferenceUnavailable' => true || false,
        ],
    ],
    'NextToken' => '<string>',
    'PageSize' => <integer>,
]);

Parameter Details

Result Syntax

[
    'Contacts' => [
        [
            'EmailAddress' => '<string>',
            'LastUpdatedTimestamp' => <DateTime>,
            'TopicDefaultPreferences' => [
                [
                    'SubscriptionStatus' => 'OPT_IN|OPT_OUT',
                    'TopicName' => '<string>',
                ],
                // ...
            ],
            'TopicPreferences' => [
                [
                    'SubscriptionStatus' => 'OPT_IN|OPT_OUT',
                    'TopicName' => '<string>',
                ],
                // ...
            ],
            'UnsubscribeAll' => true || false,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

TooManyRequestsException:

Too many requests have been made to the operation.

NotFoundException:

The resource you attempted to access doesn't exist.

ListCustomVerificationEmailTemplates

$result = $client->listCustomVerificationEmailTemplates([/* ... */]);
$promise = $client->listCustomVerificationEmailTemplatesAsync([/* ... */]);

Lists the existing custom verification email templates for your account in the current Amazon Web Services Region.

For more information about custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide.

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

Parameter Syntax

$result = $client->listCustomVerificationEmailTemplates([
    'NextToken' => '<string>',
    'PageSize' => <integer>,
]);

Parameter Details

Result Syntax

[
    'CustomVerificationEmailTemplates' => [
        [
            'FailureRedirectionURL' => '<string>',
            'FromEmailAddress' => '<string>',
            'SuccessRedirectionURL' => '<string>',
            'TemplateName' => '<string>',
            'TemplateSubject' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

ListDedicatedIpPools

$result = $client->listDedicatedIpPools([/* ... */]);
$promise = $client->listDedicatedIpPoolsAsync([/* ... */]);

List all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region.

Parameter Syntax

$result = $client->listDedicatedIpPools([
    'NextToken' => '<string>',
    'PageSize' => <integer>,
]);

Parameter Details

Result Syntax

[
    'DedicatedIpPools' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

ListDeliverabilityTestReports

$result = $client->listDeliverabilityTestReports([/* ... */]);
$promise = $client->listDeliverabilityTestReportsAsync([/* ... */]);

Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport operation to view the results.

Parameter Syntax

$result = $client->listDeliverabilityTestReports([
    'NextToken' => '<string>',
    'PageSize' => <integer>,
]);

Parameter Details

Result Syntax

[
    'DeliverabilityTestReports' => [
        [
            'CreateDate' => <DateTime>,
            'DeliverabilityTestStatus' => 'IN_PROGRESS|COMPLETED',
            'FromEmailAddress' => '<string>',
            'ReportId' => '<string>',
            'ReportName' => '<string>',
            'Subject' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

NotFoundException:

The resource you attempted to access doesn't exist.

BadRequestException:

The input you provided is invalid.

ListDomainDeliverabilityCampaigns

$result = $client->listDomainDeliverabilityCampaigns([/* ... */]);
$promise = $client->listDomainDeliverabilityCampaignsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listDomainDeliverabilityCampaigns([
    'EndDate' => <integer || string || DateTime>, // REQUIRED
    'NextToken' => '<string>',
    'PageSize' => <integer>,
    'StartDate' => <integer || string || DateTime>, // REQUIRED
    'SubscribedDomain' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DomainDeliverabilityCampaigns' => [
        [
            'CampaignId' => '<string>',
            'DeleteRate' => <float>,
            'Esps' => ['<string>', ...],
            'FirstSeenDateTime' => <DateTime>,
            'FromAddress' => '<string>',
            'ImageUrl' => '<string>',
            'InboxCount' => <integer>,
            'LastSeenDateTime' => <DateTime>,
            'ProjectedVolume' => <integer>,
            'ReadDeleteRate' => <float>,
            'ReadRate' => <float>,
            'SendingIps' => ['<string>', ...],
            'SpamCount' => <integer>,
            'Subject' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

NotFoundException:

The resource you attempted to access doesn't exist.

ListEmailIdentities

$result = $client->listEmailIdentities([/* ... */]);
$promise = $client->listEmailIdentitiesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listEmailIdentities([
    'NextToken' => '<string>',
    'PageSize' => <integer>,
]);

Parameter Details

Result Syntax

[
    'EmailIdentities' => [
        [
            'IdentityName' => '<string>',
            'IdentityType' => 'EMAIL_ADDRESS|DOMAIN|MANAGED_DOMAIN',
            'SendingEnabled' => true || false,
            'VerificationStatus' => 'PENDING|SUCCESS|FAILED|TEMPORARY_FAILURE|NOT_STARTED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

ListEmailTemplates

$result = $client->listEmailTemplates([/* ... */]);
$promise = $client->listEmailTemplatesAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->listEmailTemplates([
    'NextToken' => '<string>',
    'PageSize' => <integer>,
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'TemplatesMetadata' => [
        [
            'CreatedTimestamp' => <DateTime>,
            'TemplateName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

ListExportJobs

$result = $client->listExportJobs([/* ... */]);
$promise = $client->listExportJobsAsync([/* ... */]);

Lists all of the export jobs.

Parameter Syntax

$result = $client->listExportJobs([
    'ExportSourceType' => 'METRICS_DATA|MESSAGE_INSIGHTS',
    'JobStatus' => 'CREATED|PROCESSING|COMPLETED|FAILED|CANCELLED',
    'NextToken' => '<string>',
    'PageSize' => <integer>,
]);

Parameter Details

Result Syntax

[
    'ExportJobs' => [
        [
            'CompletedTimestamp' => <DateTime>,
            'CreatedTimestamp' => <DateTime>,
            'ExportSourceType' => 'METRICS_DATA|MESSAGE_INSIGHTS',
            'JobId' => '<string>',
            'JobStatus' => 'CREATED|PROCESSING|COMPLETED|FAILED|CANCELLED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

Examples

Example 1: List export jobs

Lists export jobs of type METRICS_DATA and status PROCESSING

$result = $client->listExportJobs([
    'ExportSourceType' => 'METRICS_DATA',
    'JobStatus' => 'PROCESSING',
    'PageSize' => 25,
]);

Result syntax:

[
    'ExportJobs' => [
        [
            'CreatedTimestamp' => ,
            'ExportSourceType' => 'METRICS_DATA',
            'JobId' => '72de83a0-6b49-47ca-9783-8b812576887a',
            'JobStatus' => 'PROCESSING',
        ],
    ],
]

ListImportJobs

$result = $client->listImportJobs([/* ... */]);
$promise = $client->listImportJobsAsync([/* ... */]);

Lists all of the import jobs.

Parameter Syntax

$result = $client->listImportJobs([
    'ImportDestinationType' => 'SUPPRESSION_LIST|CONTACT_LIST',
    'NextToken' => '<string>',
    'PageSize' => <integer>,
]);

Parameter Details

Result Syntax

[
    'ImportJobs' => [
        [
            'CreatedTimestamp' => <DateTime>,
            'FailedRecordsCount' => <integer>,
            'ImportDestination' => [
                'ContactListDestination' => [
                    'ContactListImportAction' => 'DELETE|PUT',
                    'ContactListName' => '<string>',
                ],
                'SuppressionListDestination' => [
                    'SuppressionListImportAction' => 'DELETE|PUT',
                ],
            ],
            'JobId' => '<string>',
            'JobStatus' => 'CREATED|PROCESSING|COMPLETED|FAILED|CANCELLED',
            'ProcessedRecordsCount' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

ListRecommendations

$result = $client->listRecommendations([/* ... */]);
$promise = $client->listRecommendationsAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->listRecommendations([
    'Filter' => ['<string>', ...],
    'NextToken' => '<string>',
    'PageSize' => <integer>,
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Recommendations' => [
        [
            'CreatedTimestamp' => <DateTime>,
            'Description' => '<string>',
            'Impact' => 'LOW|HIGH',
            'LastUpdatedTimestamp' => <DateTime>,
            'ResourceArn' => '<string>',
            'Status' => 'OPEN|FIXED',
            'Type' => 'DKIM|DMARC|SPF|BIMI',
        ],
        // ...
    ],
]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

NotFoundException:

The resource you attempted to access doesn't exist.

ListSuppressedDestinations

$result = $client->listSuppressedDestinations([/* ... */]);
$promise = $client->listSuppressedDestinationsAsync([/* ... */]);

Retrieves a list of email addresses that are on the suppression list for your account.

Parameter Syntax

$result = $client->listSuppressedDestinations([
    'EndDate' => <integer || string || DateTime>,
    'NextToken' => '<string>',
    'PageSize' => <integer>,
    'Reasons' => ['<string>', ...],
    'StartDate' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'SuppressedDestinationSummaries' => [
        [
            'EmailAddress' => '<string>',
            'LastUpdateTime' => <DateTime>,
            'Reason' => 'BOUNCE|COMPLAINT',
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

TooManyRequestsException:

Too many requests have been made to the operation.

InvalidNextTokenException:

The specified request includes an invalid or expired token.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Retrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a label that you optionally define and associate with a resource. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

PutAccountDedicatedIpWarmupAttributes

$result = $client->putAccountDedicatedIpWarmupAttributes([/* ... */]);
$promise = $client->putAccountDedicatedIpWarmupAttributesAsync([/* ... */]);

Enable or disable the automatic warm-up feature for dedicated IP addresses.

Parameter Syntax

$result = $client->putAccountDedicatedIpWarmupAttributes([
    'AutoWarmupEnabled' => true || false,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

PutAccountDetails

$result = $client->putAccountDetails([/* ... */]);
$promise = $client->putAccountDetailsAsync([/* ... */]);

Update your Amazon SES account details.

Parameter Syntax

$result = $client->putAccountDetails([
    'AdditionalContactEmailAddresses' => ['<string>', ...],
    'ContactLanguage' => 'EN|JA',
    'MailType' => 'MARKETING|TRANSACTIONAL', // REQUIRED
    'ProductionAccessEnabled' => true || false,
    'UseCaseDescription' => '<string>',
    'WebsiteURL' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

ConflictException:

If there is already an ongoing account details update under review.

PutAccountSendingAttributes

$result = $client->putAccountSendingAttributes([/* ... */]);
$promise = $client->putAccountSendingAttributesAsync([/* ... */]);

Enable or disable the ability of your account to send email.

Parameter Syntax

$result = $client->putAccountSendingAttributes([
    'SendingEnabled' => true || false,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

PutAccountSuppressionAttributes

$result = $client->putAccountSuppressionAttributes([/* ... */]);
$promise = $client->putAccountSuppressionAttributesAsync([/* ... */]);

Change the settings for the account-level suppression list.

Parameter Syntax

$result = $client->putAccountSuppressionAttributes([
    'SuppressedReasons' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

PutAccountVdmAttributes

$result = $client->putAccountVdmAttributes([/* ... */]);
$promise = $client->putAccountVdmAttributesAsync([/* ... */]);

Update your Amazon SES account VDM attributes.

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

Parameter Syntax

$result = $client->putAccountVdmAttributes([
    'VdmAttributes' => [ // REQUIRED
        'DashboardAttributes' => [
            'EngagementMetrics' => 'ENABLED|DISABLED',
        ],
        'GuardianAttributes' => [
            'OptimizedSharedDelivery' => 'ENABLED|DISABLED',
        ],
        'VdmEnabled' => 'ENABLED|DISABLED', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

TooManyRequestsException:

Too many requests have been made to the operation.

PutConfigurationSetDeliveryOptions

$result = $client->putConfigurationSetDeliveryOptions([/* ... */]);
$promise = $client->putConfigurationSetDeliveryOptionsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putConfigurationSetDeliveryOptions([
    'ConfigurationSetName' => '<string>', // REQUIRED
    'MaxDeliverySeconds' => <integer>,
    'SendingPoolName' => '<string>',
    'TlsPolicy' => 'REQUIRE|OPTIONAL',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

PutConfigurationSetReputationOptions

$result = $client->putConfigurationSetReputationOptions([/* ... */]);
$promise = $client->putConfigurationSetReputationOptionsAsync([/* ... */]);

Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific Amazon Web Services Region.

Parameter Syntax

$result = $client->putConfigurationSetReputationOptions([
    'ConfigurationSetName' => '<string>', // REQUIRED
    'ReputationMetricsEnabled' => true || false,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

PutConfigurationSetSendingOptions

$result = $client->putConfigurationSetSendingOptions([/* ... */]);
$promise = $client->putConfigurationSetSendingOptionsAsync([/* ... */]);

Enable or disable email sending for messages that use a particular configuration set in a specific Amazon Web Services Region.

Parameter Syntax

$result = $client->putConfigurationSetSendingOptions([
    'ConfigurationSetName' => '<string>', // REQUIRED
    'SendingEnabled' => true || false,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

PutConfigurationSetSuppressionOptions

$result = $client->putConfigurationSetSuppressionOptions([/* ... */]);
$promise = $client->putConfigurationSetSuppressionOptionsAsync([/* ... */]);

Specify the account suppression list preferences for a configuration set.

Parameter Syntax

$result = $client->putConfigurationSetSuppressionOptions([
    'ConfigurationSetName' => '<string>', // REQUIRED
    'SuppressedReasons' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

PutConfigurationSetTrackingOptions

$result = $client->putConfigurationSetTrackingOptions([/* ... */]);
$promise = $client->putConfigurationSetTrackingOptionsAsync([/* ... */]);

Specify a custom domain to use for open and click tracking elements in email that you send.

Parameter Syntax

$result = $client->putConfigurationSetTrackingOptions([
    'ConfigurationSetName' => '<string>', // REQUIRED
    'CustomRedirectDomain' => '<string>',
    'HttpsPolicy' => 'REQUIRE|REQUIRE_OPEN_ONLY|OPTIONAL',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

PutConfigurationSetVdmOptions

$result = $client->putConfigurationSetVdmOptions([/* ... */]);
$promise = $client->putConfigurationSetVdmOptionsAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->putConfigurationSetVdmOptions([
    'ConfigurationSetName' => '<string>', // REQUIRED
    'VdmOptions' => [
        'DashboardOptions' => [
            'EngagementMetrics' => 'ENABLED|DISABLED',
        ],
        'GuardianOptions' => [
            'OptimizedSharedDelivery' => 'ENABLED|DISABLED',
        ],
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

PutDedicatedIpInPool

$result = $client->putDedicatedIpInPool([/* ... */]);
$promise = $client->putDedicatedIpInPoolAsync([/* ... */]);

Move a dedicated IP address to an existing dedicated IP pool.

Parameter Syntax

$result = $client->putDedicatedIpInPool([
    'DestinationPoolName' => '<string>', // REQUIRED
    'Ip' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

PutDedicatedIpPoolScalingAttributes

$result = $client->putDedicatedIpPoolScalingAttributes([/* ... */]);
$promise = $client->putDedicatedIpPoolScalingAttributesAsync([/* ... */]);

Used to convert a dedicated IP pool to a different scaling mode.

Parameter Syntax

$result = $client->putDedicatedIpPoolScalingAttributes([
    'PoolName' => '<string>', // REQUIRED
    'ScalingMode' => 'STANDARD|MANAGED', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

ConcurrentModificationException:

The resource is being modified by another operation or thread.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

Examples

Example 1: Used to convert a dedicated IP pool to a different scaling mode.

This example converts a dedicated IP pool from STANDARD to MANAGED.

$result = $client->putDedicatedIpPoolScalingAttributes([
    'PoolName' => 'sample-ses-pool',
    'ScalingMode' => 'MANAGED',
]);

Result syntax:

[
]

PutDedicatedIpWarmupAttributes

$result = $client->putDedicatedIpWarmupAttributes([/* ... */]);
$promise = $client->putDedicatedIpWarmupAttributesAsync([/* ... */]);

Parameter Syntax

$result = $client->putDedicatedIpWarmupAttributes([
    'Ip' => '<string>', // REQUIRED
    'WarmupPercentage' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

PutDeliverabilityDashboardOption

$result = $client->putDeliverabilityDashboardOption([/* ... */]);
$promise = $client->putDeliverabilityDashboardOptionAsync([/* ... */]);

Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other Amazon Web Services services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing.

Parameter Syntax

$result = $client->putDeliverabilityDashboardOption([
    'DashboardEnabled' => true || false, // REQUIRED
    'SubscribedDomains' => [
        [
            'Domain' => '<string>',
            'InboxPlacementTrackingOption' => [
                'Global' => true || false,
                'TrackedIsps' => ['<string>', ...],
            ],
            'SubscriptionStartDate' => <integer || string || DateTime>,
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AlreadyExistsException:

The resource specified in your request already exists.

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

LimitExceededException:

There are too many instances of the specified resource type.

BadRequestException:

The input you provided is invalid.

PutEmailIdentityConfigurationSetAttributes

$result = $client->putEmailIdentityConfigurationSetAttributes([/* ... */]);
$promise = $client->putEmailIdentityConfigurationSetAttributesAsync([/* ... */]);

Used to associate a configuration set with an email identity.

Parameter Syntax

$result = $client->putEmailIdentityConfigurationSetAttributes([
    'ConfigurationSetName' => '<string>',
    'EmailIdentity' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

PutEmailIdentityDkimAttributes

$result = $client->putEmailIdentityDkimAttributes([/* ... */]);
$promise = $client->putEmailIdentityDkimAttributesAsync([/* ... */]);

Used to enable or disable DKIM authentication for an email identity.

Parameter Syntax

$result = $client->putEmailIdentityDkimAttributes([
    'EmailIdentity' => '<string>', // REQUIRED
    'SigningEnabled' => true || false,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

PutEmailIdentityDkimSigningAttributes

$result = $client->putEmailIdentityDkimSigningAttributes([/* ... */]);
$promise = $client->putEmailIdentityDkimSigningAttributesAsync([/* ... */]);

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:

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

• Change from using no DKIM authentication to using Easy DKIM.

• Change from using no DKIM authentication to using BYODKIM.

• Change from using Easy DKIM to using BYODKIM.

• Change from using BYODKIM to using Easy DKIM.

Parameter Syntax

$result = $client->putEmailIdentityDkimSigningAttributes([
    'EmailIdentity' => '<string>', // REQUIRED
    'SigningAttributes' => [
        'DomainSigningPrivateKey' => '<string>',
        'DomainSigningSelector' => '<string>',
        'NextSigningKeyLength' => 'RSA_1024_BIT|RSA_2048_BIT',
    ],
    'SigningAttributesOrigin' => 'AWS_SES|EXTERNAL', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DkimStatus' => 'PENDING|SUCCESS|FAILED|TEMPORARY_FAILURE|NOT_STARTED',
    'DkimTokens' => ['<string>', ...],
]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

PutEmailIdentityFeedbackAttributes

$result = $client->putEmailIdentityFeedbackAttributes([/* ... */]);
$promise = $client->putEmailIdentityFeedbackAttributesAsync([/* ... */]);

Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event.

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

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

Parameter Syntax

$result = $client->putEmailIdentityFeedbackAttributes([
    'EmailForwardingEnabled' => true || false,
    'EmailIdentity' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

PutEmailIdentityMailFromAttributes

$result = $client->putEmailIdentityMailFromAttributes([/* ... */]);
$promise = $client->putEmailIdentityMailFromAttributesAsync([/* ... */]);

Used to enable or disable the custom Mail-From domain configuration for an email identity.

Parameter Syntax

$result = $client->putEmailIdentityMailFromAttributes([
    'BehaviorOnMxFailure' => 'USE_DEFAULT_VALUE|REJECT_MESSAGE',
    'EmailIdentity' => '<string>', // REQUIRED
    'MailFromDomain' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource you attempted to access doesn't exist.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

PutSuppressedDestination

$result = $client->putSuppressedDestination([/* ... */]);
$promise = $client->putSuppressedDestinationAsync([/* ... */]);

Adds an email address to the suppression list for your account.

Parameter Syntax

$result = $client->putSuppressedDestination([
    'EmailAddress' => '<string>', // REQUIRED
    'Reason' => 'BOUNCE|COMPLAINT', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The input you provided is invalid.

TooManyRequestsException:

Too many requests have been made to the operation.

SendBulkEmail

$result = $client->sendBulkEmail([/* ... */]);
$promise = $client->sendBulkEmailAsync([/* ... */]);

Composes an email message to multiple destinations.

Parameter Syntax

$result = $client->sendBulkEmail([
    'BulkEmailEntries' => [ // REQUIRED
        [
            'Destination' => [ // REQUIRED
                'BccAddresses' => ['<string>', ...],
                'CcAddresses' => ['<string>', ...],
                'ToAddresses' => ['<string>', ...],
            ],
            'ReplacementEmailContent' => [
                'ReplacementTemplate' => [
                    'ReplacementTemplateData' => '<string>',
                ],
            ],
            'ReplacementHeaders' => [
                [
                    'Name' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'ReplacementTags' => [
                [
                    'Name' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        // ...
    ],
    'ConfigurationSetName' => '<string>',
    'DefaultContent' => [ // REQUIRED
        'Template' => [
            'Headers' => [
                [
                    'Name' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'TemplateArn' => '<string>',
            'TemplateContent' => [
                'Html' => '<string>',
                'Subject' => '<string>',
                'Text' => '<string>',
            ],
            'TemplateData' => '<string>',
            'TemplateName' => '<string>',
        ],
    ],
    'DefaultEmailTags' => [
        [
            'Name' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'FeedbackForwardingEmailAddress' => '<string>',
    'FeedbackForwardingEmailAddressIdentityArn' => '<string>',
    'FromEmailAddress' => '<string>',
    'FromEmailAddressIdentityArn' => '<string>',
    'ReplyToAddresses' => ['<string>', ...],
]);

Parameter Details