contact_flow_versions

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

Overview

Name	contact_flow_versions
Type	Resource
Id	aws.connect.contact_flow_versions

Fields

The following fields are returned by SELECT queries:

list_contact_flow_versions

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the view version.
version	integer (int64)	The identifier of the flow version.
version_description	string	The description of the flow version.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_contact_flow_versions	select	instance_id, contact_flow_id, region	nextToken, maxResults	Returns all the available versions for the specified Connect Customer instance and flow identifier.
create_contact_flow_version	insert	instance_id, contact_flow_id, region		Publishes a new version of the flow provided. Versions are immutable and monotonically increasing. If the FlowContentSha256 provided is different from the FlowContentSha256 of the $LATEST published flow content, then an error is returned. This API only supports creating versions for flows of type Campaign.
delete_contact_flow_version	delete	instance_id, contact_flow_id, contact_flow_version, region		Deletes the particular version specified in flow version identifier.

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_id	string	The identifier of the flow.
contact_flow_version	integer (int64)	The identifier of the flow version.
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

list_contact_flow_versions

Returns all the available versions for the specified Connect Customer instance and flow identifier.

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

INSERT examples

create_contact_flow_version

Publishes a new version of the flow provided. Versions are immutable and monotonically increasing. If the FlowContentSha256 provided is different from the FlowContentSha256 of the $LATEST published flow content, then an error is returned. This API only supports creating versions for flows of type Campaign.

INSERT INTO aws.connect.contact_flow_versions (
Description,
FlowContentSha256,
ContactFlowVersion,
LastModifiedTime,
LastModifiedRegion,
instance_id,
contact_flow_id,
region
)
SELECT 
'{{ Description }}',
'{{ FlowContentSha256 }}',
{{ ContactFlowVersion }},
'{{ LastModifiedTime }}',
'{{ LastModifiedRegion }}',
'{{ instance_id }}',
'{{ contact_flow_id }}',
'{{ region }}'
RETURNING
contact_flow_arn,
version
;

Manifest

# Description fields are for documentation purposes
- name: contact_flow_versions
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the contact_flow_versions resource.
  - name: contact_flow_id
    value: "{{ contact_flow_id }}"
    description: Required parameter for the contact_flow_versions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the contact_flow_versions resource.
  - name: Description
    value: "{{ Description }}"
  - name: FlowContentSha256
    value: "{{ FlowContentSha256 }}"
  - name: ContactFlowVersion
    value: {{ ContactFlowVersion }}
  - name: LastModifiedTime
    value: "{{ LastModifiedTime }}"
  - name: LastModifiedRegion
    value: "{{ LastModifiedRegion }}"

DELETE examples

delete_contact_flow_version

Deletes the particular version specified in flow version identifier.

DELETE FROM aws.connect.contact_flow_versions
WHERE instance_id = '{{ instance_id }}' --required
AND contact_flow_id = '{{ contact_flow_id }}' --required
AND contact_flow_version = '{{ contact_flow_version }}' --required
AND region = '{{ region }}' --required
;