PinpointSMSVoice
****************


Client
======

class PinpointSMSVoice.Client

   A low-level client representing Amazon Pinpoint SMS and Voice
   Service (Pinpoint SMS Voice) Pinpoint SMS and Voice Messaging
   public facing APIs:

      import boto3

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

These are the available methods:

* can_paginate

* close

* create_configuration_set

* create_configuration_set_event_destination

* delete_configuration_set

* delete_configuration_set_event_destination

* get_configuration_set_event_destinations

* get_paginator

* get_waiter

* send_voice_message

* update_configuration_set_event_destination
PinpointSMSVoice / Client / get_paginator


get_paginator
*************

PinpointSMSVoice.Client.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:
      "botocore.paginate.Paginator"

   Returns:
      A paginator object.
PinpointSMSVoice / Client / delete_configuration_set_event_destination


delete_configuration_set_event_destination
******************************************

PinpointSMSVoice.Client.delete_configuration_set_event_destination(**kwargs)

   Deletes an event destination in a configuration set.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.delete_configuration_set_event_destination(
          ConfigurationSetName='string',
          EventDestinationName='string'
      )

   Parameters:
      * **ConfigurationSetName** (*string*) -- **[REQUIRED]**
        ConfigurationSetName

      * **EventDestinationName** (*string*) -- **[REQUIRED]**
        EventDestinationName

   Return type:
      dict

   Returns:
      **Response Syntax**

         {}

      **Response Structure**

      * *(dict) --* DeleteConfigurationSetEventDestinationResponse

   **Exceptions**

   * "PinpointSMSVoice.Client.exceptions.NotFoundException"

   * "PinpointSMSVoice.Client.exceptions.TooManyRequestsException"

   * "PinpointSMSVoice.Client.exceptions.BadRequestException"

   * "PinpointSMSVoice.Client.exceptions.InternalServiceErrorExceptio
     n"
PinpointSMSVoice / Client / can_paginate


can_paginate
************

PinpointSMSVoice.Client.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.
PinpointSMSVoice / Client / delete_configuration_set


delete_configuration_set
************************

PinpointSMSVoice.Client.delete_configuration_set(**kwargs)

   Deletes an existing configuration set.

   See also: AWS API Documentation

   **Request Syntax**

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

   Parameters:
      **ConfigurationSetName** (*string*) -- **[REQUIRED]**
      ConfigurationSetName

   Return type:
      dict

   Returns:
      **Response Syntax**

         {}

      **Response Structure**

      * *(dict) --* DeleteConfigurationSetResponse

   **Exceptions**

   * "PinpointSMSVoice.Client.exceptions.NotFoundException"

   * "PinpointSMSVoice.Client.exceptions.TooManyRequestsException"

   * "PinpointSMSVoice.Client.exceptions.BadRequestException"

   * "PinpointSMSVoice.Client.exceptions.InternalServiceErrorExceptio
     n"
PinpointSMSVoice / Client / send_voice_message


send_voice_message
******************

PinpointSMSVoice.Client.send_voice_message(**kwargs)

   Create a new voice message and send it to a recipient's phone
   number.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.send_voice_message(
          CallerId='string',
          ConfigurationSetName='string',
          Content={
              'CallInstructionsMessage': {
                  'Text': 'string'
              },
              'PlainTextMessage': {
                  'LanguageCode': 'string',
                  'Text': 'string',
                  'VoiceId': 'string'
              },
              'SSMLMessage': {
                  'LanguageCode': 'string',
                  'Text': 'string',
                  'VoiceId': 'string'
              }
          },
          DestinationPhoneNumber='string',
          OriginationPhoneNumber='string'
      )

   Parameters:
      * **CallerId** (*string*) -- The phone number that appears on
        recipients' devices when they receive the message.

      * **ConfigurationSetName** (*string*) -- The name of the
        configuration set that you want to use to send the message.

      * **Content** (*dict*) --

        An object that contains a voice message and information about
        the recipient that you want to send it to.

        * **CallInstructionsMessage** *(dict) --* An object that
          defines a message that contains text formatted using Amazon
          Pinpoint Voice Instructions markup.

          * **Text** *(string) --* The language to use when delivering
            the message. For a complete list of supported languages,
            see the Amazon Polly Developer Guide.

        * **PlainTextMessage** *(dict) --* An object that defines a
          message that contains unformatted text.

          * **LanguageCode** *(string) --* The language to use when
            delivering the message. For a complete list of supported
            languages, see the Amazon Polly Developer Guide.

          * **Text** *(string) --* The plain (not SSML-formatted) text
            to deliver to the recipient.

          * **VoiceId** *(string) --* The name of the voice that you
            want to use to deliver the message. For a complete list of
            supported voices, see the Amazon Polly Developer Guide.

        * **SSMLMessage** *(dict) --* An object that defines a message
          that contains SSML-formatted text.

          * **LanguageCode** *(string) --* The language to use when
            delivering the message. For a complete list of supported
            languages, see the Amazon Polly Developer Guide.

          * **Text** *(string) --* The SSML-formatted text to deliver
            to the recipient.

          * **VoiceId** *(string) --* The name of the voice that you
            want to use to deliver the message. For a complete list of
            supported voices, see the Amazon Polly Developer Guide.

      * **DestinationPhoneNumber** (*string*) -- The phone number that
        you want to send the voice message to.

      * **OriginationPhoneNumber** (*string*) -- The phone number that
        Amazon Pinpoint should use to send the voice message. This
        isn't necessarily the phone number that appears on recipients'
        devices when they receive the message, because you can specify
        a CallerId parameter in the request.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'MessageId': 'string'
         }

      **Response Structure**

      * *(dict) --* SendVoiceMessageResponse

        * **MessageId** *(string) --* A unique identifier for the
          voice message.

   **Exceptions**

   * "PinpointSMSVoice.Client.exceptions.TooManyRequestsException"

   * "PinpointSMSVoice.Client.exceptions.BadRequestException"

   * "PinpointSMSVoice.Client.exceptions.InternalServiceErrorExceptio
     n"
PinpointSMSVoice / Client / get_waiter


get_waiter
**********

PinpointSMSVoice.Client.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"
PinpointSMSVoice / Client / create_configuration_set_event_destination


create_configuration_set_event_destination
******************************************

PinpointSMSVoice.Client.create_configuration_set_event_destination(**kwargs)

   Create a new event destination in a configuration set.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.create_configuration_set_event_destination(
          ConfigurationSetName='string',
          EventDestination={
              'CloudWatchLogsDestination': {
                  'IamRoleArn': 'string',
                  'LogGroupArn': 'string'
              },
              'Enabled': True|False,
              'KinesisFirehoseDestination': {
                  'DeliveryStreamArn': 'string',
                  'IamRoleArn': 'string'
              },
              'MatchingEventTypes': [
                  'INITIATED_CALL'|'RINGING'|'ANSWERED'|'COMPLETED_CALL'|'BUSY'|'FAILED'|'NO_ANSWER',
              ],
              'SnsDestination': {
                  'TopicArn': 'string'
              }
          },
          EventDestinationName='string'
      )

   Parameters:
      * **ConfigurationSetName** (*string*) -- **[REQUIRED]**
        ConfigurationSetName

      * **EventDestination** (*dict*) --

        An object that defines a single event destination.

        * **CloudWatchLogsDestination** *(dict) --* An object that
          contains information about an event destination that sends
          data 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.

        * **Enabled** *(boolean) --* Indicates whether or not the
          event destination is enabled. If the event destination is
          enabled, then Amazon Pinpoint sends response data to the
          specified event destination.

        * **KinesisFirehoseDestination** *(dict) --* An object that
          contains information about an event destination that sends
          data to Amazon Kinesis Data Firehose.

          * **DeliveryStreamArn** *(string) --* The Amazon Resource
            Name (ARN) of an IAM role that can write data to an Amazon
            Kinesis Data Firehose stream.

          * **IamRoleArn** *(string) --* The Amazon Resource Name
            (ARN) of the Amazon Kinesis Data Firehose destination that
            you want to use in the event destination.

        * **MatchingEventTypes** *(list) --* An array of
          EventDestination objects. Each EventDestination object
          includes ARNs and other information that define an event
          destination.

          * *(string) --* The types of events that are sent to the
            event destination.

        * **SnsDestination** *(dict) --* An object that contains
          information about an event destination that sends data to
          Amazon SNS.

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

      * **EventDestinationName** (*string*) -- A name that identifies
        the event destination.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {}

      **Response Structure**

      * *(dict) --* CreateConfigurationSetEventDestinationResponse

   **Exceptions**

   * "PinpointSMSVoice.Client.exceptions.BadRequestException"

   * "PinpointSMSVoice.Client.exceptions.LimitExceededException"

   * "PinpointSMSVoice.Client.exceptions.InternalServiceErrorExceptio
     n"

   * "PinpointSMSVoice.Client.exceptions.NotFoundException"

   * "PinpointSMSVoice.Client.exceptions.TooManyRequestsException"

   * "PinpointSMSVoice.Client.exceptions.AlreadyExistsException"
PinpointSMSVoice / Client / close


close
*****

PinpointSMSVoice.Client.close()

   Closes underlying endpoint connections.
PinpointSMSVoice / Client / get_configuration_set_event_destinations


get_configuration_set_event_destinations
****************************************

PinpointSMSVoice.Client.get_configuration_set_event_destinations(**kwargs)

   Obtain information about an event destination, including the types
   of events it reports, the Amazon Resource Name (ARN) of the
   destination, and the name of the event destination.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_configuration_set_event_destinations(
          ConfigurationSetName='string'
      )

   Parameters:
      **ConfigurationSetName** (*string*) -- **[REQUIRED]**
      ConfigurationSetName

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'EventDestinations': [
                 {
                     'CloudWatchLogsDestination': {
                         'IamRoleArn': 'string',
                         'LogGroupArn': 'string'
                     },
                     'Enabled': True|False,
                     'KinesisFirehoseDestination': {
                         'DeliveryStreamArn': 'string',
                         'IamRoleArn': 'string'
                     },
                     'MatchingEventTypes': [
                         'INITIATED_CALL'|'RINGING'|'ANSWERED'|'COMPLETED_CALL'|'BUSY'|'FAILED'|'NO_ANSWER',
                     ],
                     'Name': 'string',
                     'SnsDestination': {
                         'TopicArn': 'string'
                     }
                 },
             ]
         }

      **Response Structure**

      * *(dict) --* GetConfigurationSetEventDestinationsResponse

        * **EventDestinations** *(list) --* An array of
          EventDestination objects. Each EventDestination object
          includes ARNs and other information that define an event
          destination.

          * *(dict) --* An object that defines an event destination.

            * **CloudWatchLogsDestination** *(dict) --* An object that
              contains information about an event destination that
              sends data 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.

            * **Enabled** *(boolean) --* Indicates whether or not the
              event destination is enabled. If the event destination
              is enabled, then Amazon Pinpoint sends response data to
              the specified event destination.

            * **KinesisFirehoseDestination** *(dict) --* An object
              that contains information about an event destination
              that sends data to Amazon Kinesis Data Firehose.

              * **DeliveryStreamArn** *(string) --* The Amazon
                Resource Name (ARN) of an IAM role that can write data
                to an Amazon Kinesis Data Firehose stream.

              * **IamRoleArn** *(string) --* The Amazon Resource Name
                (ARN) of the Amazon Kinesis Data Firehose destination
                that you want to use in the event destination.

            * **MatchingEventTypes** *(list) --* An array of
              EventDestination objects. Each EventDestination object
              includes ARNs and other information that define an event
              destination.

              * *(string) --* The types of events that are sent to the
                event destination.

            * **Name** *(string) --* A name that identifies the event
              destination configuration.

            * **SnsDestination** *(dict) --* An object that contains
              information about an event destination that sends data
              to Amazon SNS.

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

   **Exceptions**

   * "PinpointSMSVoice.Client.exceptions.NotFoundException"

   * "PinpointSMSVoice.Client.exceptions.TooManyRequestsException"

   * "PinpointSMSVoice.Client.exceptions.BadRequestException"

   * "PinpointSMSVoice.Client.exceptions.InternalServiceErrorExceptio
     n"
PinpointSMSVoice / Client / create_configuration_set


create_configuration_set
************************

PinpointSMSVoice.Client.create_configuration_set(**kwargs)

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

   See also: AWS API Documentation

   **Request Syntax**

      response = client.create_configuration_set(
          ConfigurationSetName='string'
      )

   Parameters:
      **ConfigurationSetName** (*string*) -- The name that you want to
      give the configuration set.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {}

      **Response Structure**

      * *(dict) --* CreateConfigurationSetResponse

   **Exceptions**

   * "PinpointSMSVoice.Client.exceptions.TooManyRequestsException"

   * "PinpointSMSVoice.Client.exceptions.BadRequestException"

   * "PinpointSMSVoice.Client.exceptions.LimitExceededException"

   * "PinpointSMSVoice.Client.exceptions.InternalServiceErrorExceptio
     n"

   * "PinpointSMSVoice.Client.exceptions.AlreadyExistsException"
PinpointSMSVoice / Client / update_configuration_set_event_destination


update_configuration_set_event_destination
******************************************

PinpointSMSVoice.Client.update_configuration_set_event_destination(**kwargs)

   Update an event destination in a configuration set. An event
   destination is a location that you publish information about your
   voice calls to. For example, you can log an event to an Amazon
   CloudWatch destination when a call fails.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.update_configuration_set_event_destination(
          ConfigurationSetName='string',
          EventDestination={
              'CloudWatchLogsDestination': {
                  'IamRoleArn': 'string',
                  'LogGroupArn': 'string'
              },
              'Enabled': True|False,
              'KinesisFirehoseDestination': {
                  'DeliveryStreamArn': 'string',
                  'IamRoleArn': 'string'
              },
              'MatchingEventTypes': [
                  'INITIATED_CALL'|'RINGING'|'ANSWERED'|'COMPLETED_CALL'|'BUSY'|'FAILED'|'NO_ANSWER',
              ],
              'SnsDestination': {
                  'TopicArn': 'string'
              }
          },
          EventDestinationName='string'
      )

   Parameters:
      * **ConfigurationSetName** (*string*) -- **[REQUIRED]**
        ConfigurationSetName

      * **EventDestination** (*dict*) --

        An object that defines a single event destination.

        * **CloudWatchLogsDestination** *(dict) --* An object that
          contains information about an event destination that sends
          data 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.

        * **Enabled** *(boolean) --* Indicates whether or not the
          event destination is enabled. If the event destination is
          enabled, then Amazon Pinpoint sends response data to the
          specified event destination.

        * **KinesisFirehoseDestination** *(dict) --* An object that
          contains information about an event destination that sends
          data to Amazon Kinesis Data Firehose.

          * **DeliveryStreamArn** *(string) --* The Amazon Resource
            Name (ARN) of an IAM role that can write data to an Amazon
            Kinesis Data Firehose stream.

          * **IamRoleArn** *(string) --* The Amazon Resource Name
            (ARN) of the Amazon Kinesis Data Firehose destination that
            you want to use in the event destination.

        * **MatchingEventTypes** *(list) --* An array of
          EventDestination objects. Each EventDestination object
          includes ARNs and other information that define an event
          destination.

          * *(string) --* The types of events that are sent to the
            event destination.

        * **SnsDestination** *(dict) --* An object that contains
          information about an event destination that sends data to
          Amazon SNS.

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

      * **EventDestinationName** (*string*) -- **[REQUIRED]**
        EventDestinationName

   Return type:
      dict

   Returns:
      **Response Syntax**

         {}

      **Response Structure**

      * *(dict) --* UpdateConfigurationSetEventDestinationResponse

   **Exceptions**

   * "PinpointSMSVoice.Client.exceptions.NotFoundException"

   * "PinpointSMSVoice.Client.exceptions.TooManyRequestsException"

   * "PinpointSMSVoice.Client.exceptions.BadRequestException"

   * "PinpointSMSVoice.Client.exceptions.InternalServiceErrorExceptio
     n"