contact_flow_versions

Creates, updates, deletes or gets a contact_flow_version resource or lists contact_flow_versions in a region

Overview

Name	contact_flow_versions
Type	Resource
Description	Resource Type Definition for ContactFlowVersion
Id	awscc.connect.contact_flow_versions

Fields

get (all properties)

Name	Datatype	Description
contact_flow_version_arn	string	The identifier of the contact flow version (ARN).
contact_flow_id	string	The ARN of the contact flow this version is tied to.
version	integer	The version number of this revision
description	string	The description of the version.
flow_content_sha256	string	Indicates the checksum value of the latest published flow content
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
contact_flow_version_arn	string	The identifier of the contact flow version (ARN).
version	integer	The version number of this revision
region	string	AWS region.

For more information, see AWS::Connect::ContactFlowVersion.

Methods

Name	Resource	Accessible by	Required Params
create_resource	contact_flow_versions	INSERT	ContactFlowId, region
delete_resource	contact_flow_versions	DELETE	Identifier, region
update_resource	contact_flow_versions	UPDATE	Identifier, PatchDocument, region
list_resources	contact_flow_versions_list_only	SELECT	region
get_resource	contact_flow_versions	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual contact_flow_version.

SELECT
  region,
  contact_flow_version_arn,
  contact_flow_id,
  version,
  description,
  flow_content_sha256
FROM awscc.connect.contact_flow_versions
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ contact_flow_version_arn }}';

list (identifiers only)

Lists all contact_flow_versions in a region.

SELECT
  region,
  contact_flow_version_arn
FROM awscc.connect.contact_flow_versions_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new contact_flow_version resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.connect.contact_flow_versions (
  ContactFlowId,
  region
)
SELECT
  '{{ contact_flow_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.connect.contact_flow_versions (
  ContactFlowId,
  Description,
  region
)
SELECT
  '{{ contact_flow_id }}',
  '{{ description }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: contact_flow_version
  props:
    - name: contact_flow_id
      value: '{{ contact_flow_id }}'
    - name: description
      value: '{{ description }}'

DELETE example

/*+ delete */
DELETE FROM awscc.connect.contact_flow_versions
WHERE
  Identifier = '{{ contact_flow_version_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the contact_flow_versions resource, the following permissions are required:

Create

connect:CreateContactFlowVersion,
connect:DescribeContactFlow

Read

connect:DescribeContactFlow

Delete

connect:DeleteContactFlowVersion

List

connect:ListContactFlowVersions

Update

connect:DescribeContactFlow