Chime / Client / get_voice_connector

get_voice_connector#

Chime.Client.get_voice_connector(**kwargs)#

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

Request Syntax

response = client.get_voice_connector(
    VoiceConnectorId='string'
)

Parameters:

VoiceConnectorId (string) –

[REQUIRED]

The Amazon Chime Voice Connector ID.

Return type:

dict

Returns:

Response Syntax

{
    'VoiceConnector': {
        'VoiceConnectorId': 'string',
        'AwsRegion': 'us-east-1'|'us-west-2',
        'Name': 'string',
        'OutboundHostName': 'string',
        'RequireEncryption': True|False,
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'VoiceConnectorArn': 'string'
    }
}

Response Structure

(dict) –
- VoiceConnector (dict) –
  
  The Amazon Chime Voice Connector details.
  - VoiceConnectorId (string) –
    
    The Amazon Chime Voice Connector ID.
  - AwsRegion (string) –
    
    The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1.
  - Name (string) –
    
    The name of the Amazon Chime Voice Connector.
  - OutboundHostName (string) –
    
    The outbound host name for the Amazon Chime Voice Connector.
  - RequireEncryption (boolean) –
    
    Designates whether encryption is required for the Amazon Chime Voice Connector.
  - CreatedTimestamp (datetime) –
    
    The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.
  - UpdatedTimestamp (datetime) –
    
    The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.
  - VoiceConnectorArn (string) –
    
    The ARN of the specified Amazon Chime Voice Connector.

Exceptions

Chime.Client.exceptions.UnauthorizedClientException
Chime.Client.exceptions.NotFoundException
Chime.Client.exceptions.ForbiddenException
Chime.Client.exceptions.BadRequestException
Chime.Client.exceptions.ThrottledClientException
Chime.Client.exceptions.ServiceUnavailableException
Chime.Client.exceptions.ServiceFailureException