ChimeSDKVoice / Client / create_voice_connector
create_voice_connector#
- ChimeSDKVoice.Client.create_voice_connector(**kwargs)#
Creates an Amazon Chime SDK Voice Connector. For more information about Voice Connectors, see Managing Amazon Chime SDK Voice Connector groups in the Amazon Chime SDK Administrator Guide.
See also: AWS API Documentation
Request Syntax
response = client.create_voice_connector( Name='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', RequireEncryption=True|False, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] )
- Parameters:
Name (string) –
[REQUIRED]
The name of the Voice Connector.
AwsRegion (string) – The AWS Region in which the Amazon Chime SDK Voice Connector is created. Default value:
us-east-1
.RequireEncryption (boolean) –
[REQUIRED]
Enables or disables encryption for the Voice Connector.
Tags (list) –
The tags assigned to the Voice Connector.
(dict) –
Describes a tag applied to a resource.
Key (string) – [REQUIRED]
The tag’s key.
Value (string) – [REQUIRED]
The tag’s value.
- Return type:
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' } }
Response Structure
(dict) –
VoiceConnector (dict) –
The details of the Voice Connector.
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.
Exceptions
ChimeSDKVoice.Client.exceptions.BadRequestException
ChimeSDKVoice.Client.exceptions.ForbiddenException
ChimeSDKVoice.Client.exceptions.AccessDeniedException
ChimeSDKVoice.Client.exceptions.UnauthorizedClientException
ChimeSDKVoice.Client.exceptions.ThrottledClientException
ChimeSDKVoice.Client.exceptions.ResourceLimitExceededException
ChimeSDKVoice.Client.exceptions.ServiceUnavailableException
ChimeSDKVoice.Client.exceptions.ServiceFailureException