AssociateOriginationIdentity

$result = $client->associateOriginationIdentity([/* ... */]);
$promise = $client->associateOriginationIdentityAsync([/* ... */]);

Associates the specified origination identity with a pool.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

If the origination identity configuration doesn't match the pool's configuration, an error is returned.

Parameter Syntax

$result = $client->associateOriginationIdentity([
    'ClientToken' => '<string>',
    'IsoCountryCode' => '<string>', // REQUIRED
    'OriginationIdentity' => '<string>', // REQUIRED
    'PoolId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'IsoCountryCode' => '<string>',
    'OriginationIdentity' => '<string>',
    'OriginationIdentityArn' => '<string>',
    'PoolArn' => '<string>',
    'PoolId' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

AssociateProtectConfiguration

$result = $client->associateProtectConfiguration([/* ... */]);
$promise = $client->associateProtectConfigurationAsync([/* ... */]);

Associate a protect configuration with a configuration set. This replaces the configuration sets current protect configuration. A configuration set can only be associated with one protect configuration at a time. A protect configuration can be associated with multiple configuration sets.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ConfigurationSetArn' => '<string>',
    'ConfigurationSetName' => '<string>',
    'ProtectConfigurationArn' => '<string>',
    'ProtectConfigurationId' => '<string>',
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

CreateConfigurationSet

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

Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it.

A configuration set is a set of rules that you apply to the SMS and voice messages that you send.

When you send a message, you can optionally specify a single configuration set.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ConfigurationSetArn' => '<string>',
    'ConfigurationSetName' => '<string>',
    'CreatedTimestamp' => <DateTime>,
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ValidationException:

A validation exception for a field.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

CreateEventDestination

$result = $client->createEventDestination([/* ... */]);
$promise = $client->createEventDestinationAsync([/* ... */]);

Creates a new event destination in a configuration set.

An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.

Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Kinesis Data Firehose destination.

Parameter Syntax

$result = $client->createEventDestination([
    'ClientToken' => '<string>',
    'CloudWatchLogsDestination' => [
        'IamRoleArn' => '<string>', // REQUIRED
        'LogGroupArn' => '<string>', // REQUIRED
    ],
    'ConfigurationSetName' => '<string>', // REQUIRED
    'EventDestinationName' => '<string>', // REQUIRED
    'KinesisFirehoseDestination' => [
        'DeliveryStreamArn' => '<string>', // REQUIRED
        'IamRoleArn' => '<string>', // REQUIRED
    ],
    'MatchingEventTypes' => ['<string>', ...], // REQUIRED
    'SnsDestination' => [
        'TopicArn' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'ConfigurationSetArn' => '<string>',
    'ConfigurationSetName' => '<string>',
    'EventDestination' => [
        'CloudWatchLogsDestination' => [
            'IamRoleArn' => '<string>',
            'LogGroupArn' => '<string>',
        ],
        'Enabled' => true || false,
        'EventDestinationName' => '<string>',
        'KinesisFirehoseDestination' => [
            'DeliveryStreamArn' => '<string>',
            'IamRoleArn' => '<string>',
        ],
        'MatchingEventTypes' => ['<string>', ...],
        'SnsDestination' => [
            'TopicArn' => '<string>',
        ],
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

CreateOptOutList

$result = $client->createOptOutList([/* ... */]);
$promise = $client->createOptOutListAsync([/* ... */]);

Creates a new opt-out list.

If the opt-out list name already exists, an error is returned.

An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the Amazon Pinpoint User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CreatedTimestamp' => <DateTime>,
    'OptOutListArn' => '<string>',
    'OptOutListName' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ValidationException:

A validation exception for a field.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

CreatePool

$result = $client->createPool([/* ... */]);
$promise = $client->createPoolAsync([/* ... */]);

Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.

The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

Parameter Syntax

$result = $client->createPool([
    'ClientToken' => '<string>',
    'DeletionProtectionEnabled' => true || false,
    'IsoCountryCode' => '<string>', // REQUIRED
    'MessageType' => 'TRANSACTIONAL|PROMOTIONAL', // REQUIRED
    'OriginationIdentity' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'CreatedTimestamp' => <DateTime>,
    'DeletionProtectionEnabled' => true || false,
    'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
    'OptOutListName' => '<string>',
    'PoolArn' => '<string>',
    'PoolId' => '<string>',
    'SelfManagedOptOutsEnabled' => true || false,
    'SharedRoutesEnabled' => true || false,
    'Status' => 'CREATING|ACTIVE|DELETING',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TwoWayChannelArn' => '<string>',
    'TwoWayChannelRole' => '<string>',
    'TwoWayEnabled' => true || false,
]

Result Details

Errors

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

CreateProtectConfiguration

$result = $client->createProtectConfiguration([/* ... */]);
$promise = $client->createProtectConfigurationAsync([/* ... */]);

Create a new protect configuration. By default all country rule sets for each capability are set to ALLOW. Update the country rule sets using UpdateProtectConfigurationCountryRuleSet. A protect configurations name is stored as a Tag with the key set to Name and value as the name of the protect configuration.

Parameter Syntax

$result = $client->createProtectConfiguration([
    'ClientToken' => '<string>',
    'DeletionProtectionEnabled' => true || false,
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'AccountDefault' => true || false,
    'CreatedTimestamp' => <DateTime>,
    'DeletionProtectionEnabled' => true || false,
    'ProtectConfigurationArn' => '<string>',
    'ProtectConfigurationId' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

CreateRegistration

$result = $client->createRegistration([/* ... */]);
$promise = $client->createRegistrationAsync([/* ... */]);

Creates a new registration based on the RegistrationType field.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AdditionalAttributes' => ['<string>', ...],
    'CreatedTimestamp' => <DateTime>,
    'CurrentVersionNumber' => <integer>,
    'RegistrationArn' => '<string>',
    'RegistrationId' => '<string>',
    'RegistrationStatus' => 'CREATED|SUBMITTED|REVIEWING|PROVISIONING|COMPLETE|REQUIRES_UPDATES|CLOSED|DELETED',
    'RegistrationType' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ValidationException:

A validation exception for a field.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

CreateRegistrationAssociation

$result = $client->createRegistrationAssociation([/* ... */]);
$promise = $client->createRegistrationAssociationAsync([/* ... */]);

Associate the registration with an origination identity such as a phone number or sender ID.

Parameter Syntax

$result = $client->createRegistrationAssociation([
    'RegistrationId' => '<string>', // REQUIRED
    'ResourceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'IsoCountryCode' => '<string>',
    'PhoneNumber' => '<string>',
    'RegistrationArn' => '<string>',
    'RegistrationId' => '<string>',
    'RegistrationType' => '<string>',
    'ResourceArn' => '<string>',
    'ResourceId' => '<string>',
    'ResourceType' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

CreateRegistrationAttachment

$result = $client->createRegistrationAttachment([/* ... */]);
$promise = $client->createRegistrationAttachmentAsync([/* ... */]);

Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed “letter of authorization” (LOA) to be submitted.

Parameter Syntax

$result = $client->createRegistrationAttachment([
    'AttachmentBody' => <string || resource || Psr\Http\Message\StreamInterface>,
    'AttachmentUrl' => '<string>',
    'ClientToken' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'AttachmentStatus' => 'UPLOAD_IN_PROGRESS|UPLOAD_COMPLETE|UPLOAD_FAILED|DELETED',
    'CreatedTimestamp' => <DateTime>,
    'RegistrationAttachmentArn' => '<string>',
    'RegistrationAttachmentId' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ValidationException:

A validation exception for a field.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

CreateRegistrationVersion

$result = $client->createRegistrationVersion([/* ... */]);
$promise = $client->createRegistrationVersionAsync([/* ... */]);

Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'RegistrationArn' => '<string>',
    'RegistrationId' => '<string>',
    'RegistrationVersionStatus' => 'DRAFT|SUBMITTED|REVIEWING|APPROVED|DISCARDED|DENIED|REVOKED|ARCHIVED',
    'RegistrationVersionStatusHistory' => [
        'ApprovedTimestamp' => <DateTime>,
        'ArchivedTimestamp' => <DateTime>,
        'DeniedTimestamp' => <DateTime>,
        'DiscardedTimestamp' => <DateTime>,
        'DraftTimestamp' => <DateTime>,
        'ReviewingTimestamp' => <DateTime>,
        'RevokedTimestamp' => <DateTime>,
        'SubmittedTimestamp' => <DateTime>,
    ],
    'VersionNumber' => <integer>,
]

Result Details

Errors

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

CreateVerifiedDestinationNumber

$result = $client->createVerifiedDestinationNumber([/* ... */]);
$promise = $client->createVerifiedDestinationNumberAsync([/* ... */]);

You can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination numbers.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CreatedTimestamp' => <DateTime>,
    'DestinationPhoneNumber' => '<string>',
    'Status' => 'PENDING|VERIFIED',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'VerifiedDestinationNumberArn' => '<string>',
    'VerifiedDestinationNumberId' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ValidationException:

A validation exception for a field.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DeleteAccountDefaultProtectConfiguration

$result = $client->deleteAccountDefaultProtectConfiguration([/* ... */]);
$promise = $client->deleteAccountDefaultProtectConfigurationAsync([/* ... */]);

Removes the current account default protect configuration.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DefaultProtectConfigurationArn' => '<string>',
    'DefaultProtectConfigurationId' => '<string>',
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DeleteConfigurationSet

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

Deletes an existing configuration set.

A configuration set is a set of rules that you apply to voice and SMS messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice and SMS messages.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ConfigurationSetArn' => '<string>',
    'ConfigurationSetName' => '<string>',
    'CreatedTimestamp' => <DateTime>,
    'DefaultMessageType' => 'TRANSACTIONAL|PROMOTIONAL',
    'DefaultSenderId' => '<string>',
    'EventDestinations' => [
        [
            'CloudWatchLogsDestination' => [
                'IamRoleArn' => '<string>',
                'LogGroupArn' => '<string>',
            ],
            'Enabled' => true || false,
            'EventDestinationName' => '<string>',
            'KinesisFirehoseDestination' => [
                'DeliveryStreamArn' => '<string>',
                'IamRoleArn' => '<string>',
            ],
            'MatchingEventTypes' => ['<string>', ...],
            'SnsDestination' => [
                'TopicArn' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DeleteDefaultMessageType

$result = $client->deleteDefaultMessageType([/* ... */]);
$promise = $client->deleteDefaultMessageTypeAsync([/* ... */]);

Deletes an existing default message type on a configuration set.

A message type is a type of messages that you plan to send. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ConfigurationSetArn' => '<string>',
    'ConfigurationSetName' => '<string>',
    'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DeleteDefaultSenderId

$result = $client->deleteDefaultSenderId([/* ... */]);
$promise = $client->deleteDefaultSenderIdAsync([/* ... */]);

Deletes an existing default sender ID on a configuration set.

A default sender ID is the identity that appears on recipients' devices when they receive SMS messages. Support for sender ID capabilities varies by country or region.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ConfigurationSetArn' => '<string>',
    'ConfigurationSetName' => '<string>',
    'SenderId' => '<string>',
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DeleteEventDestination

$result = $client->deleteEventDestination([/* ... */]);
$promise = $client->deleteEventDestinationAsync([/* ... */]);

Deletes an existing event destination.

An event destination is a location where you send response information about the messages that you send. For example, when a message is delivered successfully, you can send information about that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ConfigurationSetArn' => '<string>',
    'ConfigurationSetName' => '<string>',
    'EventDestination' => [
        'CloudWatchLogsDestination' => [
            'IamRoleArn' => '<string>',
            'LogGroupArn' => '<string>',
        ],
        'Enabled' => true || false,
        'EventDestinationName' => '<string>',
        'KinesisFirehoseDestination' => [
            'DeliveryStreamArn' => '<string>',
            'IamRoleArn' => '<string>',
        ],
        'MatchingEventTypes' => ['<string>', ...],
        'SnsDestination' => [
            'TopicArn' => '<string>',
        ],
    ],
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DeleteKeyword

$result = $client->deleteKeyword([/* ... */]);
$promise = $client->deleteKeywordAsync([/* ... */]);

Deletes an existing keyword from an origination phone number or pool.

A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.

Keywords "HELP" and "STOP" can't be deleted or modified.

Parameter Syntax

$result = $client->deleteKeyword([
    'Keyword' => '<string>', // REQUIRED
    'OriginationIdentity' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Keyword' => '<string>',
    'KeywordAction' => 'AUTOMATIC_RESPONSE|OPT_OUT|OPT_IN',
    'KeywordMessage' => '<string>',
    'OriginationIdentity' => '<string>',
    'OriginationIdentityArn' => '<string>',
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DeleteMediaMessageSpendLimitOverride

$result = $client->deleteMediaMessageSpendLimitOverride([/* ... */]);
$promise = $client->deleteMediaMessageSpendLimitOverrideAsync([/* ... */]);

Deletes an account-level monthly spending limit override for sending multimedia messages (MMS). Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Quotas for Server Migration Service in the Server Migration Service User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'MonthlyLimit' => <integer>,
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DeleteOptOutList

$result = $client->deleteOptOutList([/* ... */]);
$promise = $client->deleteOptOutListAsync([/* ... */]);

Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted.

If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an error is returned.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CreatedTimestamp' => <DateTime>,
    'OptOutListArn' => '<string>',
    'OptOutListName' => '<string>',
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DeleteOptedOutNumber

$result = $client->deleteOptedOutNumber([/* ... */]);
$promise = $client->deleteOptedOutNumberAsync([/* ... */]);

Deletes an existing opted out destination phone number from the specified opt-out list.

Each destination phone number can only be deleted once every 30 days.

If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an error is returned.

Parameter Syntax

$result = $client->deleteOptedOutNumber([
    'OptOutListName' => '<string>', // REQUIRED
    'OptedOutNumber' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EndUserOptedOut' => true || false,
    'OptOutListArn' => '<string>',
    'OptOutListName' => '<string>',
    'OptedOutNumber' => '<string>',
    'OptedOutTimestamp' => <DateTime>,
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DeletePool

$result = $client->deletePool([/* ... */]);
$promise = $client->deletePoolAsync([/* ... */]);

Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool.

If the pool status isn't active or if deletion protection is enabled, an error is returned.

A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CreatedTimestamp' => <DateTime>,
    'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
    'OptOutListName' => '<string>',
    'PoolArn' => '<string>',
    'PoolId' => '<string>',
    'SelfManagedOptOutsEnabled' => true || false,
    'SharedRoutesEnabled' => true || false,
    'Status' => 'CREATING|ACTIVE|DELETING',
    'TwoWayChannelArn' => '<string>',
    'TwoWayChannelRole' => '<string>',
    'TwoWayEnabled' => true || false,
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DeleteProtectConfiguration

$result = $client->deleteProtectConfiguration([/* ... */]);
$promise = $client->deleteProtectConfigurationAsync([/* ... */]);

Permanently delete the protect configuration. The protect configuration must have deletion protection disabled and must not be associated as the account default protect configuration or associated with a configuration set.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AccountDefault' => true || false,
    'CreatedTimestamp' => <DateTime>,
    'DeletionProtectionEnabled' => true || false,
    'ProtectConfigurationArn' => '<string>',
    'ProtectConfigurationId' => '<string>',
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DeleteRegistration

$result = $client->deleteRegistration([/* ... */]);
$promise = $client->deleteRegistrationAsync([/* ... */]);

Permanently delete an existing registration from your account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AdditionalAttributes' => ['<string>', ...],
    'ApprovedVersionNumber' => <integer>,
    'CreatedTimestamp' => <DateTime>,
    'CurrentVersionNumber' => <integer>,
    'LatestDeniedVersionNumber' => <integer>,
    'RegistrationArn' => '<string>',
    'RegistrationId' => '<string>',
    'RegistrationStatus' => 'CREATED|SUBMITTED|REVIEWING|PROVISIONING|COMPLETE|REQUIRES_UPDATES|CLOSED|DELETED',
    'RegistrationType' => '<string>',
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DeleteRegistrationAttachment

$result = $client->deleteRegistrationAttachment([/* ... */]);
$promise = $client->deleteRegistrationAttachmentAsync([/* ... */]);

Permanently delete the specified registration attachment.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AttachmentStatus' => 'UPLOAD_IN_PROGRESS|UPLOAD_COMPLETE|UPLOAD_FAILED|DELETED',
    'AttachmentUploadErrorReason' => 'INTERNAL_ERROR',
    'CreatedTimestamp' => <DateTime>,
    'RegistrationAttachmentArn' => '<string>',
    'RegistrationAttachmentId' => '<string>',
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DeleteRegistrationFieldValue

$result = $client->deleteRegistrationFieldValue([/* ... */]);
$promise = $client->deleteRegistrationFieldValueAsync([/* ... */]);

Delete the value in a registration form field.

Parameter Syntax

$result = $client->deleteRegistrationFieldValue([
    'FieldPath' => '<string>', // REQUIRED
    'RegistrationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'FieldPath' => '<string>',
    'RegistrationArn' => '<string>',
    'RegistrationAttachmentId' => '<string>',
    'RegistrationId' => '<string>',
    'SelectChoices' => ['<string>', ...],
    'TextValue' => '<string>',
    'VersionNumber' => <integer>,
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DeleteTextMessageSpendLimitOverride

$result = $client->deleteTextMessageSpendLimitOverride([/* ... */]);
$promise = $client->deleteTextMessageSpendLimitOverrideAsync([/* ... */]);

Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'MonthlyLimit' => <integer>,
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DeleteVerifiedDestinationNumber

$result = $client->deleteVerifiedDestinationNumber([/* ... */]);
$promise = $client->deleteVerifiedDestinationNumberAsync([/* ... */]);

Delete a verified destination phone number.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CreatedTimestamp' => <DateTime>,
    'DestinationPhoneNumber' => '<string>',
    'VerifiedDestinationNumberArn' => '<string>',
    'VerifiedDestinationNumberId' => '<string>',
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DeleteVoiceMessageSpendLimitOverride

$result = $client->deleteVoiceMessageSpendLimitOverride([/* ... */]);
$promise = $client->deleteVoiceMessageSpendLimitOverrideAsync([/* ... */]);

Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the EnforcedLimit equal to the MaxLimit, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'MonthlyLimit' => <integer>,
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DescribeAccountAttributes

$result = $client->describeAccountAttributes([/* ... */]);
$promise = $client->describeAccountAttributesAsync([/* ... */]);

Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request.

New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or voice recipients from fraud and abuse.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AccountAttributes' => [
        [
            'Name' => 'ACCOUNT_TIER|DEFAULT_PROTECT_CONFIGURATION_ID',
            'Value' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DescribeAccountLimits

$result = $client->describeAccountLimits([/* ... */]);
$promise = $client->describeAccountLimitsAsync([/* ... */]);

Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AccountLimits' => [
        [
            'Max' => <integer>,
            'Name' => 'PHONE_NUMBERS|POOLS|CONFIGURATION_SETS|OPT_OUT_LISTS|SENDER_IDS|REGISTRATIONS|REGISTRATION_ATTACHMENTS|VERIFIED_DESTINATION_NUMBERS',
            'Used' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DescribeConfigurationSets

$result = $client->describeConfigurationSets([/* ... */]);
$promise = $client->describeConfigurationSetsAsync([/* ... */]);

Describes the specified configuration sets or all in your account.

If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don't specify configuration set names or filters, the output includes information for all configuration sets.

If you specify a configuration set name that isn't valid, an error is returned.

Parameter Syntax

$result = $client->describeConfigurationSets([
    'ConfigurationSetNames' => ['<string>', ...],
    'Filters' => [
        [
            'Name' => 'event-destination-name|matching-event-types|default-message-type|default-sender-id|protect-configuration-id', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ConfigurationSets' => [
        [
            'ConfigurationSetArn' => '<string>',
            'ConfigurationSetName' => '<string>',
            'CreatedTimestamp' => <DateTime>,
            'DefaultMessageType' => 'TRANSACTIONAL|PROMOTIONAL',
            'DefaultSenderId' => '<string>',
            'EventDestinations' => [
                [
                    'CloudWatchLogsDestination' => [
                        'IamRoleArn' => '<string>',
                        'LogGroupArn' => '<string>',
                    ],
                    'Enabled' => true || false,
                    'EventDestinationName' => '<string>',
                    'KinesisFirehoseDestination' => [
                        'DeliveryStreamArn' => '<string>',
                        'IamRoleArn' => '<string>',
                    ],
                    'MatchingEventTypes' => ['<string>', ...],
                    'SnsDestination' => [
                        'TopicArn' => '<string>',
                    ],
                ],
                // ...
            ],
            'ProtectConfigurationId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DescribeKeywords

$result = $client->describeKeywords([/* ... */]);
$promise = $client->describeKeywordsAsync([/* ... */]);

Describes the specified keywords or all keywords on your origination phone number or pool.

A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.

If you specify a keyword that isn't valid, an error is returned.

Parameter Syntax

$result = $client->describeKeywords([
    'Filters' => [
        [
            'Name' => 'keyword-action', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Keywords' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OriginationIdentity' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Keywords' => [
        [
            'Keyword' => '<string>',
            'KeywordAction' => 'AUTOMATIC_RESPONSE|OPT_OUT|OPT_IN',
            'KeywordMessage' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'OriginationIdentity' => '<string>',
    'OriginationIdentityArn' => '<string>',
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DescribeOptOutLists

$result = $client->describeOptOutLists([/* ... */]);
$promise = $client->describeOptOutListsAsync([/* ... */]);

Describes the specified opt-out list or all opt-out lists in your account.

If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists.

If you specify an opt-out list name that isn't valid, an error is returned.

Parameter Syntax

$result = $client->describeOptOutLists([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OptOutListNames' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'OptOutLists' => [
        [
            'CreatedTimestamp' => <DateTime>,
            'OptOutListArn' => '<string>',
            'OptOutListName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DescribeOptedOutNumbers

$result = $client->describeOptedOutNumbers([/* ... */]);
$promise = $client->describeOptedOutNumbersAsync([/* ... */]);

Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.

If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list.

If you specify an opted out number that isn't valid, an error is returned.

Parameter Syntax

$result = $client->describeOptedOutNumbers([
    'Filters' => [
        [
            'Name' => 'end-user-opted-out', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OptOutListName' => '<string>', // REQUIRED
    'OptedOutNumbers' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'OptOutListArn' => '<string>',
    'OptOutListName' => '<string>',
    'OptedOutNumbers' => [
        [
            'EndUserOptedOut' => true || false,
            'OptedOutNumber' => '<string>',
            'OptedOutTimestamp' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DescribePhoneNumbers

$result = $client->describePhoneNumbers([/* ... */]);
$promise = $client->describePhoneNumbersAsync([/* ... */]);

Describes the specified origination phone number, or all the phone numbers in your account.

If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers.

If you specify a phone number ID that isn't valid, an error is returned.

Parameter Syntax

$result = $client->describePhoneNumbers([
    'Filters' => [
        [
            'Name' => 'status|iso-country-code|message-type|number-capability|number-type|two-way-enabled|self-managed-opt-outs-enabled|opt-out-list-name|deletion-protection-enabled|two-way-channel-arn', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PhoneNumberIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'PhoneNumbers' => [
        [
            'CreatedTimestamp' => <DateTime>,
            'DeletionProtectionEnabled' => true || false,
            'IsoCountryCode' => '<string>',
            'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
            'MonthlyLeasingPrice' => '<string>',
            'NumberCapabilities' => ['<string>', ...],
            'NumberType' => 'SHORT_CODE|LONG_CODE|TOLL_FREE|TEN_DLC|SIMULATOR',
            'OptOutListName' => '<string>',
            'PhoneNumber' => '<string>',
            'PhoneNumberArn' => '<string>',
            'PhoneNumberId' => '<string>',
            'PoolId' => '<string>',
            'RegistrationId' => '<string>',
            'SelfManagedOptOutsEnabled' => true || false,
            'Status' => 'PENDING|ACTIVE|ASSOCIATING|DISASSOCIATING|DELETED',
            'TwoWayChannelArn' => '<string>',
            'TwoWayChannelRole' => '<string>',
            'TwoWayEnabled' => true || false,
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DescribePools

$result = $client->describePools([/* ... */]);
$promise = $client->describePoolsAsync([/* ... */]);

Retrieves the specified pools or all pools associated with your Amazon Web Services account.

If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don't specify pool IDs or filters, the output includes information for all pools.

If you specify a pool ID that isn't valid, an error is returned.

A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.

Parameter Syntax

$result = $client->describePools([
    'Filters' => [
        [
            'Name' => 'status|message-type|two-way-enabled|self-managed-opt-outs-enabled|opt-out-list-name|shared-routes-enabled|deletion-protection-enabled|two-way-channel-arn', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PoolIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Pools' => [
        [
            'CreatedTimestamp' => <DateTime>,
            'DeletionProtectionEnabled' => true || false,
            'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
            'OptOutListName' => '<string>',
            'PoolArn' => '<string>',
            'PoolId' => '<string>',
            'SelfManagedOptOutsEnabled' => true || false,
            'SharedRoutesEnabled' => true || false,
            'Status' => 'CREATING|ACTIVE|DELETING',
            'TwoWayChannelArn' => '<string>',
            'TwoWayChannelRole' => '<string>',
            'TwoWayEnabled' => true || false,
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DescribeProtectConfigurations

$result = $client->describeProtectConfigurations([/* ... */]);
$promise = $client->describeProtectConfigurationsAsync([/* ... */]);

Retrieves the protect configurations that match any of filters. If a filter isn’t provided then all protect configurations are returned.

Parameter Syntax

$result = $client->describeProtectConfigurations([
    'Filters' => [
        [
            'Name' => 'account-default|deletion-protection-enabled', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ProtectConfigurationIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ProtectConfigurations' => [
        [
            'AccountDefault' => true || false,
            'CreatedTimestamp' => <DateTime>,
            'DeletionProtectionEnabled' => true || false,
            'ProtectConfigurationArn' => '<string>',
            'ProtectConfigurationId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DescribeRegistrationAttachments

$result = $client->describeRegistrationAttachments([/* ... */]);
$promise = $client->describeRegistrationAttachmentsAsync([/* ... */]);

Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.

Parameter Syntax

$result = $client->describeRegistrationAttachments([
    'Filters' => [
        [
            'Name' => 'attachment-status', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RegistrationAttachmentIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'RegistrationAttachments' => [
        [
            'AttachmentStatus' => 'UPLOAD_IN_PROGRESS|UPLOAD_COMPLETE|UPLOAD_FAILED|DELETED',
            'AttachmentUploadErrorReason' => 'INTERNAL_ERROR',
            'CreatedTimestamp' => <DateTime>,
            'RegistrationAttachmentArn' => '<string>',
            'RegistrationAttachmentId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DescribeRegistrationFieldDefinitions

$result = $client->describeRegistrationFieldDefinitions([/* ... */]);
$promise = $client->describeRegistrationFieldDefinitionsAsync([/* ... */]);

Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.

Parameter Syntax

$result = $client->describeRegistrationFieldDefinitions([
    'FieldPaths' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RegistrationType' => '<string>', // REQUIRED
    'SectionPath' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'RegistrationFieldDefinitions' => [
        [
            'DisplayHints' => [
                'DocumentationLink' => '<string>',
                'DocumentationTitle' => '<string>',
                'ExampleTextValue' => '<string>',
                'LongDescription' => '<string>',
                'SelectOptionDescriptions' => [
                    [
                        'Description' => '<string>',
                        'Option' => '<string>',
                        'Title' => '<string>',
                    ],
                    // ...
                ],
                'ShortDescription' => '<string>',
                'TextValidationDescription' => '<string>',
                'Title' => '<string>',
            ],
            'FieldPath' => '<string>',
            'FieldRequirement' => 'REQUIRED|CONDITIONAL|OPTIONAL',
            'FieldType' => 'SELECT|TEXT|ATTACHMENT',
            'SectionPath' => '<string>',
            'SelectValidation' => [
                'MaxChoices' => <integer>,
                'MinChoices' => <integer>,
                'Options' => ['<string>', ...],
            ],
            'TextValidation' => [
                'MaxLength' => <integer>,
                'MinLength' => <integer>,
                'Pattern' => '<string>',
            ],
        ],
        // ...
    ],
    'RegistrationType' => '<string>',
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DescribeRegistrationFieldValues

$result = $client->describeRegistrationFieldValues([/* ... */]);
$promise = $client->describeRegistrationFieldValuesAsync([/* ... */]);

Retrieves the specified registration field values.

Parameter Syntax

$result = $client->describeRegistrationFieldValues([
    'FieldPaths' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RegistrationId' => '<string>', // REQUIRED
    'SectionPath' => '<string>',
    'VersionNumber' => <integer>,
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'RegistrationArn' => '<string>',
    'RegistrationFieldValues' => [
        [
            'DeniedReason' => '<string>',
            'FieldPath' => '<string>',
            'RegistrationAttachmentId' => '<string>',
            'SelectChoices' => ['<string>', ...],
            'TextValue' => '<string>',
        ],
        // ...
    ],
    'RegistrationId' => '<string>',
    'VersionNumber' => <integer>,
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DescribeRegistrationSectionDefinitions

$result = $client->describeRegistrationSectionDefinitions([/* ... */]);
$promise = $client->describeRegistrationSectionDefinitionsAsync([/* ... */]);

Retrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type.

Parameter Syntax

$result = $client->describeRegistrationSectionDefinitions([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RegistrationType' => '<string>', // REQUIRED
    'SectionPaths' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'RegistrationSectionDefinitions' => [
        [
            'DisplayHints' => [
                'DocumentationLink' => '<string>',
                'DocumentationTitle' => '<string>',
                'LongDescription' => '<string>',
                'ShortDescription' => '<string>',
                'Title' => '<string>',
            ],
            'SectionPath' => '<string>',
        ],
        // ...
    ],
    'RegistrationType' => '<string>',
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DescribeRegistrationTypeDefinitions

$result = $client->describeRegistrationTypeDefinitions([/* ... */]);
$promise = $client->describeRegistrationTypeDefinitionsAsync([/* ... */]);

Retrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type.

Parameter Syntax

$result = $client->describeRegistrationTypeDefinitions([
    'Filters' => [
        [
            'Name' => 'supported-association-resource-type|supported-association-iso-country-code', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RegistrationTypes' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'RegistrationTypeDefinitions' => [
        [
            'DisplayHints' => [
                'DocumentationLink' => '<string>',
                'DocumentationTitle' => '<string>',
                'LongDescription' => '<string>',
                'ShortDescription' => '<string>',
                'Title' => '<string>',
            ],
            'RegistrationType' => '<string>',
            'SupportedAssociations' => [
                [
                    'AssociationBehavior' => 'ASSOCIATE_BEFORE_SUBMIT|ASSOCIATE_ON_APPROVAL|ASSOCIATE_AFTER_COMPLETE',
                    'DisassociationBehavior' => 'DISASSOCIATE_ALL_CLOSES_REGISTRATION|DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION|DELETE_REGISTRATION_DISASSOCIATES',
                    'IsoCountryCode' => '<string>',
                    'ResourceType' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DescribeRegistrationVersions

$result = $client->describeRegistrationVersions([/* ... */]);
$promise = $client->describeRegistrationVersionsAsync([/* ... */]);

Retrieves the specified registration version.

Parameter Syntax

$result = $client->describeRegistrationVersions([
    'Filters' => [
        [
            'Name' => 'registration-version-status', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RegistrationId' => '<string>', // REQUIRED
    'VersionNumbers' => [<integer>, ...],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'RegistrationArn' => '<string>',
    'RegistrationId' => '<string>',
    'RegistrationVersions' => [
        [
            'DeniedReasons' => [
                [
                    'DocumentationLink' => '<string>',
                    'DocumentationTitle' => '<string>',
                    'LongDescription' => '<string>',
                    'Reason' => '<string>',
                    'ShortDescription' => '<string>',
                ],
                // ...
            ],
            'RegistrationVersionStatus' => 'DRAFT|SUBMITTED|REVIEWING|APPROVED|DISCARDED|DENIED|REVOKED|ARCHIVED',
            'RegistrationVersionStatusHistory' => [
                'ApprovedTimestamp' => <DateTime>,
                'ArchivedTimestamp' => <DateTime>,
                'DeniedTimestamp' => <DateTime>,
                'DiscardedTimestamp' => <DateTime>,
                'DraftTimestamp' => <DateTime>,
                'ReviewingTimestamp' => <DateTime>,
                'RevokedTimestamp' => <DateTime>,
                'SubmittedTimestamp' => <DateTime>,
            ],
            'VersionNumber' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DescribeRegistrations

$result = $client->describeRegistrations([/* ... */]);
$promise = $client->describeRegistrationsAsync([/* ... */]);

Retrieves the specified registrations.

Parameter Syntax

$result = $client->describeRegistrations([
    'Filters' => [
        [
            'Name' => 'registration-type|registration-status', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RegistrationIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Registrations' => [
        [
            'AdditionalAttributes' => ['<string>', ...],
            'ApprovedVersionNumber' => <integer>,
            'CreatedTimestamp' => <DateTime>,
            'CurrentVersionNumber' => <integer>,
            'LatestDeniedVersionNumber' => <integer>,
            'RegistrationArn' => '<string>',
            'RegistrationId' => '<string>',
            'RegistrationStatus' => 'CREATED|SUBMITTED|REVIEWING|PROVISIONING|COMPLETE|REQUIRES_UPDATES|CLOSED|DELETED',
            'RegistrationType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DescribeSenderIds

$result = $client->describeSenderIds([/* ... */]);
$promise = $client->describeSenderIdsAsync([/* ... */]);

Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.

If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds.

f you specify a sender ID that isn't valid, an error is returned.

Parameter Syntax

$result = $client->describeSenderIds([
    'Filters' => [
        [
            'Name' => 'sender-id|iso-country-code|message-type|deletion-protection-enabled|registered', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SenderIds' => [
        [
            'IsoCountryCode' => '<string>', // REQUIRED
            'SenderId' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'SenderIds' => [
        [
            'DeletionProtectionEnabled' => true || false,
            'IsoCountryCode' => '<string>',
            'MessageTypes' => ['<string>', ...],
            'MonthlyLeasingPrice' => '<string>',
            'Registered' => true || false,
            'RegistrationId' => '<string>',
            'SenderId' => '<string>',
            'SenderIdArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DescribeSpendLimits

$result = $client->describeSpendLimits([/* ... */]);
$promise = $client->describeSpendLimitsAsync([/* ... */]);

Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.

When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'SpendLimits' => [
        [
            'EnforcedLimit' => <integer>,
            'MaxLimit' => <integer>,
            'Name' => 'TEXT_MESSAGE_MONTHLY_SPEND_LIMIT|VOICE_MESSAGE_MONTHLY_SPEND_LIMIT|MEDIA_MESSAGE_MONTHLY_SPEND_LIMIT',
            'Overridden' => true || false,
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DescribeVerifiedDestinationNumbers

$result = $client->describeVerifiedDestinationNumbers([/* ... */]);
$promise = $client->describeVerifiedDestinationNumbersAsync([/* ... */]);

Retrieves the specified verified destiona numbers.

Parameter Syntax

$result = $client->describeVerifiedDestinationNumbers([
    'DestinationPhoneNumbers' => ['<string>', ...],
    'Filters' => [
        [
            'Name' => 'status', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'VerifiedDestinationNumberIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'VerifiedDestinationNumbers' => [
        [
            'CreatedTimestamp' => <DateTime>,
            'DestinationPhoneNumber' => '<string>',
            'Status' => 'PENDING|VERIFIED',
            'VerifiedDestinationNumberArn' => '<string>',
            'VerifiedDestinationNumberId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DisassociateOriginationIdentity

$result = $client->disassociateOriginationIdentity([/* ... */]);
$promise = $client->disassociateOriginationIdentityAsync([/* ... */]);

Removes the specified origination identity from an existing pool.

If the origination identity isn't associated with the specified pool, an error is returned.

Parameter Syntax

$result = $client->disassociateOriginationIdentity([
    'ClientToken' => '<string>',
    'IsoCountryCode' => '<string>', // REQUIRED
    'OriginationIdentity' => '<string>', // REQUIRED
    'PoolId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'IsoCountryCode' => '<string>',
    'OriginationIdentity' => '<string>',
    'OriginationIdentityArn' => '<string>',
    'PoolArn' => '<string>',
    'PoolId' => '<string>',
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DisassociateProtectConfiguration

$result = $client->disassociateProtectConfiguration([/* ... */]);
$promise = $client->disassociateProtectConfigurationAsync([/* ... */]);

Disassociate a protect configuration from a configuration set.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ConfigurationSetArn' => '<string>',
    'ConfigurationSetName' => '<string>',
    'ProtectConfigurationArn' => '<string>',
    'ProtectConfigurationId' => '<string>',
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

DiscardRegistrationVersion

$result = $client->discardRegistrationVersion([/* ... */]);
$promise = $client->discardRegistrationVersionAsync([/* ... */]);

Discard the current version of the registration.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'RegistrationArn' => '<string>',
    'RegistrationId' => '<string>',
    'RegistrationVersionStatus' => 'DRAFT|SUBMITTED|REVIEWING|APPROVED|DISCARDED|DENIED|REVOKED|ARCHIVED',
    'RegistrationVersionStatusHistory' => [
        'ApprovedTimestamp' => <DateTime>,
        'ArchivedTimestamp' => <DateTime>,
        'DeniedTimestamp' => <DateTime>,
        'DiscardedTimestamp' => <DateTime>,
        'DraftTimestamp' => <DateTime>,
        'ReviewingTimestamp' => <DateTime>,
        'RevokedTimestamp' => <DateTime>,
        'SubmittedTimestamp' => <DateTime>,
    ],
    'VersionNumber' => <integer>,
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

GetProtectConfigurationCountryRuleSet

$result = $client->getProtectConfigurationCountryRuleSet([/* ... */]);
$promise = $client->getProtectConfigurationCountryRuleSetAsync([/* ... */]);

Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.

Parameter Syntax

$result = $client->getProtectConfigurationCountryRuleSet([
    'NumberCapability' => 'SMS|VOICE|MMS', // REQUIRED
    'ProtectConfigurationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CountryRuleSet' => [
        '<IsoCountryCode>' => [
            'ProtectStatus' => 'ALLOW|BLOCK',
        ],
        // ...
    ],
    'NumberCapability' => 'SMS|VOICE|MMS',
    'ProtectConfigurationArn' => '<string>',
    'ProtectConfigurationId' => '<string>',
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

ListPoolOriginationIdentities

$result = $client->listPoolOriginationIdentities([/* ... */]);
$promise = $client->listPoolOriginationIdentitiesAsync([/* ... */]);

Lists all associated origination identities in your pool.

If you specify filters, the output includes information for only those origination identities that meet the filter criteria.

Parameter Syntax

$result = $client->listPoolOriginationIdentities([
    'Filters' => [
        [
            'Name' => 'iso-country-code|number-capability', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PoolId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'OriginationIdentities' => [
        [
            'IsoCountryCode' => '<string>',
            'NumberCapabilities' => ['<string>', ...],
            'OriginationIdentity' => '<string>',
            'OriginationIdentityArn' => '<string>',
            'PhoneNumber' => '<string>',
        ],
        // ...
    ],
    'PoolArn' => '<string>',
    'PoolId' => '<string>',
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

ListRegistrationAssociations

$result = $client->listRegistrationAssociations([/* ... */]);
$promise = $client->listRegistrationAssociationsAsync([/* ... */]);

Retreive all of the origination identies that are associated with a registration.

Parameter Syntax

$result = $client->listRegistrationAssociations([
    'Filters' => [
        [
            'Name' => 'resource-type|iso-country-code', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RegistrationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'RegistrationArn' => '<string>',
    'RegistrationAssociations' => [
        [
            'IsoCountryCode' => '<string>',
            'PhoneNumber' => '<string>',
            'ResourceArn' => '<string>',
            'ResourceId' => '<string>',
            'ResourceType' => '<string>',
        ],
        // ...
    ],
    'RegistrationId' => '<string>',
    'RegistrationType' => '<string>',
]

Result Details

Errors

ThrottlingException:

An error that occurred because too many requests were sent during a certain amount of time.

AccessDeniedException:

The request was denied because you don't have sufficient permissions to access the resource.

ResourceNotFoundException:

A requested resource couldn't be found.

ValidationException:

A validation exception for a field.

InternalServerException:

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.