PinpointSMSVoiceV2

Client

class PinpointSMSVoiceV2.Client

A low-level client representing Amazon Pinpoint SMS Voice V2

Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference . This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API resources, including supported HTTP methods, parameters, and schemas.

Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The Amazon Pinpoint SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels and supplements the resources provided by the Amazon Pinpoint API.

If you're new to Amazon Pinpoint, it's also helpful to review the Amazon Pinpoint Developer Guide. The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides key information, such as Amazon Pinpoint integration with other Amazon Web Services services, and the quotas that apply to use of the service.

client = session.create_client('pinpoint-sms-voice-v2')

These are the available methods:

associate_origination_identity(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.associate_origination_identity(
    PoolId='string',
    OriginationIdentity='string',
    IsoCountryCode='string',
    ClientToken='string'
)
Parameters
  • PoolId (string) --

    [REQUIRED]

    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.

  • OriginationIdentity (string) --

    [REQUIRED]

    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.

  • IsoCountryCode (string) --

    [REQUIRED]

    The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the origination identity.

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

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'PoolArn': 'string',
    'PoolId': 'string',
    'OriginationIdentityArn': 'string',
    'OriginationIdentity': 'string',
    'IsoCountryCode': 'string'
}

Response Structure

  • (dict) --

    • PoolArn (string) --

      The Amazon Resource Name (ARN) of the pool that is now associated with the origination identity.

    • PoolId (string) --

      The PoolId of the pool that is now associated with the origination identity.

    • OriginationIdentityArn (string) --

      The PhoneNumberArn or SenderIdArn of the origination identity.

    • OriginationIdentity (string) --

      The PhoneNumberId or SenderId of the origination identity.

    • IsoCountryCode (string) --

      The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

Exceptions

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
close()

Closes underlying endpoint connections.

create_configuration_set(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_configuration_set(
    ConfigurationSetName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientToken='string'
)
Parameters
  • ConfigurationSetName (string) --

    [REQUIRED]

    The name to use for the new configuration set.

  • Tags (list) --

    An array of key and value pair tags that's associated with the new configuration set.

    • (dict) --

      The list of tags to be added to the specified topic.

      • Key (string) -- [REQUIRED]

        The key identifier, or name, of the tag.

      • Value (string) -- [REQUIRED]

        The string value associated with the key of the tag.

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

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'ConfigurationSetArn': 'string',
    'ConfigurationSetName': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'CreatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • ConfigurationSetArn (string) --

      The Amazon Resource Name (ARN) of the newly created configuration set.

    • ConfigurationSetName (string) --

      The name of the new configuration set.

    • Tags (list) --

      An array of key and value pair tags that's associated with the configuration set.

      • (dict) --

        The list of tags to be added to the specified topic.

        • Key (string) --

          The key identifier, or name, of the tag.

        • Value (string) --

          The string value associated with the key of the tag.

    • CreatedTimestamp (datetime) --

      The time when the configuration set was created, in UNIX epoch time format.

Exceptions

create_event_destination(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_event_destination(
    ConfigurationSetName='string',
    EventDestinationName='string',
    MatchingEventTypes=[
        'ALL'|'TEXT_ALL'|'TEXT_SENT'|'TEXT_PENDING'|'TEXT_QUEUED'|'TEXT_SUCCESSFUL'|'TEXT_DELIVERED'|'TEXT_INVALID'|'TEXT_INVALID_MESSAGE'|'TEXT_UNREACHABLE'|'TEXT_CARRIER_UNREACHABLE'|'TEXT_BLOCKED'|'TEXT_CARRIER_BLOCKED'|'TEXT_SPAM'|'TEXT_UNKNOWN'|'TEXT_TTL_EXPIRED'|'VOICE_ALL'|'VOICE_INITIATED'|'VOICE_RINGING'|'VOICE_ANSWERED'|'VOICE_COMPLETED'|'VOICE_BUSY'|'VOICE_NO_ANSWER'|'VOICE_FAILED'|'VOICE_TTL_EXPIRED',
    ],
    CloudWatchLogsDestination={
        'IamRoleArn': 'string',
        'LogGroupArn': 'string'
    },
    KinesisFirehoseDestination={
        'IamRoleArn': 'string',
        'DeliveryStreamArn': 'string'
    },
    SnsDestination={
        'TopicArn': 'string'
    },
    ClientToken='string'
)
Parameters
  • ConfigurationSetName (string) --

    [REQUIRED]

    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 (string) --

    [REQUIRED]

    The name that identifies the event destination.

  • MatchingEventTypes (list) --

    [REQUIRED]

    An array of event types that determine which events to log. If "ALL" is used, then Amazon Pinpoint logs every event type.

    • (string) --
  • CloudWatchLogsDestination (dict) --

    An object that contains information about an event destination for logging to Amazon CloudWatch logs.

    • IamRoleArn (string) -- [REQUIRED]

      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 (string) -- [REQUIRED]

      The name of the Amazon CloudWatch log group that you want to record events in.

  • KinesisFirehoseDestination (dict) --

    An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.

    • IamRoleArn (string) -- [REQUIRED]

      The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.

    • DeliveryStreamArn (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) of the delivery stream.

  • SnsDestination (dict) --

    An object that contains information about an event destination for logging to Amazon SNS.

    • TopicArn (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.

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

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'ConfigurationSetArn': 'string',
    'ConfigurationSetName': 'string',
    'EventDestination': {
        'EventDestinationName': 'string',
        'Enabled': True|False,
        'MatchingEventTypes': [
            'ALL'|'TEXT_ALL'|'TEXT_SENT'|'TEXT_PENDING'|'TEXT_QUEUED'|'TEXT_SUCCESSFUL'|'TEXT_DELIVERED'|'TEXT_INVALID'|'TEXT_INVALID_MESSAGE'|'TEXT_UNREACHABLE'|'TEXT_CARRIER_UNREACHABLE'|'TEXT_BLOCKED'|'TEXT_CARRIER_BLOCKED'|'TEXT_SPAM'|'TEXT_UNKNOWN'|'TEXT_TTL_EXPIRED'|'VOICE_ALL'|'VOICE_INITIATED'|'VOICE_RINGING'|'VOICE_ANSWERED'|'VOICE_COMPLETED'|'VOICE_BUSY'|'VOICE_NO_ANSWER'|'VOICE_FAILED'|'VOICE_TTL_EXPIRED',
        ],
        'CloudWatchLogsDestination': {
            'IamRoleArn': 'string',
            'LogGroupArn': 'string'
        },
        'KinesisFirehoseDestination': {
            'IamRoleArn': 'string',
            'DeliveryStreamArn': 'string'
        },
        'SnsDestination': {
            'TopicArn': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • ConfigurationSetArn (string) --

      The ARN of the configuration set.

    • ConfigurationSetName (string) --

      The name of the configuration set.

    • EventDestination (dict) --

      The details of the destination where events are logged.

      • EventDestinationName (string) --

        The name of the EventDestination.

      • Enabled (boolean) --

        When set to true events will be logged.

      • MatchingEventTypes (list) --

        An array of event types that determine which events to log.

        • (string) --
      • CloudWatchLogsDestination (dict) --

        An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.

        • IamRoleArn (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 (string) --

          The name of the Amazon CloudWatch log group that you want to record events in.

      • KinesisFirehoseDestination (dict) --

        An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.

        • IamRoleArn (string) --

          The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.

        • DeliveryStreamArn (string) --

          The Amazon Resource Name (ARN) of the delivery stream.

      • SnsDestination (dict) --

        An object that contains information about an event destination that sends logging events to Amazon SNS.

        • TopicArn (string) --

          The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.

Exceptions

create_opt_out_list(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.create_opt_out_list(
    OptOutListName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientToken='string'
)
Parameters
  • OptOutListName (string) --

    [REQUIRED]

    The name of the new OptOutList.

  • Tags (list) --

    An array of tags (key and value pairs) to associate with the new OptOutList.

    • (dict) --

      The list of tags to be added to the specified topic.

      • Key (string) -- [REQUIRED]

        The key identifier, or name, of the tag.

      • Value (string) -- [REQUIRED]

        The string value associated with the key of the tag.

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

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'OptOutListArn': 'string',
    'OptOutListName': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'CreatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • OptOutListArn (string) --

      The Amazon Resource Name (ARN) for the OptOutList.

    • OptOutListName (string) --

      The name of the new OptOutList.

    • Tags (list) --

      An array of tags (key and value pairs) associated with the new OptOutList.

      • (dict) --

        The list of tags to be added to the specified topic.

        • Key (string) --

          The key identifier, or name, of the tag.

        • Value (string) --

          The string value associated with the key of the tag.

    • CreatedTimestamp (datetime) --

      The time when the pool was created, in UNIX epoch time format.

Exceptions

create_pool(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_pool(
    OriginationIdentity='string',
    IsoCountryCode='string',
    MessageType='TRANSACTIONAL'|'PROMOTIONAL',
    DeletionProtectionEnabled=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientToken='string'
)
Parameters
  • OriginationIdentity (string) --

    [REQUIRED]

    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.

  • IsoCountryCode (string) --

    [REQUIRED]

    The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.

  • MessageType (string) --

    [REQUIRED]

    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.

  • DeletionProtectionEnabled (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.
  • Tags (list) --

    An array of tags (key and value pairs) associated with the pool.

    • (dict) --

      The list of tags to be added to the specified topic.

      • Key (string) -- [REQUIRED]

        The key identifier, or name, of the tag.

      • Value (string) -- [REQUIRED]

        The string value associated with the key of the tag.

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

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'PoolArn': 'string',
    'PoolId': 'string',
    'Status': 'CREATING'|'ACTIVE'|'DELETING',
    'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
    'TwoWayEnabled': True|False,
    'TwoWayChannelArn': 'string',
    'SelfManagedOptOutsEnabled': True|False,
    'OptOutListName': 'string',
    'SharedRoutesEnabled': True|False,
    'DeletionProtectionEnabled': True|False,
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'CreatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • PoolArn (string) --

      The Amazon Resource Name (ARN) for the pool.

    • PoolId (string) --

      The unique identifier for the pool.

    • Status (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.
    • MessageType (string) --

      The type of message for the pool to use.

    • TwoWayEnabled (boolean) --

      By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

    • TwoWayChannelArn (string) --

      The Amazon Resource Name (ARN) of the two way channel.

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

    • OptOutListName (string) --

      The name of the OptOutList associated with the pool.

    • SharedRoutesEnabled (boolean) --

      Indicates whether shared routes are enabled for the pool.

    • DeletionProtectionEnabled (boolean) --

      When set to true deletion protection is enabled. By default this is set to false.

    • Tags (list) --

      An array of tags (key and value pairs) associated with the pool.

      • (dict) --

        The list of tags to be added to the specified topic.

        • Key (string) --

          The key identifier, or name, of the tag.

        • Value (string) --

          The string value associated with the key of the tag.

    • CreatedTimestamp (datetime) --

      The time when the pool was created, in UNIX epoch time format.

Exceptions

delete_configuration_set(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_configuration_set(
    ConfigurationSetName='string'
)
Parameters
ConfigurationSetName (string) --

[REQUIRED]

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.

Return type
dict
Returns
Response Syntax
{
    'ConfigurationSetArn': 'string',
    'ConfigurationSetName': 'string',
    'EventDestinations': [
        {
            'EventDestinationName': 'string',
            'Enabled': True|False,
            'MatchingEventTypes': [
                'ALL'|'TEXT_ALL'|'TEXT_SENT'|'TEXT_PENDING'|'TEXT_QUEUED'|'TEXT_SUCCESSFUL'|'TEXT_DELIVERED'|'TEXT_INVALID'|'TEXT_INVALID_MESSAGE'|'TEXT_UNREACHABLE'|'TEXT_CARRIER_UNREACHABLE'|'TEXT_BLOCKED'|'TEXT_CARRIER_BLOCKED'|'TEXT_SPAM'|'TEXT_UNKNOWN'|'TEXT_TTL_EXPIRED'|'VOICE_ALL'|'VOICE_INITIATED'|'VOICE_RINGING'|'VOICE_ANSWERED'|'VOICE_COMPLETED'|'VOICE_BUSY'|'VOICE_NO_ANSWER'|'VOICE_FAILED'|'VOICE_TTL_EXPIRED',
            ],
            'CloudWatchLogsDestination': {
                'IamRoleArn': 'string',
                'LogGroupArn': 'string'
            },
            'KinesisFirehoseDestination': {
                'IamRoleArn': 'string',
                'DeliveryStreamArn': 'string'
            },
            'SnsDestination': {
                'TopicArn': 'string'
            }
        },
    ],
    'DefaultMessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
    'DefaultSenderId': 'string',
    'CreatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • ConfigurationSetArn (string) --

      The Amazon Resource Name (ARN) of the deleted configuration set.

    • ConfigurationSetName (string) --

      The name of the deleted configuration set.

    • EventDestinations (list) --

      An array of any EventDestination objects that were associated with the deleted configuration set.

      • (dict) --

        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.

        • EventDestinationName (string) --

          The name of the EventDestination.

        • Enabled (boolean) --

          When set to true events will be logged.

        • MatchingEventTypes (list) --

          An array of event types that determine which events to log.

          • (string) --
        • CloudWatchLogsDestination (dict) --

          An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.

          • IamRoleArn (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 (string) --

            The name of the Amazon CloudWatch log group that you want to record events in.

        • KinesisFirehoseDestination (dict) --

          An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.

          • IamRoleArn (string) --

            The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.

          • DeliveryStreamArn (string) --

            The Amazon Resource Name (ARN) of the delivery stream.

        • SnsDestination (dict) --

          An object that contains information about an event destination that sends logging events to Amazon SNS.

          • TopicArn (string) --

            The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.

    • DefaultMessageType (string) --

      The default message type of the configuration set that was deleted.

    • DefaultSenderId (string) --

      The default Sender ID of the configuration set that was deleted.

    • CreatedTimestamp (datetime) --

      The time that the deleted configuration set was created in UNIX epoch time format.

Exceptions

delete_default_message_type(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_default_message_type(
    ConfigurationSetName='string'
)
Parameters
ConfigurationSetName (string) --

[REQUIRED]

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.

Return type
dict
Returns
Response Syntax
{
    'ConfigurationSetArn': 'string',
    'ConfigurationSetName': 'string',
    'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL'
}

Response Structure

  • (dict) --
    • ConfigurationSetArn (string) --

      The Amazon Resource Name (ARN) of the configuration set.

    • ConfigurationSetName (string) --

      The name of the configuration set.

    • MessageType (string) --

      The current message type for the configuration set.

Exceptions

delete_default_sender_id(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_default_sender_id(
    ConfigurationSetName='string'
)
Parameters
ConfigurationSetName (string) --

[REQUIRED]

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.

Return type
dict
Returns
Response Syntax
{
    'ConfigurationSetArn': 'string',
    'ConfigurationSetName': 'string',
    'SenderId': 'string'
}

Response Structure

  • (dict) --
    • ConfigurationSetArn (string) --

      The Amazon Resource Name (ARN) of the configuration set.

    • ConfigurationSetName (string) --

      The name of the configuration set.

    • SenderId (string) --

      The current sender ID for the configuration set.

Exceptions

delete_event_destination(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_event_destination(
    ConfigurationSetName='string',
    EventDestinationName='string'
)
Parameters
  • ConfigurationSetName (string) --

    [REQUIRED]

    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 (string) --

    [REQUIRED]

    The name of the event destination to delete.

Return type

dict

Returns

Response Syntax

{
    'ConfigurationSetArn': 'string',
    'ConfigurationSetName': 'string',
    'EventDestination': {
        'EventDestinationName': 'string',
        'Enabled': True|False,
        'MatchingEventTypes': [
            'ALL'|'TEXT_ALL'|'TEXT_SENT'|'TEXT_PENDING'|'TEXT_QUEUED'|'TEXT_SUCCESSFUL'|'TEXT_DELIVERED'|'TEXT_INVALID'|'TEXT_INVALID_MESSAGE'|'TEXT_UNREACHABLE'|'TEXT_CARRIER_UNREACHABLE'|'TEXT_BLOCKED'|'TEXT_CARRIER_BLOCKED'|'TEXT_SPAM'|'TEXT_UNKNOWN'|'TEXT_TTL_EXPIRED'|'VOICE_ALL'|'VOICE_INITIATED'|'VOICE_RINGING'|'VOICE_ANSWERED'|'VOICE_COMPLETED'|'VOICE_BUSY'|'VOICE_NO_ANSWER'|'VOICE_FAILED'|'VOICE_TTL_EXPIRED',
        ],
        'CloudWatchLogsDestination': {
            'IamRoleArn': 'string',
            'LogGroupArn': 'string'
        },
        'KinesisFirehoseDestination': {
            'IamRoleArn': 'string',
            'DeliveryStreamArn': 'string'
        },
        'SnsDestination': {
            'TopicArn': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • ConfigurationSetArn (string) --

      The Amazon Resource Name (ARN) of the configuration set.

    • ConfigurationSetName (string) --

      The name of the configuration set the event destination was deleted from.

    • EventDestination (dict) --

      The event destination object that was deleted.

      • EventDestinationName (string) --

        The name of the EventDestination.

      • Enabled (boolean) --

        When set to true events will be logged.

      • MatchingEventTypes (list) --

        An array of event types that determine which events to log.

        • (string) --
      • CloudWatchLogsDestination (dict) --

        An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.

        • IamRoleArn (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 (string) --

          The name of the Amazon CloudWatch log group that you want to record events in.

      • KinesisFirehoseDestination (dict) --

        An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.

        • IamRoleArn (string) --

          The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.

        • DeliveryStreamArn (string) --

          The Amazon Resource Name (ARN) of the delivery stream.

      • SnsDestination (dict) --

        An object that contains information about an event destination that sends logging events to Amazon SNS.

        • TopicArn (string) --

          The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.

Exceptions

delete_keyword(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_keyword(
    OriginationIdentity='string',
    Keyword='string'
)
Parameters
  • OriginationIdentity (string) --

    [REQUIRED]

    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.

  • Keyword (string) --

    [REQUIRED]

    The keyword to delete.

Return type

dict

Returns

Response Syntax

{
    'OriginationIdentityArn': 'string',
    'OriginationIdentity': 'string',
    'Keyword': 'string',
    'KeywordMessage': 'string',
    'KeywordAction': 'AUTOMATIC_RESPONSE'|'OPT_OUT'|'OPT_IN'
}

Response Structure

  • (dict) --

    • OriginationIdentityArn (string) --

      The PhoneNumberArn or PoolArn that the keyword was associated with.

    • OriginationIdentity (string) --

      The PhoneNumberId or PoolId that the keyword was associated with.

    • Keyword (string) --

      The keyword that was deleted.

    • KeywordMessage (string) --

      The message that was associated with the deleted keyword.

    • KeywordAction (string) --

      The action that was associated with the deleted keyword.

Exceptions

delete_opt_out_list(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_opt_out_list(
    OptOutListName='string'
)
Parameters
OptOutListName (string) --

[REQUIRED]

The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

Return type
dict
Returns
Response Syntax
{
    'OptOutListArn': 'string',
    'OptOutListName': 'string',
    'CreatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • OptOutListArn (string) --

      The Amazon Resource Name (ARN) of the OptOutList that was removed.

    • OptOutListName (string) --

      The name of the OptOutList that was removed.

    • CreatedTimestamp (datetime) --

      The time when the OptOutList was created, in UNIX epoch time format.

Exceptions

delete_opted_out_number(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_opted_out_number(
    OptOutListName='string',
    OptedOutNumber='string'
)
Parameters
  • OptOutListName (string) --

    [REQUIRED]

    The OptOutListName or OptOutListArn to remove the phone number from.

  • OptedOutNumber (string) --

    [REQUIRED]

    The phone number, in E.164 format, to remove from the OptOutList.

Return type

dict

Returns

Response Syntax

{
    'OptOutListArn': 'string',
    'OptOutListName': 'string',
    'OptedOutNumber': 'string',
    'OptedOutTimestamp': datetime(2015, 1, 1),
    'EndUserOptedOut': True|False
}

Response Structure

  • (dict) --

    • OptOutListArn (string) --

      The OptOutListArn that the phone number was removed from.

    • OptOutListName (string) --

      The OptOutListName that the phone number was removed from.

    • OptedOutNumber (string) --

      The phone number that was removed from the OptOutList.

    • OptedOutTimestamp (datetime) --

      The time that the number was removed at, in UNIX epoch time format.

    • EndUserOptedOut (boolean) --

      This is true if it was the end user who requested their phone number be removed.

Exceptions

delete_pool(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_pool(
    PoolId='string'
)
Parameters
PoolId (string) --

[REQUIRED]

The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .

Return type
dict
Returns
Response Syntax
{
    'PoolArn': 'string',
    'PoolId': 'string',
    'Status': 'CREATING'|'ACTIVE'|'DELETING',
    'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
    'TwoWayEnabled': True|False,
    'TwoWayChannelArn': 'string',
    'SelfManagedOptOutsEnabled': True|False,
    'OptOutListName': 'string',
    'SharedRoutesEnabled': True|False,
    'CreatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • PoolArn (string) --

      The Amazon Resource Name (ARN) of the pool that was deleted.

    • PoolId (string) --

      The PoolId of the pool that was deleted.

    • Status (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.
    • MessageType (string) --

      The message type that was associated with the deleted pool.

    • TwoWayEnabled (boolean) --

      By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

    • TwoWayChannelArn (string) --

      The Amazon Resource Name (ARN) of the TwoWayChannel.

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

    • OptOutListName (string) --

      The name of the OptOutList that was associated with the deleted pool.

    • SharedRoutesEnabled (boolean) --

      Indicates whether shared routes are enabled for the pool.

    • CreatedTimestamp (datetime) --

      The time when the pool was created, in UNIX epoch time format.

Exceptions

delete_text_message_spend_limit_override()

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 .

See also: AWS API Documentation

Request Syntax

response = client.delete_text_message_spend_limit_override()
Return type
dict
Returns
Response Syntax
{
    'MonthlyLimit': 123
}

Response Structure

  • (dict) --
    • MonthlyLimit (integer) --

      The current monthly limit, in US dollars.

Exceptions

delete_voice_message_spend_limit_override()

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 .

See also: AWS API Documentation

Request Syntax

response = client.delete_voice_message_spend_limit_override()
Return type
dict
Returns
Response Syntax
{
    'MonthlyLimit': 123
}

Response Structure

  • (dict) --
    • MonthlyLimit (integer) --

      The current monthly limit, in US dollars.

Exceptions

describe_account_attributes(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_account_attributes(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (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.
  • MaxResults (integer) -- The maximum number of results to return per each request.
Return type

dict

Returns

Response Syntax

{
    'AccountAttributes': [
        {
            'Name': 'ACCOUNT_TIER',
            'Value': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AccountAttributes (list) --

      An array of AccountAttributes objects.

      • (dict) --

        Displays the attributes associated with a single Amazon Web Services account.

        • Name (string) --

          The name of the account attribute.

        • Value (string) --

          The value associated with the account attribute name.

    • NextToken (string) --

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Exceptions

describe_account_limits(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.describe_account_limits(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (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.
  • MaxResults (integer) -- The maximum number of results to return per each request.
Return type

dict

Returns

Response Syntax

{
    'AccountLimits': [
        {
            'Name': 'PHONE_NUMBERS'|'POOLS'|'CONFIGURATION_SETS'|'OPT_OUT_LISTS',
            'Used': 123,
            'Max': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AccountLimits (list) --

      An array of AccountLimit objects that show the current spend limits.

      • (dict) --

        The current resource quotas associated with an Amazon Web Services account.

        • Name (string) --

          The name of the attribute to apply the account limit to.

        • Used (integer) --

          The current amount that has been spent, in US dollars.

        • Max (integer) --

          The Amazon Web Services set limit for that resource type, in US dollars.

    • NextToken (string) --

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Exceptions

describe_configuration_sets(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_configuration_sets(
    ConfigurationSetNames=[
        'string',
    ],
    Filters=[
        {
            'Name': 'event-destination-name'|'matching-event-types'|'default-message-type'|'default-sender-id',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)
Parameters
  • ConfigurationSetNames (list) --

    An array of strings. Each element can be either a ConfigurationSetName or ConfigurationSetArn.

    • (string) --
  • Filters (list) --

    An array of filters to apply to the results that are returned.

    • (dict) --

      The information for configuration sets that meet a specified criteria.

      • Name (string) -- [REQUIRED]

        The name of the attribute to filter on.

      • Values (list) -- [REQUIRED]

        An array values to filter for.

        • (string) --
  • NextToken (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.
  • MaxResults (integer) -- The maximum number of results to return per each request.
Return type

dict

Returns

Response Syntax

{
    'ConfigurationSets': [
        {
            'ConfigurationSetArn': 'string',
            'ConfigurationSetName': 'string',
            'EventDestinations': [
                {
                    'EventDestinationName': 'string',
                    'Enabled': True|False,
                    'MatchingEventTypes': [
                        'ALL'|'TEXT_ALL'|'TEXT_SENT'|'TEXT_PENDING'|'TEXT_QUEUED'|'TEXT_SUCCESSFUL'|'TEXT_DELIVERED'|'TEXT_INVALID'|'TEXT_INVALID_MESSAGE'|'TEXT_UNREACHABLE'|'TEXT_CARRIER_UNREACHABLE'|'TEXT_BLOCKED'|'TEXT_CARRIER_BLOCKED'|'TEXT_SPAM'|'TEXT_UNKNOWN'|'TEXT_TTL_EXPIRED'|'VOICE_ALL'|'VOICE_INITIATED'|'VOICE_RINGING'|'VOICE_ANSWERED'|'VOICE_COMPLETED'|'VOICE_BUSY'|'VOICE_NO_ANSWER'|'VOICE_FAILED'|'VOICE_TTL_EXPIRED',
                    ],
                    'CloudWatchLogsDestination': {
                        'IamRoleArn': 'string',
                        'LogGroupArn': 'string'
                    },
                    'KinesisFirehoseDestination': {
                        'IamRoleArn': 'string',
                        'DeliveryStreamArn': 'string'
                    },
                    'SnsDestination': {
                        'TopicArn': 'string'
                    }
                },
            ],
            'DefaultMessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
            'DefaultSenderId': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ConfigurationSets (list) --

      An array of ConfigurationSets objects.

      • (dict) --

        Information related to a given configuration set in your Amazon Web Services account.

        • ConfigurationSetArn (string) --

          The Resource Name (ARN) of the ConfigurationSet.

        • ConfigurationSetName (string) --

          The name of the ConfigurationSet.

        • EventDestinations (list) --

          An array of EventDestination objects that describe any events to log and where to log them.

          • (dict) --

            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.

            • EventDestinationName (string) --

              The name of the EventDestination.

            • Enabled (boolean) --

              When set to true events will be logged.

            • MatchingEventTypes (list) --

              An array of event types that determine which events to log.

              • (string) --
            • CloudWatchLogsDestination (dict) --

              An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.

              • IamRoleArn (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 (string) --

                The name of the Amazon CloudWatch log group that you want to record events in.

            • KinesisFirehoseDestination (dict) --

              An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.

              • IamRoleArn (string) --

                The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.

              • DeliveryStreamArn (string) --

                The Amazon Resource Name (ARN) of the delivery stream.

            • SnsDestination (dict) --

              An object that contains information about an event destination that sends logging events to Amazon SNS.

              • TopicArn (string) --

                The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.

        • DefaultMessageType (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 (string) --

          The default sender ID used by the ConfigurationSet.

        • CreatedTimestamp (datetime) --

          The time when the ConfigurationSet was created, in UNIX epoch time format.

    • NextToken (string) --

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Exceptions

describe_keywords(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_keywords(
    OriginationIdentity='string',
    Keywords=[
        'string',
    ],
    Filters=[
        {
            'Name': 'keyword-action',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)
Parameters
  • OriginationIdentity (string) --

    [REQUIRED]

    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.

  • Keywords (list) --

    An array of keywords to search for.

    • (string) --
  • Filters (list) --

    An array of keyword filters to filter the results.

    • (dict) --

      The information for keywords that meet a specified criteria.

      • Name (string) -- [REQUIRED]

        The name of the attribute to filter on.

      • Values (list) -- [REQUIRED]

        An array values to filter for.

        • (string) --
  • NextToken (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.
  • MaxResults (integer) -- The maximum number of results to return per each request.
Return type

dict

Returns

Response Syntax

{
    'OriginationIdentityArn': 'string',
    'OriginationIdentity': 'string',
    'Keywords': [
        {
            'Keyword': 'string',
            'KeywordMessage': 'string',
            'KeywordAction': 'AUTOMATIC_RESPONSE'|'OPT_OUT'|'OPT_IN'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • OriginationIdentityArn (string) --

      The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.

    • OriginationIdentity (string) --

      The PhoneNumberId or PoolId that is associated with the OriginationIdentity.

    • Keywords (list) --

      An array of KeywordInformation objects that contain the results.

      • (dict) --

        The information for all keywords in a pool.

        • Keyword (string) --

          The keyword as a string.

        • KeywordMessage (string) --

          A custom message that can be used with the keyword.

        • KeywordAction (string) --

          The action to perform for the keyword.

    • NextToken (string) --

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Exceptions

describe_opt_out_lists(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_opt_out_lists(
    OptOutListNames=[
        'string',
    ],
    NextToken='string',
    MaxResults=123
)
Parameters
  • OptOutListNames (list) --

    The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.

    • (string) --
  • NextToken (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.
  • MaxResults (integer) -- The maximum number of results to return per each request.
Return type

dict

Returns

Response Syntax

{
    'OptOutLists': [
        {
            'OptOutListArn': 'string',
            'OptOutListName': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • OptOutLists (list) --

      An array of OptOutListInformation objects that contain the details for the requested OptOutLists.

      • (dict) --

        The information for all OptOutList in an Amazon Web Services account.

        • OptOutListArn (string) --

          The Amazon Resource Name (ARN) of the OptOutList.

        • OptOutListName (string) --

          The name of the OptOutList.

        • CreatedTimestamp (datetime) --

          The time when the OutOutList was created, in UNIX epoch time format.

    • NextToken (string) --

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Exceptions

describe_opted_out_numbers(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_opted_out_numbers(
    OptOutListName='string',
    OptedOutNumbers=[
        'string',
    ],
    Filters=[
        {
            'Name': 'end-user-opted-out',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)
Parameters
  • OptOutListName (string) --

    [REQUIRED]

    The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

  • OptedOutNumbers (list) --

    An array of phone numbers to search for in the OptOutList.

    • (string) --
  • Filters (list) --

    An array of OptedOutFilter objects to filter the results on.

    • (dict) --

      The information for opted out numbers that meet a specified criteria.

      • Name (string) -- [REQUIRED]

        The name of the attribute to filter on.

      • Values (list) -- [REQUIRED]

        An array of values to filter for.

        • (string) --
  • NextToken (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.
  • MaxResults (integer) -- The maximum number of results to return per each request.
Return type

dict

Returns

Response Syntax

{
    'OptOutListArn': 'string',
    'OptOutListName': 'string',
    'OptedOutNumbers': [
        {
            'OptedOutNumber': 'string',
            'OptedOutTimestamp': datetime(2015, 1, 1),
            'EndUserOptedOut': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • OptOutListArn (string) --

      The Amazon Resource Name (ARN) of the OptOutList.

    • OptOutListName (string) --

      The name of the OptOutList.

    • OptedOutNumbers (list) --

      An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.

      • (dict) --

        The information for an opted out number in an Amazon Web Services account.

        • OptedOutNumber (string) --

          The phone number that is opted out.

        • OptedOutTimestamp (datetime) --

          The time that the op tout occurred, in UNIX epoch time format.

        • EndUserOptedOut (boolean) --

          This is set to true if it was the end recipient that opted out.

    • NextToken (string) --

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Exceptions

describe_phone_numbers(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_phone_numbers(
    PhoneNumberIds=[
        'string',
    ],
    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',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)
Parameters
  • PhoneNumberIds (list) --

    The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.

    • (string) --
  • Filters (list) --

    An array of PhoneNumberFilter objects to filter the results.

    • (dict) --

      The information for a phone number that meets a specified criteria.

      • Name (string) -- [REQUIRED]

        The name of the attribute to filter on.

      • Values (list) -- [REQUIRED]

        An array values to filter for.

        • (string) --
  • NextToken (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.
  • MaxResults (integer) -- The maximum number of results to return per each request.
Return type

dict

Returns

Response Syntax

{
    'PhoneNumbers': [
        {
            'PhoneNumberArn': 'string',
            'PhoneNumberId': 'string',
            'PhoneNumber': 'string',
            'Status': 'PENDING'|'ACTIVE'|'ASSOCIATING'|'DISASSOCIATING'|'DELETED',
            'IsoCountryCode': 'string',
            'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
            'NumberCapabilities': [
                'SMS'|'VOICE',
            ],
            'NumberType': 'SHORT_CODE'|'LONG_CODE'|'TOLL_FREE'|'TEN_DLC',
            'MonthlyLeasingPrice': 'string',
            'TwoWayEnabled': True|False,
            'TwoWayChannelArn': 'string',
            'SelfManagedOptOutsEnabled': True|False,
            'OptOutListName': 'string',
            'DeletionProtectionEnabled': True|False,
            'PoolId': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • PhoneNumbers (list) --

      An array of PhoneNumberInformation objects that contain the details for the requested phone numbers.

      • (dict) --

        The information for a phone number in an Amazon Web Services account.

        • PhoneNumberArn (string) --

          The Amazon Resource Name (ARN) associated with the phone number.

        • PhoneNumberId (string) --

          The unique identifier for the phone number.

        • PhoneNumber (string) --

          The phone number in E.164 format.

        • Status (string) --

          The current status of the phone number.

        • IsoCountryCode (string) --

          The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

        • MessageType (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 (list) --

          Describes if the origination identity can be used for text messages, voice calls or both.

          • (string) --
        • NumberType (string) --

          The type of phone number.

        • MonthlyLeasingPrice (string) --

          The price, in US dollars, to lease the phone number.

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

        • TwoWayChannelArn (string) --

          The Amazon Resource Name (ARN) of the two way channel.

        • SelfManagedOptOutsEnabled (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

        • OptOutListName (string) --

          The name of the OptOutList associated with the phone number.

        • DeletionProtectionEnabled (boolean) --

          When set to true the phone number can't be deleted.

        • PoolId (string) --

          The unique identifier of the pool associated with the phone number.

        • CreatedTimestamp (datetime) --

          The time when the phone number was created, in UNIX epoch time format.

    • NextToken (string) --

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Exceptions

describe_pools(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_pools(
    PoolIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'status'|'message-type'|'two-way-enabled'|'self-managed-opt-outs-enabled'|'opt-out-list-name'|'shared-routes-enabled'|'deletion-protection-enabled',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)
Parameters
  • PoolIds (list) --

    The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.

    • (string) --
  • Filters (list) --

    An array of PoolFilter objects to filter the results.

    • (dict) --

      The information for a pool that meets a specified criteria.

      • Name (string) -- [REQUIRED]

        The name of the attribute to filter on.

      • Values (list) -- [REQUIRED]

        An array values to filter for.

        • (string) --
  • NextToken (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.
  • MaxResults (integer) -- The maximum number of results to return per each request.
Return type

dict

Returns

Response Syntax

{
    'Pools': [
        {
            'PoolArn': 'string',
            'PoolId': 'string',
            'Status': 'CREATING'|'ACTIVE'|'DELETING',
            'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
            'TwoWayEnabled': True|False,
            'TwoWayChannelArn': 'string',
            'SelfManagedOptOutsEnabled': True|False,
            'OptOutListName': 'string',
            'SharedRoutesEnabled': True|False,
            'DeletionProtectionEnabled': True|False,
            'CreatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Pools (list) --

      An array of PoolInformation objects that contain the details for the requested pools.

      • (dict) --

        The information for a pool in an Amazon Web Services account.

        • PoolArn (string) --

          The Amazon Resource Name (ARN) for the pool.

        • PoolId (string) --

          The unique identifier for the pool.

        • Status (string) --

          The current status of the pool.

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

        • TwoWayEnabled (boolean) --

          When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

        • TwoWayChannelArn (string) --

          The Amazon Resource Name (ARN) of the two way channel.

        • SelfManagedOptOutsEnabled (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

        • OptOutListName (string) --

          The name of the OptOutList associated with the pool.

        • SharedRoutesEnabled (boolean) --

          Allows you to enable shared routes on your pool.

          By default, this is set to False . If you set this value to True , 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.

        • DeletionProtectionEnabled (boolean) --

          When set to true the pool can't be deleted.

        • CreatedTimestamp (datetime) --

          The time when the pool was created, in UNIX epoch time format.

    • NextToken (string) --

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Exceptions

describe_sender_ids(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_sender_ids(
    SenderIds=[
        {
            'SenderId': 'string',
            'IsoCountryCode': 'string'
        },
    ],
    Filters=[
        {
            'Name': 'sender-id'|'iso-country-code'|'message-type',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)
Parameters
  • SenderIds (list) --

    An array of SenderIdAndCountry objects to search for.

    • (dict) --

      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 .

      • SenderId (string) -- [REQUIRED]

        The unique identifier of the sender.

      • IsoCountryCode (string) -- [REQUIRED]

        The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

  • Filters (list) --

    An array of SenderIdFilter objects to filter the results.

    • (dict) --

      The information for a sender ID that meets a specified criteria.

      • Name (string) -- [REQUIRED]

        The name of the attribute to filter on.

      • Values (list) -- [REQUIRED]

        An array of values to filter for.

        • (string) --
  • NextToken (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.
  • MaxResults (integer) -- The maximum number of results to return per each request.
Return type

dict

Returns

Response Syntax

{
    'SenderIds': [
        {
            'SenderIdArn': 'string',
            'SenderId': 'string',
            'IsoCountryCode': 'string',
            'MessageTypes': [
                'TRANSACTIONAL'|'PROMOTIONAL',
            ],
            'MonthlyLeasingPrice': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • SenderIds (list) --

      An array of SernderIdInformation objects that contain the details for the requested SenderIds.

      • (dict) --

        The information for all SenderIds in an Amazon Web Services account.

        • SenderIdArn (string) --

          The Amazon Resource Name (ARN) associated with the SenderId.

        • SenderId (string) --

          The alphanumeric sender ID in a specific country that you'd like to describe.

        • IsoCountryCode (string) --

          The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

        • MessageTypes (list) --

          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.

          • (string) --
        • MonthlyLeasingPrice (string) --

          The monthly leasing price, in US dollars.

    • NextToken (string) --

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Exceptions

describe_spend_limits(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.describe_spend_limits(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (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.
  • MaxResults (integer) -- The maximum number of results to return per each request.
Return type

dict

Returns

Response Syntax

{
    'SpendLimits': [
        {
            'Name': 'TEXT_MESSAGE_MONTHLY_SPEND_LIMIT'|'VOICE_MESSAGE_MONTHLY_SPEND_LIMIT',
            'EnforcedLimit': 123,
            'MaxLimit': 123,
            'Overridden': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • SpendLimits (list) --

      An array of SpendLimit objects that contain the details for the requested spend limits.

      • (dict) --

        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 .

        • Name (string) --

          The name for the SpendLimit.

        • EnforcedLimit (integer) --

          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, Overridden must be set to true.

        • MaxLimit (integer) --

          The maximum amount of money that you are able to spend to send messages each month, in US dollars.

        • Overridden (boolean) --

          When set to True , the value that has been specified in the EnforcedLimit is used to determine the maximum amount in US dollars that can be spent to send messages each month, in US dollars.

    • NextToken (string) --

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Exceptions

disassociate_origination_identity(**kwargs)

Removes the specified origination identity from an existing pool.

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

See also: AWS API Documentation

Request Syntax

response = client.disassociate_origination_identity(
    PoolId='string',
    OriginationIdentity='string',
    IsoCountryCode='string',
    ClientToken='string'
)
Parameters
  • PoolId (string) --

    [REQUIRED]

    The unique identifier for the pool to disassociate with the origination identity. This value can be either the PoolId or PoolArn.

  • OriginationIdentity (string) --

    [REQUIRED]

    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.

  • IsoCountryCode (string) --

    [REQUIRED]

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

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

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'PoolArn': 'string',
    'PoolId': 'string',
    'OriginationIdentityArn': 'string',
    'OriginationIdentity': 'string',
    'IsoCountryCode': 'string'
}

Response Structure

  • (dict) --

    • PoolArn (string) --

      The Amazon Resource Name (ARN) of the pool.

    • PoolId (string) --

      The PoolId of the pool no longer associated with the origination identity.

    • OriginationIdentityArn (string) --

      The PhoneNumberArn or SenderIdArn of the origination identity.

    • OriginationIdentity (string) --

      The PhoneNumberId or SenderId of the origination identity.

    • IsoCountryCode (string) --

      The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_pool_origination_identities(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.list_pool_origination_identities(
    PoolId='string',
    Filters=[
        {
            'Name': 'iso-country-code'|'number-capability',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)
Parameters
  • PoolId (string) --

    [REQUIRED]

    The unique identifier for the pool. This value can be either the PoolId or PoolArn.

  • Filters (list) --

    An array of PoolOriginationIdentitiesFilter objects to filter the results..

    • (dict) --

      Information about origination identities associated with a pool that meets a specified criteria.

      • Name (string) -- [REQUIRED]

        The name of the attribute to filter on.

      • Values (list) -- [REQUIRED]

        An array values to filter for.

        • (string) --
  • NextToken (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.
  • MaxResults (integer) -- The maximum number of results to return per each request.
Return type

dict

Returns

Response Syntax

{
    'PoolArn': 'string',
    'PoolId': 'string',
    'OriginationIdentities': [
        {
            'OriginationIdentityArn': 'string',
            'OriginationIdentity': 'string',
            'IsoCountryCode': 'string',
            'NumberCapabilities': [
                'SMS'|'VOICE',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • PoolArn (string) --

      The Amazon Resource Name (ARN) for the pool.

    • PoolId (string) --

      The unique PoolId of the pool.

    • OriginationIdentities (list) --

      An array of any OriginationIdentityMetadata objects.

      • (dict) --

        The metadata for an origination identity associated with a pool.

        • OriginationIdentityArn (string) --

          The Amazon Resource Name (ARN) associated with the origination identity.

        • OriginationIdentity (string) --

          The unique identifier of the origination identity.

        • IsoCountryCode (string) --

          The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

        • NumberCapabilities (list) --

          Describes if the origination identity can be used for text messages, voice calls or both.

          • (string) --
    • NextToken (string) --

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Exceptions

list_tags_for_resource(**kwargs)

List all tags associated with a resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the resource to query for.

Return type
dict
Returns
Response Syntax
{
    'ResourceArn': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • ResourceArn (string) --

      The ARN of the resource.

    • Tags (list) --

      An array of key and value pair tags that are associated with the resource.

      • (dict) --

        The list of tags to be added to the specified topic.

        • Key (string) --

          The key identifier, or name, of the tag.

        • Value (string) --

          The string value associated with the key of the tag.

Exceptions

put_keyword(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.put_keyword(
    OriginationIdentity='string',
    Keyword='string',
    KeywordMessage='string',
    KeywordAction='AUTOMATIC_RESPONSE'|'OPT_OUT'|'OPT_IN'
)
Parameters
  • OriginationIdentity (string) --

    [REQUIRED]

    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.

  • Keyword (string) --

    [REQUIRED]

    The new keyword to add.

  • KeywordMessage (string) --

    [REQUIRED]

    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.
  • KeywordAction (string) -- The action to perform for the new keyword when it is received.
Return type

dict

Returns

Response Syntax

{
    'OriginationIdentityArn': 'string',
    'OriginationIdentity': 'string',
    'Keyword': 'string',
    'KeywordMessage': 'string',
    'KeywordAction': 'AUTOMATIC_RESPONSE'|'OPT_OUT'|'OPT_IN'
}

Response Structure

  • (dict) --

    • OriginationIdentityArn (string) --

      The PhoneNumberArn or PoolArn that the keyword was associated with.

    • OriginationIdentity (string) --

      The PhoneNumberId or PoolId that the keyword was associated with.

    • Keyword (string) --

      The keyword that was added.

    • KeywordMessage (string) --

      The message associated with the keyword.

    • KeywordAction (string) --

      The action to perform when the keyword is used.

Exceptions

put_opted_out_number(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.put_opted_out_number(
    OptOutListName='string',
    OptedOutNumber='string'
)
Parameters
  • OptOutListName (string) --

    [REQUIRED]

    The OptOutListName or OptOutListArn to add the phone number to.

  • OptedOutNumber (string) --

    [REQUIRED]

    The phone number to add to the OptOutList in E.164 format.

Return type

dict

Returns

Response Syntax

{
    'OptOutListArn': 'string',
    'OptOutListName': 'string',
    'OptedOutNumber': 'string',
    'OptedOutTimestamp': datetime(2015, 1, 1),
    'EndUserOptedOut': True|False
}

Response Structure

  • (dict) --

    • OptOutListArn (string) --

      The OptOutListArn that the phone number was removed from.

    • OptOutListName (string) --

      The OptOutListName that the phone number was removed from.

    • OptedOutNumber (string) --

      The phone number that was added to the OptOutList.

    • OptedOutTimestamp (datetime) --

      The time that the phone number was added to the OptOutList, in UNIX epoch time format.

    • EndUserOptedOut (boolean) --

      This is true if it was the end user who requested their phone number be removed.

Exceptions

release_phone_number(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.release_phone_number(
    PhoneNumberId='string'
)
Parameters
PhoneNumberId (string) --

[REQUIRED]

The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and PhoneNumberArn.

Return type
dict
Returns
Response Syntax
{
    'PhoneNumberArn': 'string',
    'PhoneNumberId': 'string',
    'PhoneNumber': 'string',
    'Status': 'PENDING'|'ACTIVE'|'ASSOCIATING'|'DISASSOCIATING'|'DELETED',
    'IsoCountryCode': 'string',
    'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
    'NumberCapabilities': [
        'SMS'|'VOICE',
    ],
    'NumberType': 'SHORT_CODE'|'LONG_CODE'|'TOLL_FREE'|'TEN_DLC',
    'MonthlyLeasingPrice': 'string',
    'TwoWayEnabled': True|False,
    'TwoWayChannelArn': 'string',
    'SelfManagedOptOutsEnabled': True|False,
    'OptOutListName': 'string',
    'CreatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • PhoneNumberArn (string) --

      The PhoneNumberArn of the phone number that was released.

    • PhoneNumberId (string) --

      The PhoneNumberId of the phone number that was released.

    • PhoneNumber (string) --

      The phone number that was released.

    • Status (string) --

      The current status of the request.

    • IsoCountryCode (string) --

      The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

    • MessageType (string) --

      The message type that was associated with the phone number.

    • NumberCapabilities (list) --

      Specifies if the number could be used for text messages, voice, or both.

      • (string) --
    • NumberType (string) --

      The type of number that was released.

    • MonthlyLeasingPrice (string) --

      The monthly price of the phone number, in US dollars.

    • TwoWayEnabled (boolean) --

      By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

    • TwoWayChannelArn (string) --

      The Amazon Resource Name (ARN) of the TwoWayChannel.

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

    • OptOutListName (string) --

      The name of the OptOutList that was associated with the phone number.

    • CreatedTimestamp (datetime) --

      The time when the phone number was created, in UNIX epoch time format.

Exceptions

request_phone_number(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.request_phone_number(
    IsoCountryCode='string',
    MessageType='TRANSACTIONAL'|'PROMOTIONAL',
    NumberCapabilities=[
        'SMS'|'VOICE',
    ],
    NumberType='LONG_CODE'|'TOLL_FREE'|'TEN_DLC',
    OptOutListName='string',
    PoolId='string',
    RegistrationId='string',
    DeletionProtectionEnabled=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientToken='string'
)
Parameters
  • IsoCountryCode (string) --

    [REQUIRED]

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

  • MessageType (string) --

    [REQUIRED]

    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 (list) --

    [REQUIRED]

    Indicates if the phone number will be used for text messages, voice messages, or both.

    • (string) --
  • NumberType (string) --

    [REQUIRED]

    The type of phone number to request.

  • OptOutListName (string) -- The name of the OptOutList to associate with the phone number. You can use the OutOutListName or OptPutListArn.
  • PoolId (string) -- The pool to associated with the phone number. You can use the PoolId or PoolArn.
  • RegistrationId (string) -- Use this field to attach your phone number for an external registration process.
  • DeletionProtectionEnabled (boolean) -- By default this is set to false. When set to true the phone number can't be deleted.
  • Tags (list) --

    An array of tags (key and value pairs) associate with the requested phone number.

    • (dict) --

      The list of tags to be added to the specified topic.

      • Key (string) -- [REQUIRED]

        The key identifier, or name, of the tag.

      • Value (string) -- [REQUIRED]

        The string value associated with the key of the tag.

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

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'PhoneNumberArn': 'string',
    'PhoneNumberId': 'string',
    'PhoneNumber': 'string',
    'Status': 'PENDING'|'ACTIVE'|'ASSOCIATING'|'DISASSOCIATING'|'DELETED',
    'IsoCountryCode': 'string',
    'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
    'NumberCapabilities': [
        'SMS'|'VOICE',
    ],
    'NumberType': 'LONG_CODE'|'TOLL_FREE'|'TEN_DLC',
    'MonthlyLeasingPrice': 'string',
    'TwoWayEnabled': True|False,
    'TwoWayChannelArn': 'string',
    'SelfManagedOptOutsEnabled': True|False,
    'OptOutListName': 'string',
    'DeletionProtectionEnabled': True|False,
    'PoolId': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'CreatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • PhoneNumberArn (string) --

      The Amazon Resource Name (ARN) of the requested phone number.

    • PhoneNumberId (string) --

      The unique identifier of the new phone number.

    • PhoneNumber (string) --

      The new phone number that was requested.

    • Status (string) --

      The current status of the request.

    • IsoCountryCode (string) --

      The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

    • MessageType (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 (list) --

      Indicates if the phone number will be used for text messages, voice messages or both.

      • (string) --
    • NumberType (string) --

      The type of number that was released.

    • MonthlyLeasingPrice (string) --

      The monthly price, in US dollars, to lease the phone number.

    • TwoWayEnabled (boolean) --

      By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

    • TwoWayChannelArn (string) --

      The ARN used to identify the two way channel.

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

    • OptOutListName (string) --

      The name of the OptOutList that is associated with the requested phone number.

    • DeletionProtectionEnabled (boolean) --

      By default this is set to false. When set to true the phone number can't be deleted.

    • PoolId (string) --

      The unique identifier of the pool associated with the phone number

    • Tags (list) --

      An array of key and value pair tags that are associated with the phone number.

      • (dict) --

        The list of tags to be added to the specified topic.

        • Key (string) --

          The key identifier, or name, of the tag.

        • Value (string) --

          The string value associated with the key of the tag.

    • CreatedTimestamp (datetime) --

      The time when the phone number was created, in UNIX epoch time format.

Exceptions

send_text_message(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.send_text_message(
    DestinationPhoneNumber='string',
    OriginationIdentity='string',
    MessageBody='string',
    MessageType='TRANSACTIONAL'|'PROMOTIONAL',
    Keyword='string',
    ConfigurationSetName='string',
    MaxPrice='string',
    TimeToLive=123,
    Context={
        'string': 'string'
    },
    DestinationCountryParameters={
        'string': 'string'
    },
    DryRun=True|False
)
Parameters
  • DestinationPhoneNumber (string) --

    [REQUIRED]

    The destination phone number in E.164 format.

  • OriginationIdentity (string) -- The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
  • MessageBody (string) -- The body of the text message.
  • MessageType (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.
  • Keyword (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.
  • ConfigurationSetName (string) -- The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
  • MaxPrice (string) -- The maximum amount that you want to spend, in US dollars, per each text message part. A text message can contain multiple parts.
  • TimeToLive (integer) -- How long the text message is valid for. By default this is 72 hours.
  • Context (dict) --

    You can specify custom data in this field. If you do, that data is logged to the event destination.

    • (string) --
      • (string) --
  • DestinationCountryParameters (dict) --

    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.

    • (string) --
      • (string) --
  • DryRun (boolean) -- When set to true, the message is checked and validated, but isn't sent to the end recipient.
Return type

dict

Returns

Response Syntax

{
    'MessageId': 'string'
}

Response Structure

  • (dict) --

    • MessageId (string) --

      The unique identifier for the message.

Exceptions

send_voice_message(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.send_voice_message(
    DestinationPhoneNumber='string',
    OriginationIdentity='string',
    MessageBody='string',
    MessageBodyTextType='TEXT'|'SSML',
    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',
    ConfigurationSetName='string',
    MaxPricePerMinute='string',
    TimeToLive=123,
    Context={
        'string': 'string'
    },
    DryRun=True|False
)
Parameters
  • DestinationPhoneNumber (string) --

    [REQUIRED]

    The destination phone number in E.164 format.

  • OriginationIdentity (string) --

    [REQUIRED]

    The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.

  • MessageBody (string) -- The text to convert to a voice message.
  • MessageBodyTextType (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.
  • VoiceId (string) -- The voice for the Amazon Polly service to use. By default this is set to "MATTHEW".
  • ConfigurationSetName (string) -- The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
  • MaxPricePerMinute (string) -- The maximum amount to spend per voice message, in US dollars.
  • TimeToLive (integer) -- How long the voice message is valid for. By default this is 72 hours.
  • Context (dict) --

    You can specify custom data in this field. If you do, that data is logged to the event destination.

    • (string) --
      • (string) --
  • DryRun (boolean) -- When set to true, the message is checked and validated, but isn't sent to the end recipient.
Return type

dict

Returns

Response Syntax

{
    'MessageId': 'string'
}

Response Structure

  • (dict) --

    • MessageId (string) --

      The unique identifier for the message.

Exceptions

set_default_message_type(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.set_default_message_type(
    ConfigurationSetName='string',
    MessageType='TRANSACTIONAL'|'PROMOTIONAL'
)
Parameters
  • ConfigurationSetName (string) --

    [REQUIRED]

    The configuration set to update with a new default message type. This field can be the ConsigurationSetName or ConfigurationSetArn.

  • MessageType (string) --

    [REQUIRED]

    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.

Return type

dict

Returns

Response Syntax

{
    'ConfigurationSetArn': 'string',
    'ConfigurationSetName': 'string',
    'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL'
}

Response Structure

  • (dict) --

    • ConfigurationSetArn (string) --

      The Amazon Resource Name (ARN) of the updated configuration set.

    • ConfigurationSetName (string) --

      The name of the configuration set that was updated.

    • MessageType (string) --

      The new default message type of the configuration set.

Exceptions

set_default_sender_id(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.set_default_sender_id(
    ConfigurationSetName='string',
    SenderId='string'
)
Parameters
  • ConfigurationSetName (string) --

    [REQUIRED]

    The configuration set to updated with a new default SenderId. This field can be the ConsigurationSetName or ConfigurationSetArn.

  • SenderId (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'ConfigurationSetArn': 'string',
    'ConfigurationSetName': 'string',
    'SenderId': 'string'
}

Response Structure

  • (dict) --

    • ConfigurationSetArn (string) --

      The Amazon Resource Name (ARN) of the updated configuration set.

    • ConfigurationSetName (string) --

      The name of the configuration set that was updated.

    • SenderId (string) --

      The default sender ID to set for the ConfigurationSet.

Exceptions

set_text_message_spend_limit_override(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.set_text_message_spend_limit_override(
    MonthlyLimit=123
)
Parameters
MonthlyLimit (integer) --

[REQUIRED]

The new monthly limit to enforce on text messages.

Return type
dict
Returns
Response Syntax
{
    'MonthlyLimit': 123
}

Response Structure

  • (dict) --
    • MonthlyLimit (integer) --

      The current monthly limit to enforce on sending text messages.

Exceptions

set_voice_message_spend_limit_override(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.set_voice_message_spend_limit_override(
    MonthlyLimit=123
)
Parameters
MonthlyLimit (integer) --

[REQUIRED]

The new monthly limit to enforce on voice messages.

Return type
dict
Returns
Response Syntax
{
    'MonthlyLimit': 123
}

Response Structure

  • (dict) --
    • MonthlyLimit (integer) --

      The current monthly limit to enforce on sending voice messages.

Exceptions

tag_resource(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource.

  • Tags (list) --

    [REQUIRED]

    An array of key and value pair tags that are associated with the resource.

    • (dict) --

      The list of tags to be added to the specified topic.

      • Key (string) -- [REQUIRED]

        The key identifier, or name, of the tag.

      • Value (string) -- [REQUIRED]

        The string value associated with the key of the tag.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource.

  • TagKeys (list) --

    [REQUIRED]

    An array of tag key values to unassociate with the resource.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_event_destination(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.update_event_destination(
    ConfigurationSetName='string',
    EventDestinationName='string',
    Enabled=True|False,
    MatchingEventTypes=[
        'ALL'|'TEXT_ALL'|'TEXT_SENT'|'TEXT_PENDING'|'TEXT_QUEUED'|'TEXT_SUCCESSFUL'|'TEXT_DELIVERED'|'TEXT_INVALID'|'TEXT_INVALID_MESSAGE'|'TEXT_UNREACHABLE'|'TEXT_CARRIER_UNREACHABLE'|'TEXT_BLOCKED'|'TEXT_CARRIER_BLOCKED'|'TEXT_SPAM'|'TEXT_UNKNOWN'|'TEXT_TTL_EXPIRED'|'VOICE_ALL'|'VOICE_INITIATED'|'VOICE_RINGING'|'VOICE_ANSWERED'|'VOICE_COMPLETED'|'VOICE_BUSY'|'VOICE_NO_ANSWER'|'VOICE_FAILED'|'VOICE_TTL_EXPIRED',
    ],
    CloudWatchLogsDestination={
        'IamRoleArn': 'string',
        'LogGroupArn': 'string'
    },
    KinesisFirehoseDestination={
        'IamRoleArn': 'string',
        'DeliveryStreamArn': 'string'
    },
    SnsDestination={
        'TopicArn': 'string'
    }
)
Parameters
  • ConfigurationSetName (string) --

    [REQUIRED]

    The configuration set to update with the new event destination. Valid values for this can be the ConfigurationSetName or ConfigurationSetArn.

  • EventDestinationName (string) --

    [REQUIRED]

    The name to use for the event destination.

  • Enabled (boolean) -- When set to true logging is enabled.
  • MatchingEventTypes (list) --

    An array of event types that determine which events to log.

    • (string) --
  • CloudWatchLogsDestination (dict) --

    An object that contains information about an event destination that sends data to CloudWatch Logs.

    • IamRoleArn (string) -- [REQUIRED]

      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 (string) -- [REQUIRED]

      The name of the Amazon CloudWatch log group that you want to record events in.

  • KinesisFirehoseDestination (dict) --

    An object that contains information about an event destination for logging to Kinesis Data Firehose.

    • IamRoleArn (string) -- [REQUIRED]

      The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.

    • DeliveryStreamArn (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) of the delivery stream.

  • SnsDestination (dict) --

    An object that contains information about an event destination that sends data to Amazon SNS.

    • TopicArn (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.

Return type

dict

Returns

Response Syntax

{
    'ConfigurationSetArn': 'string',
    'ConfigurationSetName': 'string',
    'EventDestination': {
        'EventDestinationName': 'string',
        'Enabled': True|False,
        'MatchingEventTypes': [
            'ALL'|'TEXT_ALL'|'TEXT_SENT'|'TEXT_PENDING'|'TEXT_QUEUED'|'TEXT_SUCCESSFUL'|'TEXT_DELIVERED'|'TEXT_INVALID'|'TEXT_INVALID_MESSAGE'|'TEXT_UNREACHABLE'|'TEXT_CARRIER_UNREACHABLE'|'TEXT_BLOCKED'|'TEXT_CARRIER_BLOCKED'|'TEXT_SPAM'|'TEXT_UNKNOWN'|'TEXT_TTL_EXPIRED'|'VOICE_ALL'|'VOICE_INITIATED'|'VOICE_RINGING'|'VOICE_ANSWERED'|'VOICE_COMPLETED'|'VOICE_BUSY'|'VOICE_NO_ANSWER'|'VOICE_FAILED'|'VOICE_TTL_EXPIRED',
        ],
        'CloudWatchLogsDestination': {
            'IamRoleArn': 'string',
            'LogGroupArn': 'string'
        },
        'KinesisFirehoseDestination': {
            'IamRoleArn': 'string',
            'DeliveryStreamArn': 'string'
        },
        'SnsDestination': {
            'TopicArn': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • ConfigurationSetArn (string) --

      The Amazon Resource Name (ARN) for the ConfigurationSet that was updated.

    • ConfigurationSetName (string) --

      The name of the configuration set.

    • EventDestination (dict) --

      An EventDestination object containing the details of where events will be logged.

      • EventDestinationName (string) --

        The name of the EventDestination.

      • Enabled (boolean) --

        When set to true events will be logged.

      • MatchingEventTypes (list) --

        An array of event types that determine which events to log.

        • (string) --
      • CloudWatchLogsDestination (dict) --

        An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.

        • IamRoleArn (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 (string) --

          The name of the Amazon CloudWatch log group that you want to record events in.

      • KinesisFirehoseDestination (dict) --

        An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.

        • IamRoleArn (string) --

          The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.

        • DeliveryStreamArn (string) --

          The Amazon Resource Name (ARN) of the delivery stream.

      • SnsDestination (dict) --

        An object that contains information about an event destination that sends logging events to Amazon SNS.

        • TopicArn (string) --

          The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.

Exceptions

update_phone_number(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.update_phone_number(
    PhoneNumberId='string',
    TwoWayEnabled=True|False,
    TwoWayChannelArn='string',
    SelfManagedOptOutsEnabled=True|False,
    OptOutListName='string',
    DeletionProtectionEnabled=True|False
)
Parameters
  • PhoneNumberId (string) --

    [REQUIRED]

    The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.

  • TwoWayEnabled (boolean) -- By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
  • TwoWayChannelArn (string) -- The Amazon Resource Name (ARN) of the two way channel.
  • SelfManagedOptOutsEnabled (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.
  • OptOutListName (string) -- The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.
  • DeletionProtectionEnabled (boolean) -- By default this is set to false. When set to true the phone number can't be deleted.
Return type

dict

Returns

Response Syntax

{
    'PhoneNumberArn': 'string',
    'PhoneNumberId': 'string',
    'PhoneNumber': 'string',
    'Status': 'PENDING'|'ACTIVE'|'ASSOCIATING'|'DISASSOCIATING'|'DELETED',
    'IsoCountryCode': 'string',
    'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
    'NumberCapabilities': [
        'SMS'|'VOICE',
    ],
    'NumberType': 'SHORT_CODE'|'LONG_CODE'|'TOLL_FREE'|'TEN_DLC',
    'MonthlyLeasingPrice': 'string',
    'TwoWayEnabled': True|False,
    'TwoWayChannelArn': 'string',
    'SelfManagedOptOutsEnabled': True|False,
    'OptOutListName': 'string',
    'DeletionProtectionEnabled': True|False,
    'CreatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • PhoneNumberArn (string) --

      The Amazon Resource Name (ARN) of the updated phone number.

    • PhoneNumberId (string) --

      The unique identifier of the phone number.

    • PhoneNumber (string) --

      The phone number that was updated.

    • Status (string) --

      The current status of the request.

    • IsoCountryCode (string) --

      The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

    • MessageType (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 (list) --

      Specifies if the number could be used for text messages, voice or both.

      • (string) --
    • NumberType (string) --

      The type of number that was requested.

    • MonthlyLeasingPrice (string) --

      The monthly leasing price of the phone number, in US dollars.

    • TwoWayEnabled (boolean) --

      By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

    • TwoWayChannelArn (string) --

      The Amazon Resource Name (ARN) of the two way channel.

    • SelfManagedOptOutsEnabled (boolean) --

      This is true if self managed opt-out are enabled.

    • OptOutListName (string) --

      The name of the OptOutList associated with the phone number.

    • DeletionProtectionEnabled (boolean) --

      When set to true the phone number can't be deleted.

    • CreatedTimestamp (datetime) --

      The time when the phone number was created, in UNIX epoch time format.

Exceptions

update_pool(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.update_pool(
    PoolId='string',
    TwoWayEnabled=True|False,
    TwoWayChannelArn='string',
    SelfManagedOptOutsEnabled=True|False,
    OptOutListName='string',
    SharedRoutesEnabled=True|False,
    DeletionProtectionEnabled=True|False
)
Parameters
  • PoolId (string) --

    [REQUIRED]

    The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.

  • TwoWayEnabled (boolean) -- By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
  • TwoWayChannelArn (string) -- The Amazon Resource Name (ARN) of the two way channel.
  • SelfManagedOptOutsEnabled (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.
  • OptOutListName (string) -- The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.
  • SharedRoutesEnabled (boolean) -- Indicates whether shared routes are enabled for the pool.
  • DeletionProtectionEnabled (boolean) -- When set to true the pool can't be deleted.
Return type

dict

Returns

Response Syntax

{
    'PoolArn': 'string',
    'PoolId': 'string',
    'Status': 'CREATING'|'ACTIVE'|'DELETING',
    'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
    'TwoWayEnabled': True|False,
    'TwoWayChannelArn': 'string',
    'SelfManagedOptOutsEnabled': True|False,
    'OptOutListName': 'string',
    'SharedRoutesEnabled': True|False,
    'DeletionProtectionEnabled': True|False,
    'CreatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • PoolArn (string) --

      The ARN of the pool.

    • PoolId (string) --

      The unique identifier of the pool.

    • Status (string) --

      The current status of the pool update request.

    • MessageType (string) --

      The type of message for the pool to use.

    • TwoWayEnabled (boolean) --

      By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

    • TwoWayChannelArn (string) --

      The Amazon Resource Name (ARN) of the two way channel.

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

    • OptOutListName (string) --

      The name of the OptOutList associated with the pool.

    • SharedRoutesEnabled (boolean) --

      Indicates whether shared routes are enabled for the pool.

    • DeletionProtectionEnabled (boolean) --

      When set to true the pool can't be deleted.

    • CreatedTimestamp (datetime) --

      The time when the pool was created, in UNIX epoch time format.

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException

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

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Reason': 'INSUFFICIENT_ACCOUNT_REPUTATION'|'ACCOUNT_DISABLED',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

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

    • Message (string) --

    • Reason (string) --

      The reason for the exception.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class PinpointSMSVoiceV2.Client.exceptions.ConflictException

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

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Reason': 'DELETION_PROTECTION_ENABLED'|'DESTINATION_PHONE_NUMBER_NOT_VERIFIED'|'DESTINATION_PHONE_NUMBER_OPTED_OUT'|'EVENT_DESTINATION_MISMATCH'|'KEYWORD_MISMATCH'|'LAST_PHONE_NUMBER'|'SELF_MANAGED_OPT_OUTS_MISMATCH'|'MESSAGE_TYPE_MISMATCH'|'NO_ORIGINATION_IDENTITIES_FOUND'|'OPT_OUT_LIST_MISMATCH'|'PHONE_NUMBER_ASSOCIATED_TO_POOL'|'PHONE_NUMBER_NOT_ASSOCIATED_TO_POOL'|'PHONE_NUMBER_NOT_IN_REGISTRATION_REGION'|'RESOURCE_ALREADY_EXISTS'|'RESOURCE_DELETION_NOT_ALLOWED'|'RESOURCE_MODIFICATION_NOT_ALLOWED'|'RESOURCE_NOT_ACTIVE'|'RESOURCE_NOT_EMPTY'|'TWO_WAY_CONFIG_MISMATCH',
    'ResourceType': 'account'|'phone-number'|'sender-id'|'pool'|'configuration-set'|'opt-out-list'|'event-destination'|'keyword'|'opted-out-number'|'registration',
    'ResourceId': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    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.

    • Message (string) --

    • Reason (string) --

      The reason for the exception.

    • ResourceType (string) --

      The type of resource that caused the exception.

    • ResourceId (string) --

      The unique identifier of the request.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class PinpointSMSVoiceV2.Client.exceptions.InternalServerException

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

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'RequestId': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    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.

    • Message (string) --

    • RequestId (string) --

      The unique identifier of the request.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class PinpointSMSVoiceV2.Client.exceptions.ResourceNotFoundException

A requested resource couldn't be found.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ResourceType': 'account'|'phone-number'|'sender-id'|'pool'|'configuration-set'|'opt-out-list'|'event-destination'|'keyword'|'opted-out-number'|'registration',
    'ResourceId': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A requested resource couldn't be found.

    • Message (string) --

    • ResourceType (string) --

      The type of resource that caused the exception.

    • ResourceId (string) --

      The unique identifier of the resource.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class PinpointSMSVoiceV2.Client.exceptions.ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Reason': 'CONFIGURATION_SETS_PER_ACCOUNT'|'DAILY_DESTINATION_CALL_LIMIT'|'EVENT_DESTINATIONS_PER_CONFIGURATION_SET'|'KEYWORDS_PER_PHONE_NUMBER'|'KEYWORDS_PER_POOL'|'MONTHLY_SPEND_LIMIT_REACHED_FOR_TEXT'|'MONTHLY_SPEND_LIMIT_REACHED_FOR_VOICE'|'OPT_OUT_LISTS_PER_ACCOUNT'|'ORIGINATION_IDENTITIES_PER_POOL'|'PHONE_NUMBERS_PER_ACCOUNT'|'PHONE_NUMBERS_PER_REGISTRATION'|'POOLS_PER_ACCOUNT'|'TAGS_PER_RESOURCE',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request would cause a service quota to be exceeded.

    • Message (string) --

    • Reason (string) --

      The reason for the exception.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class PinpointSMSVoiceV2.Client.exceptions.ThrottlingException

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

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

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

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class PinpointSMSVoiceV2.Client.exceptions.ValidationException

A validation exception for a field.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Reason': 'UNKNOWN_OPERATION'|'CANNOT_PARSE'|'FIELD_VALIDATION_FAILED'|'OTHER'|'INVALID_PARAMETER'|'INVALID_ARN'|'INVALID_IDENTITY_FOR_DESTINATION_COUNTRY'|'DESTINATION_COUNTRY_BLOCKED'|'CANNOT_ADD_OPTED_OUT_NUMBER'|'COUNTRY_CODE_MISMATCH'|'INVALID_FILTER_VALUES'|'INVALID_NEXT_TOKEN'|'MISSING_PARAMETER'|'PARAMETERS_CANNOT_BE_USED_TOGETHER'|'PHONE_NUMBER_CANNOT_BE_OPTED_IN'|'PHONE_NUMBER_CANNOT_BE_RELEASED'|'PRICE_OVER_THRESHOLD'|'REQUESTED_SPEND_LIMIT_HIGHER_THAN_SERVICE_LIMIT'|'SENDER_ID_NOT_REGISTERED'|'SENDER_ID_NOT_SUPPORTED'|'TWO_WAY_NOT_ENABLED'|'TWO_WAY_NOT_SUPPORTED_IN_COUNTRY'|'TWO_WAY_NOT_SUPPORTED_IN_REGION'|'TWO_WAY_TOPIC_NOT_PRESENT',
    'Fields': [
        {
            'Name': 'string',
            'Message': 'string'
        },
    ],
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A validation exception for a field.

    • Message (string) --

    • Reason (string) --

      The reason for the exception.

    • Fields (list) --

      The field that failed validation.

      • (dict) --

        The field associated with the validation exception.

        • Name (string) --

          The name of the field.

        • Message (string) --

          The message associated with the validation exception with information to help determine its cause.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class PinpointSMSVoiceV2.Paginator.DescribeAccountAttributes
paginator = client.get_paginator('describe_account_attributes')
paginate(**kwargs)

Creates an iterator that will paginate through responses from PinpointSMSVoiceV2.Client.describe_account_attributes().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'AccountAttributes': [
        {
            'Name': 'ACCOUNT_TIER',
            'Value': 'string'
        },
    ],

}

Response Structure

  • (dict) --
    • AccountAttributes (list) --

      An array of AccountAttributes objects.

      • (dict) --

        Displays the attributes associated with a single Amazon Web Services account.

        • Name (string) --

          The name of the account attribute.

        • Value (string) --

          The value associated with the account attribute name.

class PinpointSMSVoiceV2.Paginator.DescribeAccountLimits
paginator = client.get_paginator('describe_account_limits')
paginate(**kwargs)

Creates an iterator that will paginate through responses from PinpointSMSVoiceV2.Client.describe_account_limits().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'AccountLimits': [
        {
            'Name': 'PHONE_NUMBERS'|'POOLS'|'CONFIGURATION_SETS'|'OPT_OUT_LISTS',
            'Used': 123,
            'Max': 123
        },
    ],

}

Response Structure

  • (dict) --
    • AccountLimits (list) --

      An array of AccountLimit objects that show the current spend limits.

      • (dict) --

        The current resource quotas associated with an Amazon Web Services account.

        • Name (string) --

          The name of the attribute to apply the account limit to.

        • Used (integer) --

          The current amount that has been spent, in US dollars.

        • Max (integer) --

          The Amazon Web Services set limit for that resource type, in US dollars.

class PinpointSMSVoiceV2.Paginator.DescribeConfigurationSets
paginator = client.get_paginator('describe_configuration_sets')
paginate(**kwargs)

Creates an iterator that will paginate through responses from PinpointSMSVoiceV2.Client.describe_configuration_sets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ConfigurationSetNames=[
        'string',
    ],
    Filters=[
        {
            'Name': 'event-destination-name'|'matching-event-types'|'default-message-type'|'default-sender-id',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ConfigurationSetNames (list) --

    An array of strings. Each element can be either a ConfigurationSetName or ConfigurationSetArn.

    • (string) --
  • Filters (list) --

    An array of filters to apply to the results that are returned.

    • (dict) --

      The information for configuration sets that meet a specified criteria.

      • Name (string) -- [REQUIRED]

        The name of the attribute to filter on.

      • Values (list) -- [REQUIRED]

        An array values to filter for.

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'ConfigurationSets': [
        {
            'ConfigurationSetArn': 'string',
            'ConfigurationSetName': 'string',
            'EventDestinations': [
                {
                    'EventDestinationName': 'string',
                    'Enabled': True|False,
                    'MatchingEventTypes': [
                        'ALL'|'TEXT_ALL'|'TEXT_SENT'|'TEXT_PENDING'|'TEXT_QUEUED'|'TEXT_SUCCESSFUL'|'TEXT_DELIVERED'|'TEXT_INVALID'|'TEXT_INVALID_MESSAGE'|'TEXT_UNREACHABLE'|'TEXT_CARRIER_UNREACHABLE'|'TEXT_BLOCKED'|'TEXT_CARRIER_BLOCKED'|'TEXT_SPAM'|'TEXT_UNKNOWN'|'TEXT_TTL_EXPIRED'|'VOICE_ALL'|'VOICE_INITIATED'|'VOICE_RINGING'|'VOICE_ANSWERED'|'VOICE_COMPLETED'|'VOICE_BUSY'|'VOICE_NO_ANSWER'|'VOICE_FAILED'|'VOICE_TTL_EXPIRED',
                    ],
                    'CloudWatchLogsDestination': {
                        'IamRoleArn': 'string',
                        'LogGroupArn': 'string'
                    },
                    'KinesisFirehoseDestination': {
                        'IamRoleArn': 'string',
                        'DeliveryStreamArn': 'string'
                    },
                    'SnsDestination': {
                        'TopicArn': 'string'
                    }
                },
            ],
            'DefaultMessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
            'DefaultSenderId': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) --

    • ConfigurationSets (list) --

      An array of ConfigurationSets objects.

      • (dict) --

        Information related to a given configuration set in your Amazon Web Services account.

        • ConfigurationSetArn (string) --

          The Resource Name (ARN) of the ConfigurationSet.

        • ConfigurationSetName (string) --

          The name of the ConfigurationSet.

        • EventDestinations (list) --

          An array of EventDestination objects that describe any events to log and where to log them.

          • (dict) --

            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.

            • EventDestinationName (string) --

              The name of the EventDestination.

            • Enabled (boolean) --

              When set to true events will be logged.

            • MatchingEventTypes (list) --

              An array of event types that determine which events to log.

              • (string) --
            • CloudWatchLogsDestination (dict) --

              An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.

              • IamRoleArn (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 (string) --

                The name of the Amazon CloudWatch log group that you want to record events in.

            • KinesisFirehoseDestination (dict) --

              An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.

              • IamRoleArn (string) --

                The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.

              • DeliveryStreamArn (string) --

                The Amazon Resource Name (ARN) of the delivery stream.

            • SnsDestination (dict) --

              An object that contains information about an event destination that sends logging events to Amazon SNS.

              • TopicArn (string) --

                The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.

        • DefaultMessageType (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 (string) --

          The default sender ID used by the ConfigurationSet.

        • CreatedTimestamp (datetime) --

          The time when the ConfigurationSet was created, in UNIX epoch time format.

class PinpointSMSVoiceV2.Paginator.DescribeKeywords
paginator = client.get_paginator('describe_keywords')
paginate(**kwargs)

Creates an iterator that will paginate through responses from PinpointSMSVoiceV2.Client.describe_keywords().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OriginationIdentity='string',
    Keywords=[
        'string',
    ],
    Filters=[
        {
            'Name': 'keyword-action',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • OriginationIdentity (string) --

    [REQUIRED]

    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.

  • Keywords (list) --

    An array of keywords to search for.

    • (string) --
  • Filters (list) --

    An array of keyword filters to filter the results.

    • (dict) --

      The information for keywords that meet a specified criteria.

      • Name (string) -- [REQUIRED]

        The name of the attribute to filter on.

      • Values (list) -- [REQUIRED]

        An array values to filter for.

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'OriginationIdentityArn': 'string',
    'OriginationIdentity': 'string',
    'Keywords': [
        {
            'Keyword': 'string',
            'KeywordMessage': 'string',
            'KeywordAction': 'AUTOMATIC_RESPONSE'|'OPT_OUT'|'OPT_IN'
        },
    ],

}

Response Structure

  • (dict) --

    • OriginationIdentityArn (string) --

      The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.

    • OriginationIdentity (string) --

      The PhoneNumberId or PoolId that is associated with the OriginationIdentity.

    • Keywords (list) --

      An array of KeywordInformation objects that contain the results.

      • (dict) --

        The information for all keywords in a pool.

        • Keyword (string) --

          The keyword as a string.

        • KeywordMessage (string) --

          A custom message that can be used with the keyword.

        • KeywordAction (string) --

          The action to perform for the keyword.

class PinpointSMSVoiceV2.Paginator.DescribeOptOutLists
paginator = client.get_paginator('describe_opt_out_lists')
paginate(**kwargs)

Creates an iterator that will paginate through responses from PinpointSMSVoiceV2.Client.describe_opt_out_lists().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OptOutListNames=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • OptOutListNames (list) --

    The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.

    • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'OptOutLists': [
        {
            'OptOutListArn': 'string',
            'OptOutListName': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) --

    • OptOutLists (list) --

      An array of OptOutListInformation objects that contain the details for the requested OptOutLists.

      • (dict) --

        The information for all OptOutList in an Amazon Web Services account.

        • OptOutListArn (string) --

          The Amazon Resource Name (ARN) of the OptOutList.

        • OptOutListName (string) --

          The name of the OptOutList.

        • CreatedTimestamp (datetime) --

          The time when the OutOutList was created, in UNIX epoch time format.

class PinpointSMSVoiceV2.Paginator.DescribeOptedOutNumbers
paginator = client.get_paginator('describe_opted_out_numbers')
paginate(**kwargs)

Creates an iterator that will paginate through responses from PinpointSMSVoiceV2.Client.describe_opted_out_numbers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OptOutListName='string',
    OptedOutNumbers=[
        'string',
    ],
    Filters=[
        {
            'Name': 'end-user-opted-out',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • OptOutListName (string) --

    [REQUIRED]

    The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

  • OptedOutNumbers (list) --

    An array of phone numbers to search for in the OptOutList.

    • (string) --
  • Filters (list) --

    An array of OptedOutFilter objects to filter the results on.

    • (dict) --

      The information for opted out numbers that meet a specified criteria.

      • Name (string) -- [REQUIRED]

        The name of the attribute to filter on.

      • Values (list) -- [REQUIRED]

        An array of values to filter for.

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'OptOutListArn': 'string',
    'OptOutListName': 'string',
    'OptedOutNumbers': [
        {
            'OptedOutNumber': 'string',
            'OptedOutTimestamp': datetime(2015, 1, 1),
            'EndUserOptedOut': True|False
        },
    ],

}

Response Structure

  • (dict) --

    • OptOutListArn (string) --

      The Amazon Resource Name (ARN) of the OptOutList.

    • OptOutListName (string) --

      The name of the OptOutList.

    • OptedOutNumbers (list) --

      An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.

      • (dict) --

        The information for an opted out number in an Amazon Web Services account.

        • OptedOutNumber (string) --

          The phone number that is opted out.

        • OptedOutTimestamp (datetime) --

          The time that the op tout occurred, in UNIX epoch time format.

        • EndUserOptedOut (boolean) --

          This is set to true if it was the end recipient that opted out.

class PinpointSMSVoiceV2.Paginator.DescribePhoneNumbers
paginator = client.get_paginator('describe_phone_numbers')
paginate(**kwargs)

Creates an iterator that will paginate through responses from PinpointSMSVoiceV2.Client.describe_phone_numbers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PhoneNumberIds=[
        'string',
    ],
    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',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • PhoneNumberIds (list) --

    The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.

    • (string) --
  • Filters (list) --

    An array of PhoneNumberFilter objects to filter the results.

    • (dict) --

      The information for a phone number that meets a specified criteria.

      • Name (string) -- [REQUIRED]

        The name of the attribute to filter on.

      • Values (list) -- [REQUIRED]

        An array values to filter for.

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'PhoneNumbers': [
        {
            'PhoneNumberArn': 'string',
            'PhoneNumberId': 'string',
            'PhoneNumber': 'string',
            'Status': 'PENDING'|'ACTIVE'|'ASSOCIATING'|'DISASSOCIATING'|'DELETED',
            'IsoCountryCode': 'string',
            'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
            'NumberCapabilities': [
                'SMS'|'VOICE',
            ],
            'NumberType': 'SHORT_CODE'|'LONG_CODE'|'TOLL_FREE'|'TEN_DLC',
            'MonthlyLeasingPrice': 'string',
            'TwoWayEnabled': True|False,
            'TwoWayChannelArn': 'string',
            'SelfManagedOptOutsEnabled': True|False,
            'OptOutListName': 'string',
            'DeletionProtectionEnabled': True|False,
            'PoolId': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) --

    • PhoneNumbers (list) --

      An array of PhoneNumberInformation objects that contain the details for the requested phone numbers.

      • (dict) --

        The information for a phone number in an Amazon Web Services account.

        • PhoneNumberArn (string) --

          The Amazon Resource Name (ARN) associated with the phone number.

        • PhoneNumberId (string) --

          The unique identifier for the phone number.

        • PhoneNumber (string) --

          The phone number in E.164 format.

        • Status (string) --

          The current status of the phone number.

        • IsoCountryCode (string) --

          The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

        • MessageType (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 (list) --

          Describes if the origination identity can be used for text messages, voice calls or both.

          • (string) --
        • NumberType (string) --

          The type of phone number.

        • MonthlyLeasingPrice (string) --

          The price, in US dollars, to lease the phone number.

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

        • TwoWayChannelArn (string) --

          The Amazon Resource Name (ARN) of the two way channel.

        • SelfManagedOptOutsEnabled (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

        • OptOutListName (string) --

          The name of the OptOutList associated with the phone number.

        • DeletionProtectionEnabled (boolean) --

          When set to true the phone number can't be deleted.

        • PoolId (string) --

          The unique identifier of the pool associated with the phone number.

        • CreatedTimestamp (datetime) --

          The time when the phone number was created, in UNIX epoch time format.

class PinpointSMSVoiceV2.Paginator.DescribePools
paginator = client.get_paginator('describe_pools')
paginate(**kwargs)

Creates an iterator that will paginate through responses from PinpointSMSVoiceV2.Client.describe_pools().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PoolIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'status'|'message-type'|'two-way-enabled'|'self-managed-opt-outs-enabled'|'opt-out-list-name'|'shared-routes-enabled'|'deletion-protection-enabled',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • PoolIds (list) --

    The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.

    • (string) --
  • Filters (list) --

    An array of PoolFilter objects to filter the results.

    • (dict) --

      The information for a pool that meets a specified criteria.

      • Name (string) -- [REQUIRED]

        The name of the attribute to filter on.

      • Values (list) -- [REQUIRED]

        An array values to filter for.

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Pools': [
        {
            'PoolArn': 'string',
            'PoolId': 'string',
            'Status': 'CREATING'|'ACTIVE'|'DELETING',
            'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
            'TwoWayEnabled': True|False,
            'TwoWayChannelArn': 'string',
            'SelfManagedOptOutsEnabled': True|False,
            'OptOutListName': 'string',
            'SharedRoutesEnabled': True|False,
            'DeletionProtectionEnabled': True|False,
            'CreatedTimestamp': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) --

    • Pools (list) --

      An array of PoolInformation objects that contain the details for the requested pools.

      • (dict) --

        The information for a pool in an Amazon Web Services account.

        • PoolArn (string) --

          The Amazon Resource Name (ARN) for the pool.

        • PoolId (string) --

          The unique identifier for the pool.

        • Status (string) --

          The current status of the pool.

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

        • TwoWayEnabled (boolean) --

          When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

        • TwoWayChannelArn (string) --

          The Amazon Resource Name (ARN) of the two way channel.

        • SelfManagedOptOutsEnabled (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

        • OptOutListName (string) --

          The name of the OptOutList associated with the pool.

        • SharedRoutesEnabled (boolean) --

          Allows you to enable shared routes on your pool.

          By default, this is set to False . If you set this value to True , 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.

        • DeletionProtectionEnabled (boolean) --

          When set to true the pool can't be deleted.

        • CreatedTimestamp (datetime) --

          The time when the pool was created, in UNIX epoch time format.

class PinpointSMSVoiceV2.Paginator.DescribeSenderIds
paginator = client.get_paginator('describe_sender_ids')
paginate(**kwargs)

Creates an iterator that will paginate through responses from PinpointSMSVoiceV2.Client.describe_sender_ids().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SenderIds=[
        {
            'SenderId': 'string',
            'IsoCountryCode': 'string'
        },
    ],
    Filters=[
        {
            'Name': 'sender-id'|'iso-country-code'|'message-type',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • SenderIds (list) --

    An array of SenderIdAndCountry objects to search for.

    • (dict) --

      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 .

      • SenderId (string) -- [REQUIRED]

        The unique identifier of the sender.

      • IsoCountryCode (string) -- [REQUIRED]

        The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

  • Filters (list) --

    An array of SenderIdFilter objects to filter the results.

    • (dict) --

      The information for a sender ID that meets a specified criteria.

      • Name (string) -- [REQUIRED]

        The name of the attribute to filter on.

      • Values (list) -- [REQUIRED]

        An array of values to filter for.

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'SenderIds': [
        {
            'SenderIdArn': 'string',
            'SenderId': 'string',
            'IsoCountryCode': 'string',
            'MessageTypes': [
                'TRANSACTIONAL'|'PROMOTIONAL',
            ],
            'MonthlyLeasingPrice': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    • SenderIds (list) --

      An array of SernderIdInformation objects that contain the details for the requested SenderIds.

      • (dict) --

        The information for all SenderIds in an Amazon Web Services account.

        • SenderIdArn (string) --

          The Amazon Resource Name (ARN) associated with the SenderId.

        • SenderId (string) --

          The alphanumeric sender ID in a specific country that you'd like to describe.

        • IsoCountryCode (string) --

          The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

        • MessageTypes (list) --

          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.

          • (string) --
        • MonthlyLeasingPrice (string) --

          The monthly leasing price, in US dollars.

class PinpointSMSVoiceV2.Paginator.DescribeSpendLimits
paginator = client.get_paginator('describe_spend_limits')
paginate(**kwargs)

Creates an iterator that will paginate through responses from PinpointSMSVoiceV2.Client.describe_spend_limits().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'SpendLimits': [
        {
            'Name': 'TEXT_MESSAGE_MONTHLY_SPEND_LIMIT'|'VOICE_MESSAGE_MONTHLY_SPEND_LIMIT',
            'EnforcedLimit': 123,
            'MaxLimit': 123,
            'Overridden': True|False
        },
    ],

}

Response Structure

  • (dict) --
    • SpendLimits (list) --

      An array of SpendLimit objects that contain the details for the requested spend limits.

      • (dict) --

        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 .

        • Name (string) --

          The name for the SpendLimit.

        • EnforcedLimit (integer) --

          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, Overridden must be set to true.

        • MaxLimit (integer) --

          The maximum amount of money that you are able to spend to send messages each month, in US dollars.

        • Overridden (boolean) --

          When set to True , the value that has been specified in the EnforcedLimit is used to determine the maximum amount in US dollars that can be spent to send messages each month, in US dollars.

class PinpointSMSVoiceV2.Paginator.ListPoolOriginationIdentities
paginator = client.get_paginator('list_pool_origination_identities')
paginate(**kwargs)

Creates an iterator that will paginate through responses from PinpointSMSVoiceV2.Client.list_pool_origination_identities().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PoolId='string',
    Filters=[
        {
            'Name': 'iso-country-code'|'number-capability',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • PoolId (string) --

    [REQUIRED]

    The unique identifier for the pool. This value can be either the PoolId or PoolArn.

  • Filters (list) --

    An array of PoolOriginationIdentitiesFilter objects to filter the results..

    • (dict) --

      Information about origination identities associated with a pool that meets a specified criteria.

      • Name (string) -- [REQUIRED]

        The name of the attribute to filter on.

      • Values (list) -- [REQUIRED]

        An array values to filter for.

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'PoolArn': 'string',
    'PoolId': 'string',
    'OriginationIdentities': [
        {
            'OriginationIdentityArn': 'string',
            'OriginationIdentity': 'string',
            'IsoCountryCode': 'string',
            'NumberCapabilities': [
                'SMS'|'VOICE',
            ]
        },
    ],

}

Response Structure

  • (dict) --

    • PoolArn (string) --

      The Amazon Resource Name (ARN) for the pool.

    • PoolId (string) --

      The unique PoolId of the pool.

    • OriginationIdentities (list) --

      An array of any OriginationIdentityMetadata objects.

      • (dict) --

        The metadata for an origination identity associated with a pool.

        • OriginationIdentityArn (string) --

          The Amazon Resource Name (ARN) associated with the origination identity.

        • OriginationIdentity (string) --

          The unique identifier of the origination identity.

        • IsoCountryCode (string) --

          The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

        • NumberCapabilities (list) --

          Describes if the origination identity can be used for text messages, voice calls or both.

          • (string) --