Amazon Pinpoint SMS Voice V2 2022-03-31
- Client: Aws\PinpointSMSVoiceV2\PinpointSMSVoiceV2Client
- Service ID: pinpoint-sms-voice-v2
- Version: 2022-03-31
This page describes the parameters and results for the operations of the Amazon Pinpoint SMS Voice V2 (2022-03-31), and shows how to use the Aws\PinpointSMSVoiceV2\PinpointSMSVoiceV2Client object to call the described operations. This documentation is specific to the 2022-03-31 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AssociateOriginationIdentity ( array $params = [] )
Associates the specified origination identity with a pool.
- CreateConfigurationSet ( array $params = [] )
Creates a new configuration set.
- CreateEventDestination ( array $params = [] )
Creates a new event destination in a configuration set.
- CreateOptOutList ( array $params = [] )
Creates a new opt-out list.
- CreatePool ( array $params = [] )
Creates a new pool and associates the specified origination identity to the pool.
- DeleteConfigurationSet ( array $params = [] )
Deletes an existing configuration set.
- DeleteDefaultMessageType ( array $params = [] )
Deletes an existing default message type on a configuration set.
- DeleteDefaultSenderId ( array $params = [] )
Deletes an existing default sender ID on a configuration set.
- DeleteEventDestination ( array $params = [] )
Deletes an existing event destination.
- DeleteKeyword ( array $params = [] )
Deletes an existing keyword from an origination phone number or pool.
- DeleteOptOutList ( array $params = [] )
Deletes an existing opt-out list.
- DeleteOptedOutNumber ( array $params = [] )
Deletes an existing opted out destination phone number from the specified opt-out list.
- DeletePool ( array $params = [] )
Deletes an existing pool.
- DeleteTextMessageSpendLimitOverride ( array $params = [] )
Deletes an account-level monthly spending limit override for sending text messages.
- DeleteVoiceMessageSpendLimitOverride ( array $params = [] )
Deletes an account level monthly spend limit override for sending voice messages.
- DescribeAccountAttributes ( array $params = [] )
Describes attributes of your Amazon Web Services account.
- DescribeAccountLimits ( array $params = [] )
Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account.
- DescribeConfigurationSets ( array $params = [] )
Describes the specified configuration sets or all in your account.
- DescribeKeywords ( array $params = [] )
Describes the specified keywords or all keywords on your origination phone number or pool.
- DescribeOptOutLists ( array $params = [] )
Describes the specified opt-out list or all opt-out lists in your account.
- DescribeOptedOutNumbers ( array $params = [] )
Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.
- DescribePhoneNumbers ( array $params = [] )
Describes the specified origination phone number, or all the phone numbers in your account.
- DescribePools ( array $params = [] )
Retrieves the specified pools or all pools associated with your Amazon Web Services account.
- DescribeSenderIds ( array $params = [] )
Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.
- DescribeSpendLimits ( array $params = [] )
Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.
- DisassociateOriginationIdentity ( array $params = [] )
Removes the specified origination identity from an existing pool.
- ListPoolOriginationIdentities ( array $params = [] )
Lists all associated origination identities in your pool.
- ListTagsForResource ( array $params = [] )
List all tags associated with a resource.
- PutKeyword ( array $params = [] )
Creates or updates a keyword configuration on an origination phone number or pool.
- PutOptedOutNumber ( array $params = [] )
Creates an opted out destination phone number in the opt-out list.
- ReleasePhoneNumber ( array $params = [] )
Releases an existing origination phone number in your account.
- RequestPhoneNumber ( array $params = [] )
Request an origination phone number for use in your account.
- SendTextMessage ( array $params = [] )
Creates a new text message and sends it to a recipient's phone number.
- SendVoiceMessage ( array $params = [] )
Allows you to send a request that sends a text message through Amazon Pinpoint.
- SetDefaultMessageType ( array $params = [] )
Sets the default message type on a configuration set.
- SetDefaultSenderId ( array $params = [] )
Sets default sender ID on a configuration set.
- SetTextMessageSpendLimitOverride ( array $params = [] )
Sets an account level monthly spend limit override for sending text messages.
- SetVoiceMessageSpendLimitOverride ( array $params = [] )
Sets an account level monthly spend limit override for sending voice messages.
- TagResource ( array $params = [] )
Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource.
- UntagResource ( array $params = [] )
Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource.
- UpdateEventDestination ( array $params = [] )
Updates an existing event destination in a configuration set.
- UpdatePhoneNumber ( array $params = [] )
Updates the configuration of an existing origination phone number.
- UpdatePool ( array $params = [] )
Updates the configuration of an existing pool.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
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
Members
- ClientToken
-
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
- IsoCountryCode
-
- Required: Yes
- Type: string
The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the origination identity.
- OriginationIdentity
-
- Required: Yes
- Type: string
The origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId, or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
- PoolId
-
- Required: Yes
- Type: string
The pool to update with the new Identity. This value can be either the PoolId or PoolArn, and you can find these values using DescribePools.
Result Syntax
[
'IsoCountryCode' => '<string>',
'OriginationIdentity' => '<string>',
'OriginationIdentityArn' => '<string>',
'PoolArn' => '<string>',
'PoolId' => '<string>',
]
Result Details
Members
- IsoCountryCode
-
- Type: string
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- OriginationIdentity
-
- Type: string
The PhoneNumberId or SenderId of the origination identity.
- OriginationIdentityArn
-
- Type: string
The PhoneNumberArn or SenderIdArn of the origination identity.
- PoolArn
-
- Type: string
The Amazon Resource Name (ARN) of the pool that is now associated with the origination identity.
- PoolId
-
- Type: string
The PoolId of the pool that is now associated with the origination identity.
Errors
-
ServiceQuotaExceededException:
The request would cause a service quota to be exceeded.
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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.
-
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
Members
- ClientToken
-
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
- ConfigurationSetName
-
- Required: Yes
- Type: string
The name to use for the new configuration set.
- Tags
-
- Type: Array of Tag structures
An array of key and value pair tags that's associated with the new configuration set.
Result Syntax
[
'ConfigurationSetArn' => '<string>',
'ConfigurationSetName' => '<string>',
'CreatedTimestamp' => <DateTime>,
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- ConfigurationSetArn
-
- Type: string
The Amazon Resource Name (ARN) of the newly created configuration set.
- ConfigurationSetName
-
- Type: string
The name of the new configuration set.
- CreatedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the configuration set was created, in UNIX epoch time format.
- Tags
-
- Type: Array of Tag structures
An array of key and value pair tags that's associated with the configuration set.
Errors
-
ServiceQuotaExceededException:
The request would cause a service quota to be exceeded.
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A validation exception for a field.
-
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.
-
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
Members
- ClientToken
-
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
- CloudWatchLogsDestination
-
- Type: CloudWatchLogsDestination structure
An object that contains information about an event destination for logging to Amazon CloudWatch logs.
- ConfigurationSetName
-
- Required: Yes
- Type: string
Either the name of the configuration set or the configuration set ARN to apply event logging to. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
- EventDestinationName
-
- Required: Yes
- Type: string
The name that identifies the event destination.
- KinesisFirehoseDestination
-
- Type: KinesisFirehoseDestination structure
An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
- MatchingEventTypes
-
- Required: Yes
- Type: Array of strings
An array of event types that determine which events to log. If "ALL" is used, then Amazon Pinpoint logs every event type.
- SnsDestination
-
- Type: SnsDestination structure
An object that contains information about an event destination for logging to Amazon SNS.
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
Members
- ConfigurationSetArn
-
- Type: string
The ARN of the configuration set.
- ConfigurationSetName
-
- Type: string
The name of the configuration set.
- EventDestination
-
- Type: EventDestination structure
The details of the destination where events are logged.
Errors
-
ServiceQuotaExceededException:
The request would cause a service quota to be exceeded.
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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.
-
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
Members
- ClientToken
-
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
- OptOutListName
-
- Required: Yes
- Type: string
The name of the new OptOutList.
- Tags
-
- Type: Array of Tag structures
An array of tags (key and value pairs) to associate with the new OptOutList.
Result Syntax
[
'CreatedTimestamp' => <DateTime>,
'OptOutListArn' => '<string>',
'OptOutListName' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- CreatedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the pool was created, in UNIX epoch time format.
- OptOutListArn
-
- Type: string
The Amazon Resource Name (ARN) for the OptOutList.
- OptOutListName
-
- Type: string
The name of the new OptOutList.
- Tags
-
- Type: Array of Tag structures
An array of tags (key and value pairs) associated with the new OptOutList.
Errors
-
ServiceQuotaExceededException:
The request would cause a service quota to be exceeded.
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A validation exception for a field.
-
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.
-
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
Members
- ClientToken
-
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
- DeletionProtectionEnabled
-
- Type: boolean
By default this is set to false. When set to true the pool can't be deleted. You can change this value using the UpdatePool action.
- IsoCountryCode
-
- Required: Yes
- Type: string
The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.
- MessageType
-
- Required: Yes
- Type: string
The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- OriginationIdentity
-
- Required: Yes
- Type: string
The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
- Tags
-
- Type: Array of Tag structures
An array of tags (key and value pairs) associated with the pool.
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>',
'TwoWayEnabled' => true || false,
]
Result Details
Members
- CreatedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the pool was created, in UNIX epoch time format.
- DeletionProtectionEnabled
-
- Type: boolean
When set to true deletion protection is enabled. By default this is set to false.
- MessageType
-
- Type: string
The type of message for the pool to use.
- OptOutListName
-
- Type: string
The name of the OptOutList associated with the pool.
- PoolArn
-
- Type: string
The Amazon Resource Name (ARN) for the pool.
- PoolId
-
- Type: string
The unique identifier for the pool.
- SelfManagedOptOutsEnabled
-
- Type: boolean
By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
- SharedRoutesEnabled
-
- Type: boolean
Indicates whether shared routes are enabled for the pool.
- Status
-
- Type: string
The current status of the pool.
-
CREATING: The pool is currently being created and isn't yet available for use.
-
ACTIVE: The pool is active and available for use.
-
DELETING: The pool is being deleted.
- Tags
-
- Type: Array of Tag structures
An array of tags (key and value pairs) associated with the pool.
- TwoWayChannelArn
-
- Type: string
The Amazon Resource Name (ARN) of the two way channel.
- TwoWayEnabled
-
- Type: boolean
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
Errors
-
ServiceQuotaExceededException:
The request would cause a service quota to be exceeded.
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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.
-
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
Members
- ConfigurationSetName
-
- Required: Yes
- Type: string
The name of the configuration set or the configuration set ARN that you want to delete. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
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
Members
- ConfigurationSetArn
-
- Type: string
The Amazon Resource Name (ARN) of the deleted configuration set.
- ConfigurationSetName
-
- Type: string
The name of the deleted configuration set.
- CreatedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the deleted configuration set was created in UNIX epoch time format.
- DefaultMessageType
-
- Type: string
The default message type of the configuration set that was deleted.
- DefaultSenderId
-
- Type: string
The default Sender ID of the configuration set that was deleted.
- EventDestinations
-
- Type: Array of EventDestination structures
An array of any EventDestination objects that were associated with the deleted configuration set.
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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
Members
- ConfigurationSetName
-
- Required: Yes
- Type: string
The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default message type from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
Result Syntax
[
'ConfigurationSetArn' => '<string>',
'ConfigurationSetName' => '<string>',
'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
]
Result Details
Members
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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
Members
- ConfigurationSetName
-
- Required: Yes
- Type: string
The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default sender ID from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
Result Syntax
[
'ConfigurationSetArn' => '<string>',
'ConfigurationSetName' => '<string>',
'SenderId' => '<string>',
]
Result Details
Members
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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
Members
- ConfigurationSetName
-
- Required: Yes
- Type: string
The name of the configuration set or the configuration set's Amazon Resource Name (ARN) to remove the event destination from. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
- EventDestinationName
-
- Required: Yes
- Type: string
The name of the event destination to delete.
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
Members
- ConfigurationSetArn
-
- Type: string
The Amazon Resource Name (ARN) of the configuration set.
- ConfigurationSetName
-
- Type: string
The name of the configuration set the event destination was deleted from.
- EventDestination
-
- Type: EventDestination structure
The event destination object that was deleted.
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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
Members
- Keyword
-
- Required: Yes
- Type: string
The keyword to delete.
- OriginationIdentity
-
- Required: Yes
- Type: string
The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or PoolArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn and DescribePools to find the values of PoolId and PoolArn.
Result Syntax
[
'Keyword' => '<string>',
'KeywordAction' => 'AUTOMATIC_RESPONSE|OPT_OUT|OPT_IN',
'KeywordMessage' => '<string>',
'OriginationIdentity' => '<string>',
'OriginationIdentityArn' => '<string>',
]
Result Details
Members
- Keyword
-
- Type: string
The keyword that was deleted.
- KeywordAction
-
- Type: string
The action that was associated with the deleted keyword.
- KeywordMessage
-
- Type: string
The message that was associated with the deleted keyword.
- OriginationIdentity
-
- Type: string
The PhoneNumberId or PoolId that the keyword was associated with.
- OriginationIdentityArn
-
- Type: string
The PhoneNumberArn or PoolArn that the keyword was associated with.
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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.
-
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
Members
- OptOutListName
-
- Required: Yes
- Type: string
The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
Result Syntax
[
'CreatedTimestamp' => <DateTime>,
'OptOutListArn' => '<string>',
'OptOutListName' => '<string>',
]
Result Details
Members
- CreatedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the OptOutList was created, in UNIX epoch time format.
- OptOutListArn
-
- Type: string
The Amazon Resource Name (ARN) of the OptOutList that was removed.
- OptOutListName
-
- Type: string
The name of the OptOutList that was removed.
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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.
-
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
Members
Result Syntax
[
'EndUserOptedOut' => true || false,
'OptOutListArn' => '<string>',
'OptOutListName' => '<string>',
'OptedOutNumber' => '<string>',
'OptedOutTimestamp' => <DateTime>,
]
Result Details
Members
- EndUserOptedOut
-
- Type: boolean
This is true if it was the end user who requested their phone number be removed.
- OptOutListArn
-
- Type: string
The OptOutListArn that the phone number was removed from.
- OptOutListName
-
- Type: string
The OptOutListName that the phone number was removed from.
- OptedOutNumber
-
- Type: string
The phone number that was removed from the OptOutList.
- OptedOutTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the number was removed at, in UNIX epoch time format.
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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.
-
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
Members
- PoolId
-
- Required: Yes
- Type: string
The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .
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>',
'TwoWayEnabled' => true || false,
]
Result Details
Members
- CreatedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the pool was created, in UNIX epoch time format.
- MessageType
-
- Type: string
The message type that was associated with the deleted pool.
- OptOutListName
-
- Type: string
The name of the OptOutList that was associated with the deleted pool.
- PoolArn
-
- Type: string
The Amazon Resource Name (ARN) of the pool that was deleted.
- PoolId
-
- Type: string
The PoolId of the pool that was deleted.
- SelfManagedOptOutsEnabled
-
- Type: boolean
By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
- SharedRoutesEnabled
-
- Type: boolean
Indicates whether shared routes are enabled for the pool.
- Status
-
- Type: string
The current status of the pool.
-
CREATING: The pool is currently being created and isn't yet available for use.
-
ACTIVE: The pool is active and available for use.
-
DELETING: The pool is being deleted.
- TwoWayChannelArn
-
- Type: string
The Amazon Resource Name (ARN) of the TwoWayChannel.
- TwoWayEnabled
-
- Type: boolean
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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.
-
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
Members
Result Syntax
[
'MonthlyLimit' => <integer>,
]
Result Details
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A validation exception for a field.
-
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
Members
Result Syntax
[
'MonthlyLimit' => <integer>,
]
Result Details
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A validation exception for a field.
-
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
Members
Result Syntax
[
'AccountAttributes' => [
[
'Name' => 'ACCOUNT_TIER',
'Value' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- AccountAttributes
-
- Type: Array of AccountAttribute structures
An array of AccountAttributes objects.
- NextToken
-
- Type: string
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A validation exception for a field.
-
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
Members
Result Syntax
[
'AccountLimits' => [
[
'Max' => <integer>,
'Name' => 'PHONE_NUMBERS|POOLS|CONFIGURATION_SETS|OPT_OUT_LISTS',
'Used' => <integer>,
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- AccountLimits
-
- Type: Array of AccountLimit structures
An array of AccountLimit objects that show the current spend limits.
- NextToken
-
- Type: string
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A validation exception for a field.
-
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', // REQUIRED
'Values' => ['<string>', ...], // REQUIRED
],
// ...
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- ConfigurationSetNames
-
- Type: Array of strings
An array of strings. Each element can be either a ConfigurationSetName or ConfigurationSetArn.
- Filters
-
- Type: Array of ConfigurationSetFilter structures
An array of filters to apply to the results that are returned.
- MaxResults
-
- Type: int
The maximum number of results to return per each request.
- NextToken
-
- Type: string
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
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>',
],
],
// ...
],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- ConfigurationSets
-
- Type: Array of ConfigurationSetInformation structures
An array of ConfigurationSets objects.
- NextToken
-
- Type: string
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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
Members
- Filters
-
- Type: Array of KeywordFilter structures
An array of keyword filters to filter the results.
- Keywords
-
- Type: Array of strings
An array of keywords to search for.
- MaxResults
-
- Type: int
The maximum number of results to return per each request.
- NextToken
-
- Type: string
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- OriginationIdentity
-
- Required: Yes
- Type: string
The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
Result Syntax
[
'Keywords' => [
[
'Keyword' => '<string>',
'KeywordAction' => 'AUTOMATIC_RESPONSE|OPT_OUT|OPT_IN',
'KeywordMessage' => '<string>',
],
// ...
],
'NextToken' => '<string>',
'OriginationIdentity' => '<string>',
'OriginationIdentityArn' => '<string>',
]
Result Details
Members
- Keywords
-
- Type: Array of KeywordInformation structures
An array of KeywordInformation objects that contain the results.
- NextToken
-
- Type: string
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
- OriginationIdentity
-
- Type: string
The PhoneNumberId or PoolId that is associated with the OriginationIdentity.
- OriginationIdentityArn
-
- Type: string
The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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
Members
- MaxResults
-
- Type: int
The maximum number of results to return per each request.
- NextToken
-
- Type: string
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- OptOutListNames
-
- Type: Array of strings
The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.
Result Syntax
[
'NextToken' => '<string>',
'OptOutLists' => [
[
'CreatedTimestamp' => <DateTime>,
'OptOutListArn' => '<string>',
'OptOutListName' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
- OptOutLists
-
- Type: Array of OptOutListInformation structures
An array of OptOutListInformation objects that contain the details for the requested OptOutLists.
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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
Members
- Filters
-
- Type: Array of OptedOutFilter structures
An array of OptedOutFilter objects to filter the results on.
- MaxResults
-
- Type: int
The maximum number of results to return per each request.
- NextToken
-
- Type: string
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- OptOutListName
-
- Required: Yes
- Type: string
The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
- OptedOutNumbers
-
- Type: Array of strings
An array of phone numbers to search for in the OptOutList.
Result Syntax
[
'NextToken' => '<string>',
'OptOutListArn' => '<string>',
'OptOutListName' => '<string>',
'OptedOutNumbers' => [
[
'EndUserOptedOut' => true || false,
'OptedOutNumber' => '<string>',
'OptedOutTimestamp' => <DateTime>,
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
- OptOutListArn
-
- Type: string
The Amazon Resource Name (ARN) of the OptOutList.
- OptOutListName
-
- Type: string
The name of the OptOutList.
- OptedOutNumbers
-
- Type: Array of OptedOutNumberInformation structures
An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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', // REQUIRED
'Values' => ['<string>', ...], // REQUIRED
],
// ...
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
'PhoneNumberIds' => ['<string>', ...],
]);
Parameter Details
Members
- Filters
-
- Type: Array of PhoneNumberFilter structures
An array of PhoneNumberFilter objects to filter the results.
- MaxResults
-
- Type: int
The maximum number of results to return per each request.
- NextToken
-
- Type: string
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- PhoneNumberIds
-
- Type: Array of strings
The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.
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',
'OptOutListName' => '<string>',
'PhoneNumber' => '<string>',
'PhoneNumberArn' => '<string>',
'PhoneNumberId' => '<string>',
'PoolId' => '<string>',
'SelfManagedOptOutsEnabled' => true || false,
'Status' => 'PENDING|ACTIVE|ASSOCIATING|DISASSOCIATING|DELETED',
'TwoWayChannelArn' => '<string>',
'TwoWayEnabled' => true || false,
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
- PhoneNumbers
-
- Type: Array of PhoneNumberInformation structures
An array of PhoneNumberInformation objects that contain the details for the requested phone numbers.
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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', // REQUIRED
'Values' => ['<string>', ...], // REQUIRED
],
// ...
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
'PoolIds' => ['<string>', ...],
]);
Parameter Details
Members
- Filters
-
- Type: Array of PoolFilter structures
An array of PoolFilter objects to filter the results.
- MaxResults
-
- Type: int
The maximum number of results to return per each request.
- NextToken
-
- Type: string
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- PoolIds
-
- Type: Array of strings
The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.
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>',
'TwoWayEnabled' => true || false,
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
- Pools
-
- Type: Array of PoolInformation structures
An array of PoolInformation objects that contain the details for the requested pools.
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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', // REQUIRED
'Values' => ['<string>', ...], // REQUIRED
],
// ...
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
'SenderIds' => [
[
'IsoCountryCode' => '<string>', // REQUIRED
'SenderId' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- Filters
-
- Type: Array of SenderIdFilter structures
An array of SenderIdFilter objects to filter the results.
- MaxResults
-
- Type: int
The maximum number of results to return per each request.
- NextToken
-
- Type: string
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- SenderIds
-
- Type: Array of SenderIdAndCountry structures
An array of SenderIdAndCountry objects to search for.
Result Syntax
[
'NextToken' => '<string>',
'SenderIds' => [
[
'IsoCountryCode' => '<string>',
'MessageTypes' => ['<string>', ...],
'MonthlyLeasingPrice' => '<string>',
'SenderId' => '<string>',
'SenderIdArn' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
- SenderIds
-
- Type: Array of SenderIdInformation structures
An array of SernderIdInformation objects that contain the details for the requested SenderIds.
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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
Members
Result Syntax
[
'NextToken' => '<string>',
'SpendLimits' => [
[
'EnforcedLimit' => <integer>,
'MaxLimit' => <integer>,
'Name' => 'TEXT_MESSAGE_MONTHLY_SPEND_LIMIT|VOICE_MESSAGE_MONTHLY_SPEND_LIMIT',
'Overridden' => true || false,
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
- SpendLimits
-
- Type: Array of SpendLimit structures
An array of SpendLimit objects that contain the details for the requested spend limits.
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A validation exception for a field.
-
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
Members
- ClientToken
-
- Type: string
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
- IsoCountryCode
-
- Required: Yes
- Type: string
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- OriginationIdentity
-
- Required: Yes
- Type: string
The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers find the values for PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the values for SenderId and SenderIdArn.
- PoolId
-
- Required: Yes
- Type: string
The unique identifier for the pool to disassociate with the origination identity. This value can be either the PoolId or PoolArn.
Result Syntax
[
'IsoCountryCode' => '<string>',
'OriginationIdentity' => '<string>',
'OriginationIdentityArn' => '<string>',
'PoolArn' => '<string>',
'PoolId' => '<string>',
]
Result Details
Members
- IsoCountryCode
-
- Type: string
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- OriginationIdentity
-
- Type: string
The PhoneNumberId or SenderId of the origination identity.
- OriginationIdentityArn
-
- Type: string
The PhoneNumberArn or SenderIdArn of the origination identity.
- PoolArn
-
- Type: string
The Amazon Resource Name (ARN) of the pool.
- PoolId
-
- Type: string
The PoolId of the pool no longer associated with the origination identity.
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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.
-
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
Members
- Filters
-
- Type: Array of PoolOriginationIdentitiesFilter structures
An array of PoolOriginationIdentitiesFilter objects to filter the results..
- MaxResults
-
- Type: int
The maximum number of results to return per each request.
- NextToken
-
- Type: string
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
- PoolId
-
- Required: Yes
- Type: string
The unique identifier for the pool. This value can be either the PoolId or PoolArn.
Result Syntax
[
'NextToken' => '<string>',
'OriginationIdentities' => [
[
'IsoCountryCode' => '<string>',
'NumberCapabilities' => ['<string>', ...],
'OriginationIdentity' => '<string>',
'OriginationIdentityArn' => '<string>',
],
// ...
],
'PoolArn' => '<string>',
'PoolId' => '<string>',
]
Result Details
Members
- NextToken
-
- Type: string
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
- OriginationIdentities
-
- Type: Array of OriginationIdentityMetadata structures
An array of any OriginationIdentityMetadata objects.
- PoolArn
-
- Type: string
The Amazon Resource Name (ARN) for the pool.
- PoolId
-
- Type: string
The unique PoolId of the pool.
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
List all tags associated with a resource.
Parameter Syntax
$result = $client->listTagsForResource([
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ResourceArn' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- ResourceArn
-
- Type: string
The ARN of the resource.
- Tags
-
- Type: Array of Tag structures
An array of key and value pair tags that are associated with the resource.
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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.
PutKeyword
$result = $client->putKeyword([/* ... */]); $promise = $client->putKeywordAsync([/* ... */]);
Creates or updates a keyword configuration on 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.
If you specify a keyword that isn't valid, an Error is returned.
Parameter Syntax
$result = $client->putKeyword([
'Keyword' => '<string>', // REQUIRED
'KeywordAction' => 'AUTOMATIC_RESPONSE|OPT_OUT|OPT_IN',
'KeywordMessage' => '<string>', // REQUIRED
'OriginationIdentity' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Keyword
-
- Required: Yes
- Type: string
The new keyword to add.
- KeywordAction
-
- Type: string
The action to perform for the new keyword when it is received.
- KeywordMessage
-
- Required: Yes
- Type: string
The message associated with the keyword.
-
AUTOMATIC_RESPONSE: A message is sent to the recipient.
-
OPT_OUT: Keeps the recipient from receiving future messages.
-
OPT_IN: The recipient wants to receive future messages.
- OriginationIdentity
-
- Required: Yes
- Type: string
The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers get the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
Result Syntax
[
'Keyword' => '<string>',
'KeywordAction' => 'AUTOMATIC_RESPONSE|OPT_OUT|OPT_IN',
'KeywordMessage' => '<string>',
'OriginationIdentity' => '<string>',
'OriginationIdentityArn' => '<string>',
]
Result Details
Members
- Keyword
-
- Type: string
The keyword that was added.
- KeywordAction
-
- Type: string
The action to perform when the keyword is used.
- KeywordMessage
-
- Type: string
The message associated with the keyword.
- OriginationIdentity
-
- Type: string
The PhoneNumberId or PoolId that the keyword was associated with.
- OriginationIdentityArn
-
- Type: string
The PhoneNumberArn or PoolArn that the keyword was associated with.
Errors
-
ServiceQuotaExceededException:
The request would cause a service quota to be exceeded.
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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.
-
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.
PutOptedOutNumber
$result = $client->putOptedOutNumber([/* ... */]); $promise = $client->putOptedOutNumberAsync([/* ... */]);
Creates an opted out destination phone number in the opt-out list.
If the destination phone number isn't valid or if the specified opt-out list doesn't exist, an Error is returned.
Parameter Syntax
$result = $client->putOptedOutNumber([
'OptOutListName' => '<string>', // REQUIRED
'OptedOutNumber' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'EndUserOptedOut' => true || false,
'OptOutListArn' => '<string>',
'OptOutListName' => '<string>',
'OptedOutNumber' => '<string>',
'OptedOutTimestamp' => <DateTime>,
]
Result Details
Members
- EndUserOptedOut
-
- Type: boolean
This is true if it was the end user who requested their phone number be removed.
- OptOutListArn
-
- Type: string
The OptOutListArn that the phone number was removed from.
- OptOutListName
-
- Type: string
The OptOutListName that the phone number was removed from.
- OptedOutNumber
-
- Type: string
The phone number that was added to the OptOutList.
- OptedOutTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the phone number was added to the OptOutList, in UNIX epoch time format.
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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.
ReleasePhoneNumber
$result = $client->releasePhoneNumber([/* ... */]); $promise = $client->releasePhoneNumberAsync([/* ... */]);
Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages.
If the origination phone number has deletion protection enabled or is associated with a pool, an Error is returned.
Parameter Syntax
$result = $client->releasePhoneNumber([
'PhoneNumberId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- PhoneNumberId
-
- Required: Yes
- Type: string
The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and PhoneNumberArn.
Result Syntax
[
'CreatedTimestamp' => <DateTime>,
'IsoCountryCode' => '<string>',
'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
'MonthlyLeasingPrice' => '<string>',
'NumberCapabilities' => ['<string>', ...],
'NumberType' => 'SHORT_CODE|LONG_CODE|TOLL_FREE|TEN_DLC',
'OptOutListName' => '<string>',
'PhoneNumber' => '<string>',
'PhoneNumberArn' => '<string>',
'PhoneNumberId' => '<string>',
'SelfManagedOptOutsEnabled' => true || false,
'Status' => 'PENDING|ACTIVE|ASSOCIATING|DISASSOCIATING|DELETED',
'TwoWayChannelArn' => '<string>',
'TwoWayEnabled' => true || false,
]
Result Details
Members
- CreatedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the phone number was created, in UNIX epoch time format.
- IsoCountryCode
-
- Type: string
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- MessageType
-
- Type: string
The message type that was associated with the phone number.
- MonthlyLeasingPrice
-
- Type: string
The monthly price of the phone number, in US dollars.
- NumberCapabilities
-
- Type: Array of strings
Specifies if the number could be used for text messages, voice, or both.
- NumberType
-
- Type: string
The type of number that was released.
- OptOutListName
-
- Type: string
The name of the OptOutList that was associated with the phone number.
- PhoneNumber
-
- Type: string
The phone number that was released.
- PhoneNumberArn
-
- Type: string
The PhoneNumberArn of the phone number that was released.
- PhoneNumberId
-
- Type: string
The PhoneNumberId of the phone number that was released.
- SelfManagedOptOutsEnabled
-
- Type: boolean
By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
- Status
-
- Type: string
The current status of the request.
- TwoWayChannelArn
-
- Type: string
The Amazon Resource Name (ARN) of the TwoWayChannel.
- TwoWayEnabled
-
- Type: boolean
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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.
-
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.
RequestPhoneNumber
$result = $client->requestPhoneNumber([/* ... */]); $promise = $client->requestPhoneNumberAsync([/* ... */]);
Request an origination phone number for use in your account. For more information on phone number request see Requesting a number in the Amazon Pinpoint User Guide.
Parameter Syntax
$result = $client->requestPhoneNumber([
'ClientToken' => '<string>',
'DeletionProtectionEnabled' => true || false,
'IsoCountryCode' => '<string>', // REQUIRED
'MessageType' => 'TRANSACTIONAL|PROMOTIONAL', // REQUIRED
'NumberCapabilities' => ['<string>', ...], // REQUIRED
'NumberType' => 'LONG_CODE|TOLL_FREE|TEN_DLC', // REQUIRED
'OptOutListName' => '<string>',
'PoolId' => '<string>',
'RegistrationId' => '<string>',
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ClientToken
-
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
- DeletionProtectionEnabled
-
- Type: boolean
By default this is set to false. When set to true the phone number can't be deleted.
- IsoCountryCode
-
- Required: Yes
- Type: string
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- MessageType
-
- Required: Yes
- Type: string
The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- NumberCapabilities
-
- Required: Yes
- Type: Array of strings
Indicates if the phone number will be used for text messages, voice messages, or both.
- NumberType
-
- Required: Yes
- Type: string
The type of phone number to request.
- OptOutListName
-
- Type: string
The name of the OptOutList to associate with the phone number. You can use the OutOutListName or OptPutListArn.
- PoolId
-
- Type: string
The pool to associated with the phone number. You can use the PoolId or PoolArn.
- RegistrationId
-
- Type: string
Use this field to attach your phone number for an external registration process.
- Tags
-
- Type: Array of Tag structures
An array of tags (key and value pairs) associate with the requested phone number.
Result Syntax
[
'CreatedTimestamp' => <DateTime>,
'DeletionProtectionEnabled' => true || false,
'IsoCountryCode' => '<string>',
'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
'MonthlyLeasingPrice' => '<string>',
'NumberCapabilities' => ['<string>', ...],
'NumberType' => 'LONG_CODE|TOLL_FREE|TEN_DLC',
'OptOutListName' => '<string>',
'PhoneNumber' => '<string>',
'PhoneNumberArn' => '<string>',
'PhoneNumberId' => '<string>',
'PoolId' => '<string>',
'SelfManagedOptOutsEnabled' => true || false,
'Status' => 'PENDING|ACTIVE|ASSOCIATING|DISASSOCIATING|DELETED',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'TwoWayChannelArn' => '<string>',
'TwoWayEnabled' => true || false,
]
Result Details
Members
- CreatedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the phone number was created, in UNIX epoch time format.
- DeletionProtectionEnabled
-
- Type: boolean
By default this is set to false. When set to true the phone number can't be deleted.
- IsoCountryCode
-
- Type: string
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- MessageType
-
- Type: string
The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- MonthlyLeasingPrice
-
- Type: string
The monthly price, in US dollars, to lease the phone number.
- NumberCapabilities
-
- Type: Array of strings
Indicates if the phone number will be used for text messages, voice messages or both.
- NumberType
-
- Type: string
The type of number that was released.
- OptOutListName
-
- Type: string
The name of the OptOutList that is associated with the requested phone number.
- PhoneNumber
-
- Type: string
The new phone number that was requested.
- PhoneNumberArn
-
- Type: string
The Amazon Resource Name (ARN) of the requested phone number.
- PhoneNumberId
-
- Type: string
The unique identifier of the new phone number.
- PoolId
-
- Type: string
The unique identifier of the pool associated with the phone number
- SelfManagedOptOutsEnabled
-
- Type: boolean
By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
- Status
-
- Type: string
The current status of the request.
- Tags
-
- Type: Array of Tag structures
An array of key and value pair tags that are associated with the phone number.
- TwoWayChannelArn
-
- Type: string
The ARN used to identify the two way channel.
- TwoWayEnabled
-
- Type: boolean
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
Errors
-
ServiceQuotaExceededException:
The request would cause a service quota to be exceeded.
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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.
-
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.
SendTextMessage
$result = $client->sendTextMessage([/* ... */]); $promise = $client->sendTextMessageAsync([/* ... */]);
Creates a new text message and sends it to a recipient's phone number.
SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information, see Message Parts per Second (MPS) limits in the Amazon Pinpoint User Guide.
Parameter Syntax
$result = $client->sendTextMessage([
'ConfigurationSetName' => '<string>',
'Context' => ['<string>', ...],
'DestinationCountryParameters' => ['<string>', ...],
'DestinationPhoneNumber' => '<string>', // REQUIRED
'DryRun' => true || false,
'Keyword' => '<string>',
'MaxPrice' => '<string>',
'MessageBody' => '<string>',
'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
'OriginationIdentity' => '<string>',
'TimeToLive' => <integer>,
]);
Parameter Details
Members
- ConfigurationSetName
-
- Type: string
The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
- Context
-
- Type: Associative array of custom strings keys (ContextKey) to strings
You can specify custom data in this field. If you do, that data is logged to the event destination.
- DestinationCountryParameters
-
- Type: Associative array of custom strings keys (DestinationCountryParameterKey) to strings
This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.
- DestinationPhoneNumber
-
- Required: Yes
- Type: string
The destination phone number in E.164 format.
- DryRun
-
- Type: boolean
When set to true, the message is checked and validated, but isn't sent to the end recipient.
- Keyword
-
- Type: string
When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute.
- MaxPrice
-
- Type: string
The maximum amount that you want to spend, in US dollars, per each text message part. A text message can contain multiple parts.
- MessageBody
-
- Type: string
The body of the text message.
- MessageType
-
- Type: string
The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- OriginationIdentity
-
- Type: string
The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
- TimeToLive
-
- Type: int
How long the text message is valid for. By default this is 72 hours.
Result Syntax
[
'MessageId' => '<string>',
]
Result Details
Errors
-
ServiceQuotaExceededException:
The request would cause a service quota to be exceeded.
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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.
-
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.
SendVoiceMessage
$result = $client->sendVoiceMessage([/* ... */]); $promise = $client->sendVoiceMessageAsync([/* ... */]);
Allows you to send a request that sends a text message through Amazon Pinpoint. This operation uses Amazon Polly to convert a text script into a voice message.
Parameter Syntax
$result = $client->sendVoiceMessage([
'ConfigurationSetName' => '<string>',
'Context' => ['<string>', ...],
'DestinationPhoneNumber' => '<string>', // REQUIRED
'DryRun' => true || false,
'MaxPricePerMinute' => '<string>',
'MessageBody' => '<string>',
'MessageBodyTextType' => 'TEXT|SSML',
'OriginationIdentity' => '<string>', // REQUIRED
'TimeToLive' => <integer>,
'VoiceId' => 'AMY|ASTRID|BIANCA|BRIAN|CAMILA|CARLA|CARMEN|CELINE|CHANTAL|CONCHITA|CRISTIANO|DORA|EMMA|ENRIQUE|EWA|FILIZ|GERAINT|GIORGIO|GWYNETH|HANS|INES|IVY|JACEK|JAN|JOANNA|JOEY|JUSTIN|KARL|KENDRA|KIMBERLY|LEA|LIV|LOTTE|LUCIA|LUPE|MADS|MAJA|MARLENE|MATHIEU|MATTHEW|MAXIM|MIA|MIGUEL|MIZUKI|NAJA|NICOLE|PENELOPE|RAVEENA|RICARDO|RUBEN|RUSSELL|SALLI|SEOYEON|TAKUMI|TATYANA|VICKI|VITORIA|ZEINA|ZHIYU',
]);
Parameter Details
Members
- ConfigurationSetName
-
- Type: string
The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
- Context
-
- Type: Associative array of custom strings keys (ContextKey) to strings
You can specify custom data in this field. If you do, that data is logged to the event destination.
- DestinationPhoneNumber
-
- Required: Yes
- Type: string
The destination phone number in E.164 format.
- DryRun
-
- Type: boolean
When set to true, the message is checked and validated, but isn't sent to the end recipient.
- MaxPricePerMinute
-
- Type: string
The maximum amount to spend per voice message, in US dollars.
- MessageBody
-
- Type: string
The text to convert to a voice message.
- MessageBodyTextType
-
- Type: string
Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).
-
TEXT: This is the default value. When used the maximum character limit is 3000.
-
SSML: When used the maximum character limit is 6000 including SSML tagging.
- OriginationIdentity
-
- Required: Yes
- Type: string
The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
- TimeToLive
-
- Type: int
How long the voice message is valid for. By default this is 72 hours.
- VoiceId
-
- Type: string
The voice for the Amazon Polly service to use. By default this is set to "MATTHEW".
Result Syntax
[
'MessageId' => '<string>',
]
Result Details
Errors
-
ServiceQuotaExceededException:
The request would cause a service quota to be exceeded.
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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.
-
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.
SetDefaultMessageType
$result = $client->setDefaultMessageType([/* ... */]); $promise = $client->setDefaultMessageTypeAsync([/* ... */]);
Sets the default message type on a configuration set.
Choose the category of SMS messages that you plan to send from this account. 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->setDefaultMessageType([
'ConfigurationSetName' => '<string>', // REQUIRED
'MessageType' => 'TRANSACTIONAL|PROMOTIONAL', // REQUIRED
]);
Parameter Details
Members
- ConfigurationSetName
-
- Required: Yes
- Type: string
The configuration set to update with a new default message type. This field can be the ConsigurationSetName or ConfigurationSetArn.
- MessageType
-
- Required: Yes
- Type: string
The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
Result Syntax
[
'ConfigurationSetArn' => '<string>',
'ConfigurationSetName' => '<string>',
'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
]
Result Details
Members
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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.
SetDefaultSenderId
$result = $client->setDefaultSenderId([/* ... */]); $promise = $client->setDefaultSenderIdAsync([/* ... */]);
Sets default sender ID on a configuration set.
When sending a text message to a destination country that supports sender IDs, the default sender ID on the configuration set specified will be used if no dedicated origination phone numbers or registered sender IDs are available in your account.
Parameter Syntax
$result = $client->setDefaultSenderId([
'ConfigurationSetName' => '<string>', // REQUIRED
'SenderId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ConfigurationSetName
-
- Required: Yes
- Type: string
The configuration set to updated with a new default SenderId. This field can be the ConsigurationSetName or ConfigurationSetArn.
- SenderId
-
- Required: Yes
- Type: string
The current sender ID for the configuration set. When sending a text message to a destination country which supports SenderIds, the default sender ID on the configuration set specified on SendTextMessage will be used if no dedicated origination phone numbers or registered SenderIds are available in your account, instead of a generic sender ID, such as 'NOTICE'.
Result Syntax
[
'ConfigurationSetArn' => '<string>',
'ConfigurationSetName' => '<string>',
'SenderId' => '<string>',
]
Result Details
Members
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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.
SetTextMessageSpendLimitOverride
$result = $client->setTextMessageSpendLimitOverride([/* ... */]); $promise = $client->setTextMessageSpendLimitOverrideAsync([/* ... */]);
Sets an account level monthly spend limit override for sending text messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
Parameter Syntax
$result = $client->setTextMessageSpendLimitOverride([
'MonthlyLimit' => <integer>, // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'MonthlyLimit' => <integer>,
]
Result Details
Members
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A validation exception for a field.
-
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.
SetVoiceMessageSpendLimitOverride
$result = $client->setVoiceMessageSpendLimitOverride([/* ... */]); $promise = $client->setVoiceMessageSpendLimitOverrideAsync([/* ... */]);
Sets an account level monthly spend limit override for sending voice messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
Parameter Syntax
$result = $client->setVoiceMessageSpendLimitOverride([
'MonthlyLimit' => <integer>, // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'MonthlyLimit' => <integer>,
]
Result Details
Members
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A validation exception for a field.
-
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.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
Parameter Syntax
$result = $client->tagResource([
'ResourceArn' => '<string>', // REQUIRED
'Tags' => [ // REQUIRED
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource.
- Tags
-
- Required: Yes
- Type: Array of Tag structures
An array of key and value pair tags that are associated with the resource.
Result Syntax
[]
Result Details
Errors
-
ServiceQuotaExceededException:
The request would cause a service quota to be exceeded.
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
Parameter Syntax
$result = $client->untagResource([
'ResourceArn' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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.
UpdateEventDestination
$result = $client->updateEventDestination([/* ... */]); $promise = $client->updateEventDestinationAsync([/* ... */]);
Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can also enable or disable the event destination.
You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.
Parameter Syntax
$result = $client->updateEventDestination([
'CloudWatchLogsDestination' => [
'IamRoleArn' => '<string>', // REQUIRED
'LogGroupArn' => '<string>', // REQUIRED
],
'ConfigurationSetName' => '<string>', // REQUIRED
'Enabled' => true || false,
'EventDestinationName' => '<string>', // REQUIRED
'KinesisFirehoseDestination' => [
'DeliveryStreamArn' => '<string>', // REQUIRED
'IamRoleArn' => '<string>', // REQUIRED
],
'MatchingEventTypes' => ['<string>', ...],
'SnsDestination' => [
'TopicArn' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- CloudWatchLogsDestination
-
- Type: CloudWatchLogsDestination structure
An object that contains information about an event destination that sends data to CloudWatch Logs.
- ConfigurationSetName
-
- Required: Yes
- Type: string
The configuration set to update with the new event destination. Valid values for this can be the ConfigurationSetName or ConfigurationSetArn.
- Enabled
-
- Type: boolean
When set to true logging is enabled.
- EventDestinationName
-
- Required: Yes
- Type: string
The name to use for the event destination.
- KinesisFirehoseDestination
-
- Type: KinesisFirehoseDestination structure
An object that contains information about an event destination for logging to Kinesis Data Firehose.
- MatchingEventTypes
-
- Type: Array of strings
An array of event types that determine which events to log.
- SnsDestination
-
- Type: SnsDestination structure
An object that contains information about an event destination that sends data to Amazon SNS.
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
Members
- ConfigurationSetArn
-
- Type: string
The Amazon Resource Name (ARN) for the ConfigurationSet that was updated.
- ConfigurationSetName
-
- Type: string
The name of the configuration set.
- EventDestination
-
- Type: EventDestination structure
An EventDestination object containing the details of where events will be logged.
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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.
-
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.
UpdatePhoneNumber
$result = $client->updatePhoneNumber([/* ... */]); $promise = $client->updatePhoneNumberAsync([/* ... */]);
Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection.
If the origination phone number is associated with a pool, an Error is returned.
Parameter Syntax
$result = $client->updatePhoneNumber([
'DeletionProtectionEnabled' => true || false,
'OptOutListName' => '<string>',
'PhoneNumberId' => '<string>', // REQUIRED
'SelfManagedOptOutsEnabled' => true || false,
'TwoWayChannelArn' => '<string>',
'TwoWayEnabled' => true || false,
]);
Parameter Details
Members
- DeletionProtectionEnabled
-
- Type: boolean
By default this is set to false. When set to true the phone number can't be deleted.
- OptOutListName
-
- Type: string
The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.
- PhoneNumberId
-
- Required: Yes
- Type: string
The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.
- SelfManagedOptOutsEnabled
-
- Type: boolean
By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
- TwoWayChannelArn
-
- Type: string
The Amazon Resource Name (ARN) of the two way channel.
- TwoWayEnabled
-
- Type: boolean
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
Result Syntax
[
'CreatedTimestamp' => <DateTime>,
'DeletionProtectionEnabled' => true || false,
'IsoCountryCode' => '<string>',
'MessageType' => 'TRANSACTIONAL|PROMOTIONAL',
'MonthlyLeasingPrice' => '<string>',
'NumberCapabilities' => ['<string>', ...],
'NumberType' => 'SHORT_CODE|LONG_CODE|TOLL_FREE|TEN_DLC',
'OptOutListName' => '<string>',
'PhoneNumber' => '<string>',
'PhoneNumberArn' => '<string>',
'PhoneNumberId' => '<string>',
'SelfManagedOptOutsEnabled' => true || false,
'Status' => 'PENDING|ACTIVE|ASSOCIATING|DISASSOCIATING|DELETED',
'TwoWayChannelArn' => '<string>',
'TwoWayEnabled' => true || false,
]
Result Details
Members
- CreatedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the phone number was created, in UNIX epoch time format.
- DeletionProtectionEnabled
-
- Type: boolean
When set to true the phone number can't be deleted.
- IsoCountryCode
-
- Type: string
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- MessageType
-
- Type: string
The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- MonthlyLeasingPrice
-
- Type: string
The monthly leasing price of the phone number, in US dollars.
- NumberCapabilities
-
- Type: Array of strings
Specifies if the number could be used for text messages, voice or both.
- NumberType
-
- Type: string
The type of number that was requested.
- OptOutListName
-
- Type: string
The name of the OptOutList associated with the phone number.
- PhoneNumber
-
- Type: string
The phone number that was updated.
- PhoneNumberArn
-
- Type: string
The Amazon Resource Name (ARN) of the updated phone number.
- PhoneNumberId
-
- Type: string
The unique identifier of the phone number.
- SelfManagedOptOutsEnabled
-
- Type: boolean
This is true if self managed opt-out are enabled.
- Status
-
- Type: string
The current status of the request.
- TwoWayChannelArn
-
- Type: string
The Amazon Resource Name (ARN) of the two way channel.
- TwoWayEnabled
-
- Type: boolean
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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.
-
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.
UpdatePool
$result = $client->updatePool([/* ... */]); $promise = $client->updatePoolAsync([/* ... */]);
Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.
Parameter Syntax
$result = $client->updatePool([
'DeletionProtectionEnabled' => true || false,
'OptOutListName' => '<string>',
'PoolId' => '<string>', // REQUIRED
'SelfManagedOptOutsEnabled' => true || false,
'SharedRoutesEnabled' => true || false,
'TwoWayChannelArn' => '<string>',
'TwoWayEnabled' => true || false,
]);
Parameter Details
Members
- DeletionProtectionEnabled
-
- Type: boolean
When set to true the pool can't be deleted.
- OptOutListName
-
- Type: string
The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.
- PoolId
-
- Required: Yes
- Type: string
The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.
- SelfManagedOptOutsEnabled
-
- Type: boolean
By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
- SharedRoutesEnabled
-
- Type: boolean
Indicates whether shared routes are enabled for the pool.
- TwoWayChannelArn
-
- Type: string
The Amazon Resource Name (ARN) of the two way channel.
- TwoWayEnabled
-
- Type: boolean
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
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',
'TwoWayChannelArn' => '<string>',
'TwoWayEnabled' => true || false,
]
Result Details
Members
- CreatedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the pool was created, in UNIX epoch time format.
- DeletionProtectionEnabled
-
- Type: boolean
When set to true the pool can't be deleted.
- MessageType
-
- Type: string
The type of message for the pool to use.
- OptOutListName
-
- Type: string
The name of the OptOutList associated with the pool.
- PoolArn
-
- Type: string
The ARN of the pool.
- PoolId
-
- Type: string
The unique identifier of the pool.
- SelfManagedOptOutsEnabled
-
- Type: boolean
When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
- SharedRoutesEnabled
-
- Type: boolean
Indicates whether shared routes are enabled for the pool.
- Status
-
- Type: string
The current status of the pool update request.
- TwoWayChannelArn
-
- Type: string
The Amazon Resource Name (ARN) of the two way channel.
- TwoWayEnabled
-
- Type: boolean
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
Errors
-
An error that occurred because too many requests were sent during a certain amount of time.
-
The request was denied because you don't have sufficient permissions to access the resource.
-
A requested resource couldn't be found.
-
A validation exception for a field.
-
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.
-
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.
Shapes
AccessDeniedException
Description
The request was denied because you don't have sufficient permissions to access the resource.
Members
AccountAttribute
Description
Displays the attributes associated with a single Amazon Web Services account.
Members
AccountLimit
Description
The current resource quotas associated with an Amazon Web Services account.
Members
CloudWatchLogsDestination
Description
Contains the destination configuration to use when publishing message sending events.
Members
- IamRoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon CloudWatch destination.
- LogGroupArn
-
- Required: Yes
- Type: string
The name of the Amazon CloudWatch log group that you want to record events in.
ConfigurationSetFilter
Description
The information for configuration sets that meet a specified criteria.
Members
ConfigurationSetInformation
Description
Information related to a given configuration set in your Amazon Web Services account.
Members
- ConfigurationSetArn
-
- Required: Yes
- Type: string
The Resource Name (ARN) of the ConfigurationSet.
- ConfigurationSetName
-
- Required: Yes
- Type: string
The name of the ConfigurationSet.
- CreatedTimestamp
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the ConfigurationSet was created, in UNIX epoch time format.
- DefaultMessageType
-
- Type: string
The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- DefaultSenderId
-
- Type: string
The default sender ID used by the ConfigurationSet.
- EventDestinations
-
- Required: Yes
- Type: Array of EventDestination structures
An array of EventDestination objects that describe any events to log and where to log them.
ConflictException
Description
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.
Members
EventDestination
Description
Contains information about an event destination.
Event destinations are associated with configuration sets, which enable you to publish message sending events to Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS.
Members
- CloudWatchLogsDestination
-
- Type: CloudWatchLogsDestination structure
An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.
- Enabled
-
- Required: Yes
- Type: boolean
When set to true events will be logged.
- EventDestinationName
-
- Required: Yes
- Type: string
The name of the EventDestination.
- KinesisFirehoseDestination
-
- Type: KinesisFirehoseDestination structure
An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
- MatchingEventTypes
-
- Required: Yes
- Type: Array of strings
An array of event types that determine which events to log.
- SnsDestination
-
- Type: SnsDestination structure
An object that contains information about an event destination that sends logging events to Amazon SNS.
InternalServerException
Description
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.
Members
KeywordFilter
Description
The information for keywords that meet a specified criteria.
Members
KeywordInformation
Description
The information for all keywords in a pool.
Members
KinesisFirehoseDestination
Description
Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with an Kinesis Data Firehose event destination.
Event destinations, such as Kinesis Data Firehose, are associated with configuration sets, which enable you to publish message sending events.
Members
OptOutListInformation
Description
The information for all OptOutList in an Amazon Web Services account.
Members
- CreatedTimestamp
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the OutOutList was created, in UNIX epoch time format.
- OptOutListArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the OptOutList.
- OptOutListName
-
- Required: Yes
- Type: string
The name of the OptOutList.
OptedOutFilter
Description
The information for opted out numbers that meet a specified criteria.
Members
OptedOutNumberInformation
Description
The information for an opted out number in an Amazon Web Services account.
Members
- EndUserOptedOut
-
- Required: Yes
- Type: boolean
This is set to true if it was the end recipient that opted out.
- OptedOutNumber
-
- Required: Yes
- Type: string
The phone number that is opted out.
- OptedOutTimestamp
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the op tout occurred, in UNIX epoch time format.
OriginationIdentityMetadata
Description
The metadata for an origination identity associated with a pool.
Members
- IsoCountryCode
-
- Required: Yes
- Type: string
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- NumberCapabilities
-
- Required: Yes
- Type: Array of strings
Describes if the origination identity can be used for text messages, voice calls or both.
- OriginationIdentity
-
- Required: Yes
- Type: string
The unique identifier of the origination identity.
- OriginationIdentityArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) associated with the origination identity.
PhoneNumberFilter
Description
The information for a phone number that meets a specified criteria.
Members
PhoneNumberInformation
Description
The information for a phone number in an Amazon Web Services account.
Members
- CreatedTimestamp
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the phone number was created, in UNIX epoch time format.
- DeletionProtectionEnabled
-
- Required: Yes
- Type: boolean
When set to true the phone number can't be deleted.
- IsoCountryCode
-
- Required: Yes
- Type: string
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- MessageType
-
- Required: Yes
- Type: string
The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- MonthlyLeasingPrice
-
- Required: Yes
- Type: string
The price, in US dollars, to lease the phone number.
- NumberCapabilities
-
- Required: Yes
- Type: Array of strings
Describes if the origination identity can be used for text messages, voice calls or both.
- NumberType
-
- Required: Yes
- Type: string
The type of phone number.
- OptOutListName
-
- Required: Yes
- Type: string
The name of the OptOutList associated with the phone number.
- PhoneNumber
-
- Required: Yes
- Type: string
The phone number in E.164 format.
- PhoneNumberArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) associated with the phone number.
- PhoneNumberId
-
- Type: string
The unique identifier for the phone number.
- PoolId
-
- Type: string
The unique identifier of the pool associated with the phone number.
- SelfManagedOptOutsEnabled
-
- Required: Yes
- Type: boolean
When set to false an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs
- Status
-
- Required: Yes
- Type: string
The current status of the phone number.
- TwoWayChannelArn
-
- Type: string
The Amazon Resource Name (ARN) of the two way channel.
- TwoWayEnabled
-
- Required: Yes
- Type: boolean
By default this is set to false. When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
PoolFilter
Description
The information for a pool that meets a specified criteria.
Members
PoolInformation
Description
The information for a pool in an Amazon Web Services account.
Members
- CreatedTimestamp
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the pool was created, in UNIX epoch time format.
- DeletionProtectionEnabled
-
- Required: Yes
- Type: boolean
When set to true the pool can't be deleted.
- MessageType
-
- Required: Yes
- Type: string
The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- OptOutListName
-
- Required: Yes
- Type: string
The name of the OptOutList associated with the pool.
- PoolArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the pool.
- PoolId
-
- Required: Yes
- Type: string
The unique identifier for the pool.
- SelfManagedOptOutsEnabled
-
- Required: Yes
- Type: boolean
When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. For more information see Self-managed opt-outs
- SharedRoutesEnabled
-
- Required: Yes
- Type: boolean
Allows you to enable shared routes on your pool.
By default, this is set to
False. If you set this value toTrue, your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other Amazon Pinpoint users. In some countries, such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or short code. - Status
-
- Required: Yes
- Type: string
The current status of the pool.
- TwoWayChannelArn
-
- Type: string
The Amazon Resource Name (ARN) of the two way channel.
- TwoWayEnabled
-
- Required: Yes
- Type: boolean
When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
PoolOriginationIdentitiesFilter
Description
Information about origination identities associated with a pool that meets a specified criteria.
Members
ResourceNotFoundException
Description
A requested resource couldn't be found.
Members
SenderIdAndCountry
Description
The alphanumeric sender ID in a specific country that you want to describe. For more information on sender IDs see Requesting sender IDs for SMS messaging with Amazon Pinpoint in the Amazon Pinpoint User Guide.
Members
SenderIdFilter
Description
The information for a sender ID that meets a specified criteria.
Members
SenderIdInformation
Description
The information for all SenderIds in an Amazon Web Services account.
Members
- IsoCountryCode
-
- Required: Yes
- Type: string
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- MessageTypes
-
- Required: Yes
- Type: Array of strings
The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- MonthlyLeasingPrice
-
- Required: Yes
- Type: string
The monthly leasing price, in US dollars.
- SenderId
-
- Required: Yes
- Type: string
The alphanumeric sender ID in a specific country that you'd like to describe.
- SenderIdArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) associated with the SenderId.
ServiceQuotaExceededException
Description
The request would cause a service quota to be exceeded.
Members
SnsDestination
Description
An object that defines an Amazon SNS destination for events. You can use Amazon SNS to send notification when certain events occur.
Members
SpendLimit
Description
Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages. 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.
Members
- EnforcedLimit
-
- Required: Yes
- Type: long (int|float)
The maximum amount of money, in US dollars, that you want to be able to spend sending messages each month. This value has to be less than or equal to the amount in
MaxLimit. To use this custom limit,Overriddenmust be set to true. - MaxLimit
-
- Required: Yes
- Type: long (int|float)
The maximum amount of money that you are able to spend to send messages each month, in US dollars.
- Name
-
- Required: Yes
- Type: string
The name for the SpendLimit.
- Overridden
-
- Required: Yes
- Type: boolean
When set to
True, the value that has been specified in theEnforcedLimitis used to determine the maximum amount in US dollars that can be spent to send messages each month, in US dollars.
Tag
Description
The list of tags to be added to the specified topic.
Members
ThrottlingException
Description
An error that occurred because too many requests were sent during a certain amount of time.
Members
ValidationException
Description
A validation exception for a field.
Members
- Fields
-
- Type: Array of ValidationExceptionField structures
The field that failed validation.
- Message
-
- Type: string
- Reason
-
- Type: string
The reason for the exception.