contact_flow_module_versions

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

Overview

Name	contact_flow_module_versions
Type	Resource
Id	aws.connect.contact_flow_module_versions

Fields

The following fields are returned by SELECT queries:

list_contact_flow_module_versions

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the flow module version.
version	integer (int64)	The version of the flow module.
version_description	string	The description of the flow module version. (pattern: <code>.\S.</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_contact_flow_module_versions	select	instance_id, contact_flow_module_id, region	nextToken, maxResults	Retrieves a paginated list of all versions for a specific contact flow module.
create_contact_flow_module_version	insert	instance_id, contact_flow_module_id, region		Creates an immutable snapshot of a contact flow module, preserving its content and settings at a specific point in time for version control and rollback capabilities.
delete_contact_flow_module_version	delete	instance_id, contact_flow_module_id, contact_flow_module_version, region		Removes a specific version of a contact flow module.

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
contact_flow_module_id	string	The identifier of the flow module.
contact_flow_module_version	integer (int64)	The version of the flow module to delete.
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

list_contact_flow_module_versions

Retrieves a paginated list of all versions for a specific contact flow module.

SELECT
arn,
version,
version_description
FROM aws.connect.contact_flow_module_versions
WHERE instance_id = '{{ instance_id }}' -- required
AND contact_flow_module_id = '{{ contact_flow_module_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_contact_flow_module_version

Creates an immutable snapshot of a contact flow module, preserving its content and settings at a specific point in time for version control and rollback capabilities.

INSERT INTO aws.connect.contact_flow_module_versions (
Description,
FlowModuleContentSha256,
instance_id,
contact_flow_module_id,
region
)
SELECT 
'{{ Description }}',
'{{ FlowModuleContentSha256 }}',
'{{ instance_id }}',
'{{ contact_flow_module_id }}',
'{{ region }}'
RETURNING
contact_flow_module_arn,
version
;

Manifest

# Description fields are for documentation purposes
- name: contact_flow_module_versions
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the contact_flow_module_versions resource.
  - name: contact_flow_module_id
    value: "{{ contact_flow_module_id }}"
    description: Required parameter for the contact_flow_module_versions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the contact_flow_module_versions resource.
  - name: Description
    value: "{{ Description }}"
  - name: FlowModuleContentSha256
    value: "{{ FlowModuleContentSha256 }}"

DELETE examples

delete_contact_flow_module_version

Removes a specific version of a contact flow module.

DELETE FROM aws.connect.contact_flow_module_versions
WHERE instance_id = '{{ instance_id }}' --required
AND contact_flow_module_id = '{{ contact_flow_module_id }}' --required
AND contact_flow_module_version = '{{ contact_flow_module_version }}' --required
AND region = '{{ region }}' --required
;