CreateConfigurationSet

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

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

Parameter Syntax

$result = $client->createConfigurationSet([
    'ConfigurationSetName' => '<string>', // REQUIRED
    'DeliveryOptions' => [
        'SendingPoolName' => '<string>',
        'TlsPolicy' => 'REQUIRE|OPTIONAL',
    ],
    'ReputationOptions' => [
        'LastFreshStart' => <integer || string || DateTime>,
        'ReputationMetricsEnabled' => true || false,
    ],
    'SendingOptions' => [
        'SendingEnabled' => true || false,
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TrackingOptions' => [
        'CustomRedirectDomain' => '<string>', // REQUIRED
    ],
]);

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. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

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

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,
        '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.

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 Pinpoint account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, Amazon Pinpoint sends it using only the IP addresses in the associated pool.

Parameter Syntax

$result = $client->createDedicatedIpPool([
    'PoolName' => '<string>', // REQUIRED
    '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 Pinpoint 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
                ],
            ],
            'Subject' => [ // REQUIRED
                'Charset' => '<string>',
                'Data' => '<string>', // REQUIRED
            ],
        ],
        'Template' => [
            'TemplateArn' => '<string>',
            'TemplateData' => '<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([/* ... */]);

Verifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is an email address or domain that you use when you send email. Before you can use an identity to send email with Amazon Pinpoint, you first have to verify it. By verifying an address, you demonstrate that you're the owner of the address, and that you've given Amazon Pinpoint permission to send email from the address.

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

When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.

Parameter Syntax

$result = $client->createEmailIdentity([
    'EmailIdentity' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'DkimAttributes' => [
        '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

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.

DeleteConfigurationSet

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

Delete an existing configuration set.

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

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.

In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

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.

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 that you previously verified for use with Amazon Pinpoint. 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.

GetAccount

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

Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DedicatedIpAutoWarmupEnabled' => true || false,
    'EnforcementStatus' => '<string>',
    'ProductionAccessEnabled' => true || false,
    'SendQuota' => [
        'Max24HourSend' => <float>,
        'MaxSendRate' => <float>,
        'SentLast24Hours' => <float>,
    ],
    'SendingEnabled' => true || false,
]

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.

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ConfigurationSetName' => '<string>',
    'DeliveryOptions' => [
        'SendingPoolName' => '<string>',
        'TlsPolicy' => 'REQUIRE|OPTIONAL',
    ],
    'ReputationOptions' => [
        'LastFreshStart' => <DateTime>,
        'ReputationMetricsEnabled' => true || false,
    ],
    'SendingOptions' => [
        'SendingEnabled' => true || false,
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TrackingOptions' => [
        'CustomRedirectDomain' => '<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.

GetConfigurationSetEventDestinations

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

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

In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

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,
            '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.

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.

GetDedicatedIps

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

List the dedicated IP addresses that are associated with your Amazon Pinpoint 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 Amazon Pinpoint 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 using Amazon Pinpoint. 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 Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint 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 (PutDeliverabilityDashboardOption operation).

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 associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DkimAttributes' => [
        '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',
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    '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.

ListConfigurationSets

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

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

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

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.

ListDedicatedIpPools

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

List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS 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 (PutDeliverabilityDashboardOption operation) 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 Pinpoint account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't.

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,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.

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 in Amazon Pinpoint. 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.

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.

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
    '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 AWS 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 AWS 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.

PutConfigurationSetTrackingOptions

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

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

Parameter Syntax

$result = $client->putConfigurationSetTrackingOptions([
    'ConfigurationSetName' => '<string>', // REQUIRED
    'CustomRedirectDomain' => '<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.

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.

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 for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. 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 Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint 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.

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.

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.

When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

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.

SendEmail

$result = $client->sendEmail([/* ... */]);
$promise = $client->sendEmailAsync([/* ... */]);

Sends an email message. You can use the Amazon Pinpoint Email API to send two types of messages:

• Simple – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon Pinpoint assembles the message for you.

• Raw – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message.

Parameter Syntax

$result = $client->sendEmail([
    'ConfigurationSetName' => '<string>',
    '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
                ],
            ],
            'Subject' => [ // REQUIRED
                'Charset' => '<string>',
                'Data' => '<string>', // REQUIRED
            ],
        ],
        'Template' => [
            'TemplateArn' => '<string>',
            'TemplateData' => '<string>',
        ],
    ],
    'Destination' => [ // REQUIRED
        'BccAddresses' => ['<string>', ...],
        'CcAddresses' => ['<string>', ...],
        'ToAddresses' => ['<string>', ...],
    ],
    'EmailTags' => [
        [
            'Name' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'FeedbackForwardingEmailAddress' => '<string>',
    'FromEmailAddress' => '<string>',
    'ReplyToAddresses' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

TooManyRequestsException:

Too many requests have been made to the operation.

LimitExceededException:

There are too many instances of the specified resource type.

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.

BadRequestException:

The input you provided is invalid.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Add one or more tags (keys and values) to a specified resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.

Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

TooManyRequestsException:

Too many requests have been made to the operation.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Remove one or more tags (keys and values) from a specified resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

TooManyRequestsException:

Too many requests have been made to the operation.

UpdateConfigurationSetEventDestination

$result = $client->updateConfigurationSetEventDestination([/* ... */]);
$promise = $client->updateConfigurationSetEventDestinationAsync([/* ... */]);

Update the configuration of an event destination for a configuration set.

In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

Parameter Syntax

$result = $client->updateConfigurationSetEventDestination([
    '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,
        '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.

TooManyRequestsException:

Too many requests have been made to the operation.

BadRequestException:

The input you provided is invalid.