contact_flow_modules

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

Overview

Name	contact_flow_modules
Type	Resource
Id	aws.connect.contact_flow_modules

Fields

The following fields are returned by SELECT queries:

describe_contact_flow_module

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN).
content	string	The JSON string that represents the content of the flow. For an example, see Example flow in Connect Customer Flow language.
description	string	The description of the flow module. (pattern: <code>.\S.</code>)
external_invocation_configuration	object	The external invocation configuration for the flow module
flow_module_content_sha_256	string	Hash of the module content for integrity verification. (pattern: <code>^[a-zA-Z0-9]{64}$</code>)
id	string	The identifier of the flow module.
name	string	The name of the flow module. (pattern: <code>.\S.</code>)
settings	string	The configuration settings for the flow module.
state	string	The type of flow module. (ACTIVE, ARCHIVED)
status	string	The status of the flow module. (PUBLISHED, SAVED)
tags	object	The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
version	integer (int64)	The version of the flow module.
version_description	string	Description of the version. (pattern: <code>.\S.</code>)

list_contact_flow_modules

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the flow module.
id	string	The identifier of the flow module.
name	string	The name of the flow module. (pattern: <code>.\S.</code>)
state	string	The type of flow module. (ACTIVE, ARCHIVED)

search_contact_flow_modules

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN).
content	string	The JSON string that represents the content of the flow. For an example, see Example flow in Connect Customer Flow language.
description	string	The description of the flow module. (pattern: <code>.\S.</code>)
external_invocation_configuration	object	The external invocation configuration for the flow module
flow_module_content_sha_256	string	Hash of the module content for integrity verification. (pattern: <code>^[a-zA-Z0-9]{64}$</code>)
id	string	The identifier of the flow module.
name	string	The name of the flow module. (pattern: <code>.\S.</code>)
settings	string	The configuration settings for the flow module.
state	string	The type of flow module. (ACTIVE, ARCHIVED)
status	string	The status of the flow module. (PUBLISHED, SAVED)
tags	object	The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
version	integer (int64)	The version of the flow module.
version_description	string	Description of the version. (pattern: <code>.\S.</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_contact_flow_module	select	instance_id, contact_flow_module_id, region		Describes the specified flow module. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.
list_contact_flow_modules	select	instance_id, region	nextToken, maxResults, state	Provides information about the flow modules for the specified Connect Customer instance.
search_contact_flow_modules	select	region		Searches the flow modules in an Connect Customer instance, with optional filtering.
create_contact_flow_module	insert	instance_id, region		Creates a flow module for the specified Connect Customer instance.
update_contact_flow_module_content	update	instance_id, contact_flow_module_id, region		Updates specified flow module for the specified Connect Customer instance. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.
delete_contact_flow_module	delete	instance_id, contact_flow_module_id, region		Deletes the specified flow module.
update_contact_flow_module_metadata	exec	instance_id, contact_flow_module_id, region		Updates metadata about specified 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.
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.
state	string	The state of the flow module.

SELECT examples

describe_contact_flow_module

Describes the specified flow module. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.

SELECT
arn,
content,
description,
external_invocation_configuration,
flow_module_content_sha_256,
id,
name,
settings,
state,
status,
tags,
version,
version_description
FROM aws.connect.contact_flow_modules
WHERE instance_id = '{{ instance_id }}' -- required
AND contact_flow_module_id = '{{ contact_flow_module_id }}' -- required
AND region = '{{ region }}' -- required
;

list_contact_flow_modules

Provides information about the flow modules for the specified Connect Customer instance.

SELECT
arn,
id,
name,
state
FROM aws.connect.contact_flow_modules
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND state = '{{ state }}'
;

search_contact_flow_modules

Searches the flow modules in an Connect Customer instance, with optional filtering.

SELECT
arn,
content,
description,
external_invocation_configuration,
flow_module_content_sha_256,
id,
name,
settings,
state,
status,
tags,
version,
version_description
FROM aws.connect.contact_flow_modules
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_contact_flow_module

Creates a flow module for the specified Connect Customer instance.

INSERT INTO aws.connect.contact_flow_modules (
Name,
Description,
Content,
Tags,
ClientToken,
Settings,
ExternalInvocationConfiguration,
instance_id,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ Content }}',
'{{ Tags }}',
'{{ ClientToken }}',
'{{ Settings }}',
'{{ ExternalInvocationConfiguration }}',
'{{ instance_id }}',
'{{ region }}'
RETURNING
arn,
id
;

Manifest

# Description fields are for documentation purposes
- name: contact_flow_modules
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the contact_flow_modules resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the contact_flow_modules resource.
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"
  - name: Content
    value: "{{ Content }}"
  - name: Tags
    value: "{{ Tags }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
  - name: Settings
    value: "{{ Settings }}"
  - name: ExternalInvocationConfiguration
    description: |
      The external invocation configuration for the flow module
    value:
      Enabled: {{ Enabled }}

UPDATE examples

update_contact_flow_module_content

Updates specified flow module for the specified Connect Customer instance. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.

UPDATE aws.connect.contact_flow_modules
SET 
Content = '{{ Content }}',
Settings = '{{ Settings }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND contact_flow_module_id = '{{ contact_flow_module_id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_contact_flow_module

Deletes the specified flow module.

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

Lifecycle Methods

update_contact_flow_module_metadata

Updates metadata about specified flow module.

EXEC aws.connect.contact_flow_modules.update_contact_flow_module_metadata 
@instance_id='{{ instance_id }}' --required, 
@contact_flow_module_id='{{ contact_flow_module_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"Name": "{{ Name }}", 
"Description": "{{ Description }}", 
"State": "{{ State }}"
}'
;