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. Amazon Pinpoint SMS and Voice, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API.
If you’re new to Amazon Pinpoint SMS, it’s also helpful to review the Amazon Pinpoint SMS User Guide. The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint SMS 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.
Regional availability
The Amazon Pinpoint SMS and Voice, version 2 API Reference is available in several Amazon Web Services Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see Amazon Web Services Service Endpoints and Amazon Pinpoint endpoints and quotas in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.
In each Region, Amazon Web Services maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see Amazon Web Services Global Infrastructure.
import boto3 client = boto3.client('pinpoint-sms-voice-v2')
These are the available methods:
- associate_origination_identity
- associate_protect_configuration
- can_paginate
- close
- create_configuration_set
- create_event_destination
- create_opt_out_list
- create_pool
- create_protect_configuration
- create_registration
- create_registration_association
- create_registration_attachment
- create_registration_version
- create_verified_destination_number
- delete_account_default_protect_configuration
- delete_configuration_set
- delete_default_message_type
- delete_default_sender_id
- delete_event_destination
- delete_keyword
- delete_media_message_spend_limit_override
- delete_opt_out_list
- delete_opted_out_number
- delete_pool
- delete_protect_configuration
- delete_registration
- delete_registration_attachment
- delete_registration_field_value
- delete_text_message_spend_limit_override
- delete_verified_destination_number
- delete_voice_message_spend_limit_override
- describe_account_attributes
- describe_account_limits
- describe_configuration_sets
- describe_keywords
- describe_opt_out_lists
- describe_opted_out_numbers
- describe_phone_numbers
- describe_pools
- describe_protect_configurations
- describe_registration_attachments
- describe_registration_field_definitions
- describe_registration_field_values
- describe_registration_section_definitions
- describe_registration_type_definitions
- describe_registration_versions
- describe_registrations
- describe_sender_ids
- describe_spend_limits
- describe_verified_destination_numbers
- disassociate_origination_identity
- disassociate_protect_configuration
- discard_registration_version
- get_paginator
- get_protect_configuration_country_rule_set
- get_waiter
- list_pool_origination_identities
- list_registration_associations
- list_tags_for_resource
- put_keyword
- put_opted_out_number
- put_registration_field_value
- release_phone_number
- release_sender_id
- request_phone_number
- request_sender_id
- send_destination_number_verification_code
- send_media_message
- send_text_message
- send_voice_message
- set_account_default_protect_configuration
- set_default_message_type
- set_default_sender_id
- set_media_message_spend_limit_override
- set_text_message_spend_limit_override
- set_voice_message_spend_limit_override
- submit_registration_version
- tag_resource
- untag_resource
- update_event_destination
- update_phone_number
- update_pool
- update_protect_configuration
- update_protect_configuration_country_rule_set
- update_sender_id
- verify_destination_number
Paginators#
Paginators are available on a client instance via the get_paginator method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide.
The available paginators are:
- DescribeAccountAttributes
- DescribeAccountLimits
- DescribeConfigurationSets
- DescribeKeywords
- DescribeOptOutLists
- DescribeOptedOutNumbers
- DescribePhoneNumbers
- DescribePools
- DescribeProtectConfigurations
- DescribeRegistrationAttachments
- DescribeRegistrationFieldDefinitions
- DescribeRegistrationFieldValues
- DescribeRegistrationSectionDefinitions
- DescribeRegistrationTypeDefinitions
- DescribeRegistrationVersions
- DescribeRegistrations
- DescribeSenderIds
- DescribeSpendLimits
- DescribeVerifiedDestinationNumbers
- ListPoolOriginationIdentities
- ListRegistrationAssociations