

******************
PinpointSMSVoiceV2
******************



======
Client
======



.. py:class:: PinpointSMSVoiceV2.Client

  A low-level client representing Amazon Pinpoint SMS Voice V2
  

  Welcome to the *End User Messaging SMS, version 2 API Reference*. This guide provides information about End User Messaging SMS, 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 End User Messaging SMS, version 2 API provides programmatic access to options that are unique to the SMS and voice channels. End User Messaging SMS, 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 End User Messaging SMS, it's also helpful to review the `End User Messaging SMS User Guide <https://docs.aws.amazon.com/sms-voice/latest/userguide/what-is-service.html>`__, where you'll find tutorials, code samples, and procedures that demonstrate how to use End User Messaging SMS features programmatically and how to integrate functionality into mobile apps and other types of applications. The guide also provides key information, such as End User Messaging SMS integration with other Amazon Web Services services, and the quotas that apply to use of the service.

   

  **Regional availability**

   

  The *End User Messaging SMS 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 <https://docs.aws.amazon.com/hgeneral/latest/gr/rande.html#pinpoint_region>`__ and `Amazon Pinpoint endpoints and quotas <https://docs.aws.amazon.com/general/latest/gr/pinpoint.html>`__ in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see `Managing Amazon Web Services Regions <https://docs.aws.amazon.com/general/latest/gr/rande-manage.html>`__ 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. <http://aws.amazon.com/about-aws/global-infrastructure/>`__

  ::

    
    import boto3
    
    client = boto3.client('pinpoint-sms-voice-v2')

  

These are the available methods:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  pinpoint-sms-voice-v2/client/associate_origination_identity
  pinpoint-sms-voice-v2/client/associate_protect_configuration
  pinpoint-sms-voice-v2/client/can_paginate
  pinpoint-sms-voice-v2/client/carrier_lookup
  pinpoint-sms-voice-v2/client/close
  pinpoint-sms-voice-v2/client/create_configuration_set
  pinpoint-sms-voice-v2/client/create_event_destination
  pinpoint-sms-voice-v2/client/create_opt_out_list
  pinpoint-sms-voice-v2/client/create_pool
  pinpoint-sms-voice-v2/client/create_protect_configuration
  pinpoint-sms-voice-v2/client/create_registration
  pinpoint-sms-voice-v2/client/create_registration_association
  pinpoint-sms-voice-v2/client/create_registration_attachment
  pinpoint-sms-voice-v2/client/create_registration_version
  pinpoint-sms-voice-v2/client/create_verified_destination_number
  pinpoint-sms-voice-v2/client/delete_account_default_protect_configuration
  pinpoint-sms-voice-v2/client/delete_configuration_set
  pinpoint-sms-voice-v2/client/delete_default_message_type
  pinpoint-sms-voice-v2/client/delete_default_sender_id
  pinpoint-sms-voice-v2/client/delete_event_destination
  pinpoint-sms-voice-v2/client/delete_keyword
  pinpoint-sms-voice-v2/client/delete_media_message_spend_limit_override
  pinpoint-sms-voice-v2/client/delete_opt_out_list
  pinpoint-sms-voice-v2/client/delete_opted_out_number
  pinpoint-sms-voice-v2/client/delete_pool
  pinpoint-sms-voice-v2/client/delete_protect_configuration
  pinpoint-sms-voice-v2/client/delete_protect_configuration_rule_set_number_override
  pinpoint-sms-voice-v2/client/delete_registration
  pinpoint-sms-voice-v2/client/delete_registration_attachment
  pinpoint-sms-voice-v2/client/delete_registration_field_value
  pinpoint-sms-voice-v2/client/delete_resource_policy
  pinpoint-sms-voice-v2/client/delete_text_message_spend_limit_override
  pinpoint-sms-voice-v2/client/delete_verified_destination_number
  pinpoint-sms-voice-v2/client/delete_voice_message_spend_limit_override
  pinpoint-sms-voice-v2/client/describe_account_attributes
  pinpoint-sms-voice-v2/client/describe_account_limits
  pinpoint-sms-voice-v2/client/describe_configuration_sets
  pinpoint-sms-voice-v2/client/describe_keywords
  pinpoint-sms-voice-v2/client/describe_opt_out_lists
  pinpoint-sms-voice-v2/client/describe_opted_out_numbers
  pinpoint-sms-voice-v2/client/describe_phone_numbers
  pinpoint-sms-voice-v2/client/describe_pools
  pinpoint-sms-voice-v2/client/describe_protect_configurations
  pinpoint-sms-voice-v2/client/describe_registration_attachments
  pinpoint-sms-voice-v2/client/describe_registration_field_definitions
  pinpoint-sms-voice-v2/client/describe_registration_field_values
  pinpoint-sms-voice-v2/client/describe_registration_section_definitions
  pinpoint-sms-voice-v2/client/describe_registration_type_definitions
  pinpoint-sms-voice-v2/client/describe_registration_versions
  pinpoint-sms-voice-v2/client/describe_registrations
  pinpoint-sms-voice-v2/client/describe_sender_ids
  pinpoint-sms-voice-v2/client/describe_spend_limits
  pinpoint-sms-voice-v2/client/describe_verified_destination_numbers
  pinpoint-sms-voice-v2/client/disassociate_origination_identity
  pinpoint-sms-voice-v2/client/disassociate_protect_configuration
  pinpoint-sms-voice-v2/client/discard_registration_version
  pinpoint-sms-voice-v2/client/get_paginator
  pinpoint-sms-voice-v2/client/get_protect_configuration_country_rule_set
  pinpoint-sms-voice-v2/client/get_resource_policy
  pinpoint-sms-voice-v2/client/get_waiter
  pinpoint-sms-voice-v2/client/list_pool_origination_identities
  pinpoint-sms-voice-v2/client/list_protect_configuration_rule_set_number_overrides
  pinpoint-sms-voice-v2/client/list_registration_associations
  pinpoint-sms-voice-v2/client/list_tags_for_resource
  pinpoint-sms-voice-v2/client/put_keyword
  pinpoint-sms-voice-v2/client/put_message_feedback
  pinpoint-sms-voice-v2/client/put_opted_out_number
  pinpoint-sms-voice-v2/client/put_protect_configuration_rule_set_number_override
  pinpoint-sms-voice-v2/client/put_registration_field_value
  pinpoint-sms-voice-v2/client/put_resource_policy
  pinpoint-sms-voice-v2/client/release_phone_number
  pinpoint-sms-voice-v2/client/release_sender_id
  pinpoint-sms-voice-v2/client/request_phone_number
  pinpoint-sms-voice-v2/client/request_sender_id
  pinpoint-sms-voice-v2/client/send_destination_number_verification_code
  pinpoint-sms-voice-v2/client/send_media_message
  pinpoint-sms-voice-v2/client/send_text_message
  pinpoint-sms-voice-v2/client/send_voice_message
  pinpoint-sms-voice-v2/client/set_account_default_protect_configuration
  pinpoint-sms-voice-v2/client/set_default_message_feedback_enabled
  pinpoint-sms-voice-v2/client/set_default_message_type
  pinpoint-sms-voice-v2/client/set_default_sender_id
  pinpoint-sms-voice-v2/client/set_media_message_spend_limit_override
  pinpoint-sms-voice-v2/client/set_text_message_spend_limit_override
  pinpoint-sms-voice-v2/client/set_voice_message_spend_limit_override
  pinpoint-sms-voice-v2/client/submit_registration_version
  pinpoint-sms-voice-v2/client/tag_resource
  pinpoint-sms-voice-v2/client/untag_resource
  pinpoint-sms-voice-v2/client/update_event_destination
  pinpoint-sms-voice-v2/client/update_phone_number
  pinpoint-sms-voice-v2/client/update_pool
  pinpoint-sms-voice-v2/client/update_protect_configuration
  pinpoint-sms-voice-v2/client/update_protect_configuration_country_rule_set
  pinpoint-sms-voice-v2/client/update_sender_id
  pinpoint-sms-voice-v2/client/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 <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/paginators.html>`_.

The available paginators are:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  pinpoint-sms-voice-v2/paginator/DescribeAccountAttributes
  pinpoint-sms-voice-v2/paginator/DescribeAccountLimits
  pinpoint-sms-voice-v2/paginator/DescribeConfigurationSets
  pinpoint-sms-voice-v2/paginator/DescribeKeywords
  pinpoint-sms-voice-v2/paginator/DescribeOptOutLists
  pinpoint-sms-voice-v2/paginator/DescribeOptedOutNumbers
  pinpoint-sms-voice-v2/paginator/DescribePhoneNumbers
  pinpoint-sms-voice-v2/paginator/DescribePools
  pinpoint-sms-voice-v2/paginator/DescribeProtectConfigurations
  pinpoint-sms-voice-v2/paginator/DescribeRegistrationAttachments
  pinpoint-sms-voice-v2/paginator/DescribeRegistrationFieldDefinitions
  pinpoint-sms-voice-v2/paginator/DescribeRegistrationFieldValues
  pinpoint-sms-voice-v2/paginator/DescribeRegistrationSectionDefinitions
  pinpoint-sms-voice-v2/paginator/DescribeRegistrationTypeDefinitions
  pinpoint-sms-voice-v2/paginator/DescribeRegistrationVersions
  pinpoint-sms-voice-v2/paginator/DescribeRegistrations
  pinpoint-sms-voice-v2/paginator/DescribeSenderIds
  pinpoint-sms-voice-v2/paginator/DescribeSpendLimits
  pinpoint-sms-voice-v2/paginator/DescribeVerifiedDestinationNumbers
  pinpoint-sms-voice-v2/paginator/ListPoolOriginationIdentities
  pinpoint-sms-voice-v2/paginator/ListProtectConfigurationRuleSetNumberOverrides
  pinpoint-sms-voice-v2/paginator/ListRegistrationAssociations
