voice_connectors

Creates, updates, deletes, gets or lists a voice_connectors resource.

Overview

Name	voice_connectors
Type	Resource
Id	aws.chime_sdk_voice.voice_connectors

Fields

The following fields are returned by SELECT queries:

get_voice_connector

Name	Datatype	Description
aws_region	string	The AWS Region in which the Voice Connector is created. Default: us-east-1. (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)
created_timestamp	string (date-time)	The Voice Connector's creation timestamp, in ISO 8601 format.
integration_type	string	The connectors for use with Connect Customer. (CONNECT_CALL_TRANSFER_CONNECTOR, CONNECT_ANALYTICS_CONNECTOR)
name	string	The Voice Connector's name. (pattern: <code>[a-zA-Z0-9 _.-]+</code>)
network_type	string	The type of network for the Voice Connector. (IPV4_ONLY, DUAL_STACK)
outbound_host_name	string	The outbound host name for the Voice Connector.
require_encryption	boolean	Enables or disables encryption for the Voice Connector.
updated_timestamp	string (date-time)	The Voice Connector's updated timestamp, in ISO 8601 format.
voice_connector_arn	string	The ARN of the Voice Connector. (pattern: <code>.\S.</code>)
voice_connector_id	string	The Voice Connector's ID. (pattern: <code>([a-z0-9]{21,22}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})</code>)

list_voice_connectors

Name	Datatype	Description
next_token	string	The token used to return the next page of results.
voice_connectors	array	The details of the Voice Connectors.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_voice_connector	select	voice_connector_id, region		Retrieves details for the specified Amazon Chime SDK Voice Connector, such as timestamps,name, outbound host, and encryption requirements.
list_voice_connectors	select	region	next-token, max-results	Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.
create_voice_connector	insert	region, Name, RequireEncryption		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.
update_voice_connector	update	voice_connector_id, region, Name, RequireEncryption		Updates the details for the specified Amazon Chime SDK Voice Connector.
associate_phone_numbers_with_voice_connector	update	voice_connector_id, region, E164PhoneNumbers		Associates phone numbers with the specified Amazon Chime SDK Voice Connector.
delete_voice_connector	delete	voice_connector_id, region		Deletes an Amazon Chime SDK Voice Connector. Any phone numbers associated with the Amazon Chime SDK Voice Connector must be disassociated from it before it can be deleted.
disassociate_phone_numbers_from_voice_connector	exec	voice_connector_id, region, E164PhoneNumbers		Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector.
start_speaker_search_task	exec	voice_connector_id, region, TransactionId, VoiceProfileDomainId		Starts a speaker search task. Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.
start_voice_tone_analysis_task	exec	voice_connector_id, region, TransactionId, LanguageCode		Starts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime SDK voice analytics in the Amazon Chime SDK Developer Guide. Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.
stop_speaker_search_task	exec	voice_connector_id, speaker_search_task_id, region		Stops a speaker search task.
stop_voice_tone_analysis_task	exec	voice_connector_id, voice_tone_analysis_task_id, region		Stops a voice tone analysis task.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
speaker_search_task_id	string	The speaker search task ID.
voice_connector_id	string	The Voice Connector ID.
voice_tone_analysis_task_id	string	The ID of the voice tone analysis task.
max-results	integer	The maximum number of results to return in a single call.
next-token	string	The token used to return the next page of results.

SELECT examples

get_voice_connector

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

SELECT
aws_region,
created_timestamp,
integration_type,
name,
network_type,
outbound_host_name,
require_encryption,
updated_timestamp,
voice_connector_arn,
voice_connector_id
FROM aws.chime_sdk_voice.voice_connectors
WHERE voice_connector_id = '{{ voice_connector_id }}' -- required
AND region = '{{ region }}' -- required
;

list_voice_connectors

Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.

SELECT
next_token,
voice_connectors
FROM aws.chime_sdk_voice.voice_connectors
WHERE region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

INSERT examples

create_voice_connector

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.

INSERT INTO aws.chime_sdk_voice.voice_connectors (
Name,
AwsRegion,
RequireEncryption,
Tags,
IntegrationType,
NetworkType,
region
)
SELECT 
'{{ Name }}' /* required */,
'{{ AwsRegion }}',
{{ RequireEncryption }} /* required */,
'{{ Tags }}',
'{{ IntegrationType }}',
'{{ NetworkType }}',
'{{ region }}'
RETURNING
voice_connector
;

Manifest

# Description fields are for documentation purposes
- name: voice_connectors
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the voice_connectors resource.
  - name: Name
    value: "{{ Name }}"
  - name: AwsRegion
    value: "{{ AwsRegion }}"
    valid_values: ['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: RequireEncryption
    value: {{ RequireEncryption }}
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: IntegrationType
    value: "{{ IntegrationType }}"
    valid_values: ['CONNECT_CALL_TRANSFER_CONNECTOR', 'CONNECT_ANALYTICS_CONNECTOR']
  - name: NetworkType
    value: "{{ NetworkType }}"
    valid_values: ['IPV4_ONLY', 'DUAL_STACK']

UPDATE examples

update_voice_connector

Updates the details for the specified Amazon Chime SDK Voice Connector.

UPDATE aws.chime_sdk_voice.voice_connectors
SET 
Name = '{{ Name }}',
RequireEncryption = {{ RequireEncryption }}
WHERE 
voice_connector_id = '{{ voice_connector_id }}' --required
AND region = '{{ region }}' --required
AND Name = '{{ Name }}' --required
AND RequireEncryption = {{ RequireEncryption }} --required
RETURNING
voice_connector;

associate_phone_numbers_with_voice_connector

Associates phone numbers with the specified Amazon Chime SDK Voice Connector.

UPDATE aws.chime_sdk_voice.voice_connectors
SET 
E164PhoneNumbers = '{{ E164PhoneNumbers }}',
ForceAssociate = {{ ForceAssociate }}
WHERE 
voice_connector_id = '{{ voice_connector_id }}' --required
AND region = '{{ region }}' --required
AND E164PhoneNumbers = '{{ E164PhoneNumbers }}' --required
RETURNING
phone_number_errors;

DELETE examples

delete_voice_connector

Deletes an Amazon Chime SDK Voice Connector. Any phone numbers associated with the Amazon Chime SDK Voice Connector must be disassociated from it before it can be deleted.

DELETE FROM aws.chime_sdk_voice.voice_connectors
WHERE voice_connector_id = '{{ voice_connector_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

disassociate_phone_numbers_from_voice_connector

Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector.

EXEC aws.chime_sdk_voice.voice_connectors.disassociate_phone_numbers_from_voice_connector 
@voice_connector_id='{{ voice_connector_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"E164PhoneNumbers": "{{ E164PhoneNumbers }}"
}'
;

start_speaker_search_task

Starts a speaker search task. Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

EXEC aws.chime_sdk_voice.voice_connectors.start_speaker_search_task 
@voice_connector_id='{{ voice_connector_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"TransactionId": "{{ TransactionId }}", 
"VoiceProfileDomainId": "{{ VoiceProfileDomainId }}", 
"ClientRequestToken": "{{ ClientRequestToken }}", 
"CallLeg": "{{ CallLeg }}"
}'
;

start_voice_tone_analysis_task

Starts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime SDK voice analytics in the Amazon Chime SDK Developer Guide. Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

EXEC aws.chime_sdk_voice.voice_connectors.start_voice_tone_analysis_task 
@voice_connector_id='{{ voice_connector_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"TransactionId": "{{ TransactionId }}", 
"LanguageCode": "{{ LanguageCode }}", 
"ClientRequestToken": "{{ ClientRequestToken }}"
}'
;

stop_speaker_search_task

Stops a speaker search task.

EXEC aws.chime_sdk_voice.voice_connectors.stop_speaker_search_task 
@voice_connector_id='{{ voice_connector_id }}' --required, 
@speaker_search_task_id='{{ speaker_search_task_id }}' --required, 
@region='{{ region }}' --required
;

stop_voice_tone_analysis_task

Stops a voice tone analysis task.

EXEC aws.chime_sdk_voice.voice_connectors.stop_voice_tone_analysis_task 
@voice_connector_id='{{ voice_connector_id }}' --required, 
@voice_tone_analysis_task_id='{{ voice_tone_analysis_task_id }}' --required, 
@region='{{ region }}' --required
;