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

*******************
get_voice_connector
*******************



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

  

  Retrieves details for the specified Amazon Chime SDK Voice Connector, such as timestamps,name, outbound host, and encryption requirements.

  

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


  **Request Syntax**
  ::

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

    The Voice Connector ID.

    

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

    
    ::

      {
          'VoiceConnector': {
              'VoiceConnectorId': 'string',
              'AwsRegion': 'us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2',
              'Name': 'string',
              'OutboundHostName': 'string',
              'RequireEncryption': True|False,
              'CreatedTimestamp': datetime(2015, 1, 1),
              'UpdatedTimestamp': datetime(2015, 1, 1),
              'VoiceConnectorArn': 'string',
              'IntegrationType': 'CONNECT_CALL_TRANSFER_CONNECTOR'|'CONNECT_ANALYTICS_CONNECTOR',
              'NetworkType': 'IPV4_ONLY'|'DUAL_STACK'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **VoiceConnector** *(dict) --* 

        The Voice Connector details.

        
        

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

          The Voice Connector's ID.

          
        

        - **AwsRegion** *(string) --* 

          The AWS Region in which the Voice Connector is created. Default: us-east-1.

          
        

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

          The Voice Connector's name.

          
        

        - **OutboundHostName** *(string) --* 

          The outbound host name for the Voice Connector.

          
        

        - **RequireEncryption** *(boolean) --* 

          Enables or disables encryption for the Voice Connector.

          
        

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

          The Voice Connector's creation timestamp, in ISO 8601 format.

          
        

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

          The Voice Connector's updated timestamp, in ISO 8601 format.

          
        

        - **VoiceConnectorArn** *(string) --* 

          The ARN of the Voice Connector.

          
        

        - **IntegrationType** *(string) --* 

          The connectors for use with Amazon Connect.

          
        

        - **NetworkType** *(string) --* 

          The type of network of the Voice Connector. Either IPv4 only or dual-stack (IPv4 and IPv6).

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

  