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

*************************
get_voice_connector_group
*************************



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

  

  Retrieves details for the specified Amazon Chime SDK Voice Connector group, such as timestamps,name, and associated ``VoiceConnectorItems``.

  

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


  **Request Syntax**
  ::

    response = client.get_voice_connector_group(
        VoiceConnectorGroupId='string'
    )
    
  :type VoiceConnectorGroupId: string
  :param VoiceConnectorGroupId: **[REQUIRED]** 

    The Voice Connector group ID.

    

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

    
    ::

      {
          'VoiceConnectorGroup': {
              'VoiceConnectorGroupId': 'string',
              'Name': 'string',
              'VoiceConnectorItems': [
                  {
                      'VoiceConnectorId': 'string',
                      'Priority': 123
                  },
              ],
              'CreatedTimestamp': datetime(2015, 1, 1),
              'UpdatedTimestamp': datetime(2015, 1, 1),
              'VoiceConnectorGroupArn': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **VoiceConnectorGroup** *(dict) --* 

        The details of the Voice Connector group.

        
        

        - **VoiceConnectorGroupId** *(string) --* 

          The ID of a Voice Connector group.

          
        

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

          The name of a Voice Connector group.

          
        

        - **VoiceConnectorItems** *(list) --* 

          The Voice Connectors to which you route inbound calls.

          
          

          - *(dict) --* 

            For Amazon Chime SDK Voice Connector groups, the Amazon Chime SDK Voice Connectors to which you route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Voice Connector group.

            
            

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

              The Voice Connector ID.

              
            

            - **Priority** *(integer) --* 

              The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight.

              
        
      
        

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

          The Voice Connector group's creation time stamp, in ISO 8601 format.

          
        

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

          The Voice Connector group's creation time stamp, in ISO 8601 format.

          
        

        - **VoiceConnectorGroupArn** *(string) --* 

          The ARN of the Voice Connector group.

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

  