flow_associations

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

Overview

Name	flow_associations
Type	Resource
Id	aws.connect.flow_associations

Fields

The following fields are returned by SELECT queries:

get_flow_association

Name	Datatype	Description
flow_id	string	The identifier of the flow.
resource_id	string	The identifier of the resource.
resource_type	string	A valid resource type. (SMS_PHONE_NUMBER, INBOUND_EMAIL, OUTBOUND_EMAIL, ANALYTICS_CONNECTOR, WHATSAPP_MESSAGING_PHONE_NUMBER)

batch_get_flow_association

Name	Datatype	Description
flow_association_summary_list	array	Information about flow associations.

list_flow_associations

Name	Datatype	Description
flow_id	string	The identifier of the flow.
resource_id	string	The identifier of the resource.
resource_type	string	The type of resource association. (WHATSAPP_MESSAGING_PHONE_NUMBER, VOICE_PHONE_NUMBER, INBOUND_EMAIL, OUTBOUND_EMAIL, ANALYTICS_CONNECTOR)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_flow_association	select	instance_id, resource_id, resource_type, region		Retrieves the flow associated for a given resource.
batch_get_flow_association	select	instance_id, region		Retrieve the flow associations for the given resources.
list_flow_associations	select	instance_id, region	ResourceType, nextToken, maxResults	List the flow association based on the filters.

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
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)
resource_id	string	The identifier of the resource. Amazon Web Services End User Messaging SMS phone number ARN when using SMS_PHONE_NUMBER Amazon Web Services End User Messaging Social phone number ARN when using WHATSAPP_MESSAGING_PHONE_NUMBER
resource_type	string	A valid resource type.
ResourceType	string	A valid resource type.
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

get_flow_association

Retrieves the flow associated for a given resource.

SELECT
flow_id,
resource_id,
resource_type
FROM aws.connect.flow_associations
WHERE instance_id = '{{ instance_id }}' -- required
AND resource_id = '{{ resource_id }}' -- required
AND resource_type = '{{ resource_type }}' -- required
AND region = '{{ region }}' -- required
;

batch_get_flow_association

Retrieve the flow associations for the given resources.

SELECT
flow_association_summary_list
FROM aws.connect.flow_associations
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
;

list_flow_associations

List the flow association based on the filters.

SELECT
flow_id,
resource_id,
resource_type
FROM aws.connect.flow_associations
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
AND ResourceType = '{{ ResourceType }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;