instance_attributes

Creates, updates, deletes, gets or lists an instance_attributes resource.

Overview

Name	instance_attributes
Type	Resource
Id	aws.connect.instance_attributes

Fields

The following fields are returned by SELECT queries:

describe_instance_attribute

Name	Datatype	Description
attribute_type	string	The type of attribute. (INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA, MULTI_PARTY_CONFERENCE, HIGH_VOLUME_OUTBOUND, ENHANCED_CONTACT_MONITORING, ENHANCED_CHAT_MONITORING, MULTI_PARTY_CHAT_CONFERENCE, MESSAGE_STREAMING)
value	string	The value of the attribute.

list_instance_attributes

Name	Datatype	Description
attribute_type	string	The type of attribute. (INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA, MULTI_PARTY_CONFERENCE, HIGH_VOLUME_OUTBOUND, ENHANCED_CONTACT_MONITORING, ENHANCED_CHAT_MONITORING, MULTI_PARTY_CHAT_CONFERENCE, MESSAGE_STREAMING)
value	string	The value of the attribute.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_instance_attribute	select	instance_id, attribute_type, region		This API is in preview release for Connect Customer and is subject to change. Describes the specified instance attribute.
list_instance_attributes	select	instance_id, region	nextToken, maxResults	This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of all attribute types for the given instance.
update_instance_attribute	update	instance_id, attribute_type, region		This API is in preview release for Connect Customer and is subject to change. Updates the value for the specified attribute type.

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
attribute_type	string	The type of attribute. Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact Amazon Web Services Support for allowlisting. If you set the attribute type as MESSAGE_STREAMING, you need to update the Lex bot alias resource based policy to include the lex:RecognizeMessageAsync action for the connect instance ARN resource.
instance_id	string	The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return per page.
nextToken	string	The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

SELECT examples

describe_instance_attribute

This API is in preview release for Connect Customer and is subject to change. Describes the specified instance attribute.

SELECT
attribute_type,
value
FROM aws.connect.instance_attributes
WHERE instance_id = '{{ instance_id }}' -- required
AND attribute_type = '{{ attribute_type }}' -- required
AND region = '{{ region }}' -- required
;

list_instance_attributes

This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of all attribute types for the given instance.

SELECT
attribute_type,
value
FROM aws.connect.instance_attributes
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

UPDATE examples

update_instance_attribute

This API is in preview release for Connect Customer and is subject to change. Updates the value for the specified attribute type.

UPDATE aws.connect.instance_attributes
SET 
Value = '{{ Value }}',
ClientToken = '{{ ClientToken }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND attribute_type = '{{ attribute_type }}' --required
AND region = '{{ region }}' --required;