attached_files_configurations

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

Overview

Name	attached_files_configurations
Type	Resource
Id	aws.connect.attached_files_configurations

Fields

The following fields are returned by SELECT queries:

describe_attached_files_configuration

Name	Datatype	Description
attachment_scope	string	The scope of the attachment. Valid values are: EMAIL - Attachments for email messages. CHAT - Attachments for chat conversations. CASE - Attachments for cases. TASK - Attachments for tasks. (EMAIL, CHAT, CASE, TASK)
extension_configuration	object	The configuration for allowed file extensions.
instance_id	string	The identifier of the Connect Customer instance.
last_modified_time	string (date-time)	The timestamp when the configuration was last modified.
maximum_size_limit_in_bytes	integer (int64)	The maximum size limit for attached files in bytes.

list_attached_files_configurations

Name	Datatype	Description
attachment_scope	string	The scope of the attachment. Valid values are: EMAIL - Attachments for email messages. CHAT - Attachments for chat conversations. CASE - Attachments for cases. TASK - Attachments for tasks. (EMAIL, CHAT, CASE, TASK)
extension_configuration	object	The configuration for allowed file extensions.
instance_id	string	The identifier of the Connect Customer instance.
maximum_size_limit_in_bytes	integer (int64)	The maximum size limit for attached files in bytes. The minimum value is 1 and the maximum value is 104857600 (100 MB).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_attached_files_configuration	select	instance_id, attachment_scope, region		Describes the attached files configuration for the specified Connect Customer instance and attachment scope. If a custom configuration exists for the specified attachment scope, the custom configuration is returned. If no custom configuration exists, the default configuration values for that attachment scope are returned.
list_attached_files_configurations	select	instance_id, region	maxResults, nextToken	Provides summary information about the attached files configurations for the specified Connect Customer instance. This API returns effective configurations (custom overrides or defaults) for each attachment scope. If no custom configuration exists for a scope, the default configuration values are returned.
update_attached_files_configuration	update	instance_id, attachment_scope, region		Updates the attached files configuration for the specified Connect Customer instance and attachment scope. If no instance-specific configuration exists, this operation creates one. Partial updates are supported—only specified fields are updated, while unspecified fields retain their current values.

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
attachment_scope	string	The scope of the attachment. Valid values are EMAIL, CHAT, CASE, and TASK.
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. The default MaxResult size is 100.
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_attached_files_configuration

Describes the attached files configuration for the specified Connect Customer instance and attachment scope. If a custom configuration exists for the specified attachment scope, the custom configuration is returned. If no custom configuration exists, the default configuration values for that attachment scope are returned.

SELECT
attachment_scope,
extension_configuration,
instance_id,
last_modified_time,
maximum_size_limit_in_bytes
FROM aws.connect.attached_files_configurations
WHERE instance_id = '{{ instance_id }}' -- required
AND attachment_scope = '{{ attachment_scope }}' -- required
AND region = '{{ region }}' -- required
;

list_attached_files_configurations

Provides summary information about the attached files configurations for the specified Connect Customer instance. This API returns effective configurations (custom overrides or defaults) for each attachment scope. If no custom configuration exists for a scope, the default configuration values are returned.

SELECT
attachment_scope,
extension_configuration,
instance_id,
maximum_size_limit_in_bytes
FROM aws.connect.attached_files_configurations
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

UPDATE examples

update_attached_files_configuration

Updates the attached files configuration for the specified Connect Customer instance and attachment scope. If no instance-specific configuration exists, this operation creates one. Partial updates are supported—only specified fields are updated, while unspecified fields retain their current values.

UPDATE aws.connect.attached_files_configurations
SET 
MaximumSizeLimitInBytes = {{ MaximumSizeLimitInBytes }},
ExtensionConfiguration = '{{ ExtensionConfiguration }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND attachment_scope = '{{ attachment_scope }}' --required
AND region = '{{ region }}' --required
RETURNING
attachment_scope,
extension_configuration,
instance_id,
last_modified_time,
maximum_size_limit_in_bytes;