:doc:`ChimeSDKVoice <../../chime-sdk-voice>` / Client / get_proxy_session

*****************
get_proxy_session
*****************



.. py:method:: ChimeSDKVoice.Client.get_proxy_session(**kwargs)

  

  Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetProxySession>`_  


  **Request Syntax**
  ::

    response = client.get_proxy_session(
        VoiceConnectorId='string',
        ProxySessionId='string'
    )
    
  :type VoiceConnectorId: string
  :param VoiceConnectorId: **[REQUIRED]** 

    The Voice Connector ID.

    

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

    The proxy session ID.

    

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

    
    ::

      {
          'ProxySession': {
              'VoiceConnectorId': 'string',
              'ProxySessionId': 'string',
              'Name': 'string',
              'Status': 'Open'|'InProgress'|'Closed',
              'ExpiryMinutes': 123,
              'Capabilities': [
                  'Voice'|'SMS',
              ],
              'CreatedTimestamp': datetime(2015, 1, 1),
              'UpdatedTimestamp': datetime(2015, 1, 1),
              'EndedTimestamp': datetime(2015, 1, 1),
              'Participants': [
                  {
                      'PhoneNumber': 'string',
                      'ProxyPhoneNumber': 'string'
                  },
              ],
              'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky',
              'GeoMatchLevel': 'Country'|'AreaCode',
              'GeoMatchParams': {
                  'Country': 'string',
                  'AreaCode': 'string'
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ProxySession** *(dict) --* 

        The proxy session details.

        
        

        - **VoiceConnectorId** *(string) --* 

          The Voice Connector ID.

          
        

        - **ProxySessionId** *(string) --* 

          The proxy session ID.

          
        

        - **Name** *(string) --* 

          The proxy session name.

          
        

        - **Status** *(string) --* 

          The proxy session status.

          
        

        - **ExpiryMinutes** *(integer) --* 

          The number of minutes allowed for the proxy session.

          
        

        - **Capabilities** *(list) --* 

          The proxy session capabilities.

          
          

          - *(string) --* 
      
        

        - **CreatedTimestamp** *(datetime) --* 

          The created time stamp, in ISO 8601 format.

          
        

        - **UpdatedTimestamp** *(datetime) --* 

          The updated time stamp, in ISO 8601 format.

          
        

        - **EndedTimestamp** *(datetime) --* 

          The ended time stamp, in ISO 8601 format.

          
        

        - **Participants** *(list) --* 

          The proxy session participants.

          
          

          - *(dict) --* 

            The phone number and proxy phone number for a participant in an Amazon Chime SDK Voice Connector proxy session.

            
            

            - **PhoneNumber** *(string) --* 

              The participant's phone number.

              
            

            - **ProxyPhoneNumber** *(string) --* 

              The participant's proxy phone number.

              
        
      
        

        - **NumberSelectionBehavior** *(string) --* 

          The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

          
        

        - **GeoMatchLevel** *(string) --* 

          The preference for matching the country or area code of the proxy phone number with that of the first participant.

          
        

        - **GeoMatchParams** *(dict) --* 

          The country and area code for the proxy phone number.

          
          

          - **Country** *(string) --* 

            The country.

            
          

          - **AreaCode** *(string) --* 

            The area code.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.UnauthorizedClientException`

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

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

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.BadRequestException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ThrottledClientException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ServiceFailureException`

  