:doc:`PinpointSMSVoiceV2 <../../pinpoint-sms-voice-v2>` / Client / request_sender_id

*****************
request_sender_id
*****************



.. py:method:: PinpointSMSVoiceV2.Client.request_sender_id(**kwargs)

  

  Request a new sender ID that doesn't require registration.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RequestSenderId>`_  


  **Request Syntax**
  ::

    response = client.request_sender_id(
        SenderId='string',
        IsoCountryCode='string',
        MessageTypes=[
            'TRANSACTIONAL'|'PROMOTIONAL',
        ],
        DeletionProtectionEnabled=True|False,
        Tags=[
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        ClientToken='string'
    )
    
  :type SenderId: string
  :param SenderId: **[REQUIRED]** 

    The sender ID string to request.

    

  
  :type IsoCountryCode: string
  :param IsoCountryCode: **[REQUIRED]** 

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

    

  
  :type MessageTypes: list
  :param MessageTypes: 

    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) --* 

    

  :type DeletionProtectionEnabled: boolean
  :param DeletionProtectionEnabled: 

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

    

  
  :type Tags: list
  :param Tags: 

    An array of tags (key and value pairs) to associate with the sender ID.

    

  
    - *(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.

        

      
    

  :type ClientToken: string
  :param ClientToken: 

    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.

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

    
    ::

      {
          'SenderIdArn': 'string',
          'SenderId': 'string',
          'IsoCountryCode': 'string',
          'MessageTypes': [
              'TRANSACTIONAL'|'PROMOTIONAL',
          ],
          'MonthlyLeasingPrice': 'string',
          'DeletionProtectionEnabled': True|False,
          'Registered': True|False,
          'Tags': [
              {
                  'Key': 'string',
                  'Value': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **SenderIdArn** *(string) --* 

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

        
      

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

        The sender ID that was requested.

        
      

      - **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 price, in US dollars, to lease the sender ID.

        
      

      - **DeletionProtectionEnabled** *(boolean) --* 

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

        
      

      - **Registered** *(boolean) --* 

        True if the sender ID is registered.

        
      

      - **Tags** *(list) --* 

        An array of tags (key and value pairs) to associate with the sender ID.

        
        

        - *(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**
  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.ThrottlingException`

  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.ValidationException`

  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.ConflictException`

  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.InternalServerException`

  