voice_connector_groups

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

Overview

Name	voice_connector_groups
Type	Resource
Id	aws.chime_sdk_voice.voice_connector_groups

Fields

The following fields are returned by SELECT queries:

get_voice_connector_group

Name	Datatype	Description
call_distribution_type	string	(PriorityWeightedDistribution, LoadBalancedDistribution)
created_timestamp	string (date-time)	The Voice Connector group's creation time stamp, in ISO 8601 format.
name	string	The name of a Voice Connector group. (pattern: <code>[a-zA-Z0-9 _.-]+</code>)
updated_timestamp	string (date-time)	The Voice Connector group's creation time stamp, in ISO 8601 format.
voice_connector_group_arn	string	The ARN of the Voice Connector group. (pattern: <code>.\S.</code>)
voice_connector_group_id	string	The ID of a Voice Connector group. (pattern: <code>.\S.</code>)
voice_connector_items	array	The Voice Connectors to which you route inbound calls.

list_voice_connector_groups

Name	Datatype	Description
next_token	string	The token used to return the next page of results.
voice_connector_groups	array	The details of the Voice Connector groups.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_voice_connector_group	select	voice_connector_group_id, region		Retrieves details for the specified Amazon Chime SDK Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems.
list_voice_connector_groups	select	region	next-token, max-results	Lists the Amazon Chime SDK Voice Connector groups in the administrator's AWS account.
create_voice_connector_group	insert	region, Name		Creates an Amazon Chime SDK Voice Connector group under the administrator's AWS account. You can associate Amazon Chime SDK Voice Connectors with the Voice Connector group by including VoiceConnectorItems in the request. You can include Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.
update_voice_connector_group	update	voice_connector_group_id, region, Name, VoiceConnectorItems		Updates the settings for the specified Amazon Chime SDK Voice Connector group.
associate_phone_numbers_with_voice_connector_group	update	voice_connector_group_id, region, E164PhoneNumbers		Associates phone numbers with the specified Amazon Chime SDK Voice Connector group.
delete_voice_connector_group	delete	voice_connector_group_id, region		Deletes an Amazon Chime SDK Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.
disassociate_phone_numbers_from_voice_connector_group	exec	voice_connector_group_id, region, E164PhoneNumbers		Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector group.

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)
voice_connector_group_id	string	The Voice Connector group ID.
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_group

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

SELECT
call_distribution_type,
created_timestamp,
name,
updated_timestamp,
voice_connector_group_arn,
voice_connector_group_id,
voice_connector_items
FROM aws.chime_sdk_voice.voice_connector_groups
WHERE voice_connector_group_id = '{{ voice_connector_group_id }}' -- required
AND region = '{{ region }}' -- required
;

list_voice_connector_groups

Lists the Amazon Chime SDK Voice Connector groups in the administrator's AWS account.

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

INSERT examples

create_voice_connector_group

Creates an Amazon Chime SDK Voice Connector group under the administrator's AWS account. You can associate Amazon Chime SDK Voice Connectors with the Voice Connector group by including VoiceConnectorItems in the request. You can include Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

INSERT INTO aws.chime_sdk_voice.voice_connector_groups (
Name,
VoiceConnectorItems,
CallDistributionType,
region
)
SELECT 
'{{ Name }}' /* required */,
'{{ VoiceConnectorItems }}',
'{{ CallDistributionType }}',
'{{ region }}'
RETURNING
voice_connector_group
;

Manifest

# Description fields are for documentation purposes
- name: voice_connector_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the voice_connector_groups resource.
  - name: Name
    value: "{{ Name }}"
  - name: VoiceConnectorItems
    value:
      - VoiceConnectorId: "{{ VoiceConnectorId }}"
        Priority: {{ Priority }}
  - name: CallDistributionType
    value: "{{ CallDistributionType }}"
    valid_values: ['PriorityWeightedDistribution', 'LoadBalancedDistribution']

UPDATE examples

update_voice_connector_group

Updates the settings for the specified Amazon Chime SDK Voice Connector group.

UPDATE aws.chime_sdk_voice.voice_connector_groups
SET 
Name = '{{ Name }}',
VoiceConnectorItems = '{{ VoiceConnectorItems }}',
CallDistributionType = '{{ CallDistributionType }}'
WHERE 
voice_connector_group_id = '{{ voice_connector_group_id }}' --required
AND region = '{{ region }}' --required
AND Name = '{{ Name }}' --required
AND VoiceConnectorItems = '{{ VoiceConnectorItems }}' --required
RETURNING
voice_connector_group;

associate_phone_numbers_with_voice_connector_group

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

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

DELETE examples

delete_voice_connector_group

Deletes an Amazon Chime SDK Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.

DELETE FROM aws.chime_sdk_voice.voice_connector_groups
WHERE voice_connector_group_id = '{{ voice_connector_group_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

disassociate_phone_numbers_from_voice_connector_group

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

EXEC aws.chime_sdk_voice.voice_connector_groups.disassociate_phone_numbers_from_voice_connector_group 
@voice_connector_group_id='{{ voice_connector_group_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"E164PhoneNumbers": "{{ E164PhoneNumbers }}"
}'
;