:doc:`Pinpoint <../../pinpoint>` / Client / update_sms_channel

******************
update_sms_channel
******************



.. py:method:: Pinpoint.Client.update_sms_channel(**kwargs)

  

  Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateSmsChannel>`_  


  **Request Syntax**
  ::

    response = client.update_sms_channel(
        ApplicationId='string',
        SMSChannelRequest={
            'Enabled': True|False,
            'SenderId': 'string',
            'ShortCode': 'string'
        }
    )
    
  :type ApplicationId: string
  :param ApplicationId: **[REQUIRED]** 

    The unique identifier for the application. This identifier is displayed as the **Project ID** on the Amazon Pinpoint console.

    

  
  :type SMSChannelRequest: dict
  :param SMSChannelRequest: **[REQUIRED]** 

    Specifies the status and settings of the SMS channel for an application.

    

  
    - **Enabled** *(boolean) --* 

      Specifies whether to enable the SMS channel for the application.

      

    
    - **SenderId** *(string) --* 

      The identity that you want to display on recipients' devices when they receive messages from the SMS channel.

      

    
    - **ShortCode** *(string) --* 

      The registered short code that you want to use when you send messages through the SMS channel.

      

    
  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'SMSChannelResponse': {
              'ApplicationId': 'string',
              'CreationDate': 'string',
              'Enabled': True|False,
              'HasCredential': True|False,
              'Id': 'string',
              'IsArchived': True|False,
              'LastModifiedBy': 'string',
              'LastModifiedDate': 'string',
              'Platform': 'string',
              'PromotionalMessagesPerSecond': 123,
              'SenderId': 'string',
              'ShortCode': 'string',
              'TransactionalMessagesPerSecond': 123,
              'Version': 123
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      The request succeeded.

      
      

      - **SMSChannelResponse** *(dict) --* 

        Provides information about the status and settings of the SMS channel for an application.

        
        

        - **ApplicationId** *(string) --* 

          The unique identifier for the application that the SMS channel applies to.

          
        

        - **CreationDate** *(string) --* 

          The date and time, in ISO 8601 format, when the SMS channel was enabled.

          
        

        - **Enabled** *(boolean) --* 

          Specifies whether the SMS channel is enabled for the application.

          
        

        - **HasCredential** *(boolean) --* 

          (Not used) This property is retained only for backward compatibility.

          
        

        - **Id** *(string) --* 

          (Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.

          
        

        - **IsArchived** *(boolean) --* 

          Specifies whether the SMS channel is archived.

          
        

        - **LastModifiedBy** *(string) --* 

          The user who last modified the SMS channel.

          
        

        - **LastModifiedDate** *(string) --* 

          The date and time, in ISO 8601 format, when the SMS channel was last modified.

          
        

        - **Platform** *(string) --* 

          The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.

          
        

        - **PromotionalMessagesPerSecond** *(integer) --* 

          The maximum number of promotional messages that you can send through the SMS channel each second.

          
        

        - **SenderId** *(string) --* 

          The identity that displays on recipients' devices when they receive messages from the SMS channel.

          
        

        - **ShortCode** *(string) --* 

          The registered short code to use when you send messages through the SMS channel.

          
        

        - **TransactionalMessagesPerSecond** *(integer) --* 

          The maximum number of transactional messages that you can send through the SMS channel each second.

          
        

        - **Version** *(integer) --* 

          The current version of the SMS channel.

          
    
  
  **Exceptions**
  
  *   :py:class:`Pinpoint.Client.exceptions.BadRequestException`

  
  *   :py:class:`Pinpoint.Client.exceptions.InternalServerErrorException`

  
  *   :py:class:`Pinpoint.Client.exceptions.PayloadTooLargeException`

  
  *   :py:class:`Pinpoint.Client.exceptions.ForbiddenException`

  
  *   :py:class:`Pinpoint.Client.exceptions.NotFoundException`

  
  *   :py:class:`Pinpoint.Client.exceptions.MethodNotAllowedException`

  
  *   :py:class:`Pinpoint.Client.exceptions.TooManyRequestsException`

  