flows

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

Overview

Name	flows
Type	Resource
Id	aws.quicksight.flows

Fields

The following fields are returned by SELECT queries:

describe_flow

Name	Datatype	Description
flow	object	The full details of the flow.
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.

search_flows

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the flow.
created_by	string	The identifier of the principal who created the flow.
created_time	string (date-time)	The time this flow was created.
description	string	The description of the flow.
flow_id	string	The unique identifier of the flow. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
last_published_at	string (date-time)	The last time this flow was published.
last_published_by	string	The identifier of the last principal who published the flow.
last_updated_by	string	The identifier of the last principal who updated the flow.
last_updated_time	string (date-time)	The last time this flow was modified.
name	string	The display name of the flow.
publish_state	string	The publish state for the flow. The valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL. (PUBLISHED, DRAFT, PENDING_APPROVAL)
run_count	integer	The number of runs done for the flow.
user_count	integer	The number of users who have used the flow.

list_flows

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the flow.
created_by	string	The identifier of the principal who created the flow.
created_time	string (date-time)	The time this flow was created.
description	string	The description of the flow.
flow_id	string	The unique identifier of the flow. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
last_published_at	string (date-time)	The last time this flow was published.
last_published_by	string	The identifier of the last principal who published the flow.
last_updated_by	string	The identifier of the last principal who updated the flow.
last_updated_time	string (date-time)	The last time this flow was modified.
name	string	The display name of the flow.
publish_state	string	The publish state for the flow. The valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL. (PUBLISHED, DRAFT, PENDING_APPROVAL)
run_count	integer	The number of runs done for the flow.
user_count	integer	The number of users who have used the flow.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_flow	select	aws_account_id, flow_id, publish-state, region		Returns the full details of a flow for the latest version of the requested publish state.
search_flows	select	aws_account_id, region		Search for the flows in an Amazon Web Services account.
list_flows	select	aws_account_id, region	next-token, max-results	Lists flows in an Amazon Web Services account.
create_flow	insert	aws_account_id, region, FlowDefinition		Creates a new flow in the specified Amazon Web Services account. Creates both a DRAFT and PUBLISHED (auto-published) version. This operation is idempotent. Supply a ClientToken to safely retry without creating duplicate resources.
update_flow	update	aws_account_id, flow_id, region		Updates an existing flow. Supply only the fields you want to change. Updates both DRAFT and PUBLISHED versions. When FlowDefinition is provided, all existing steps are replaced with the new definition.
delete_flow	delete	aws_account_id, flow_id, region		Permanently deletes a flow from the specified Amazon Web Services account. This operation cannot be undone.

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
aws_account_id	string	The ID of the Amazon Web Services account that contains the flow that you are deleting.
flow_id	string	The unique identifier of the flow to delete.
publish-state	string	The publish state of the flow version to describe. Valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of results to be returned per request.
next-token	string	The token to request the next set of results, or null if you want to retrieve the first set.

SELECT examples

describe_flow

Returns the full details of a flow for the latest version of the requested publish state.

SELECT
flow,
request_id,
status
FROM aws.quicksight.flows
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND flow_id = '{{ flow_id }}' -- required
AND `publish-state` = '{{ publish-state }}' -- required
AND region = '{{ region }}' -- required
;

search_flows

Search for the flows in an Amazon Web Services account.

SELECT
arn,
created_by,
created_time,
description,
flow_id,
last_published_at,
last_published_by,
last_updated_by,
last_updated_time,
name,
publish_state,
run_count,
user_count
FROM aws.quicksight.flows
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
;

list_flows

Lists flows in an Amazon Web Services account.

SELECT
arn,
created_by,
created_time,
description,
flow_id,
last_published_at,
last_published_by,
last_updated_by,
last_updated_time,
name,
publish_state,
run_count,
user_count
FROM aws.quicksight.flows
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

INSERT examples

create_flow

Creates a new flow in the specified Amazon Web Services account. Creates both a DRAFT and PUBLISHED (auto-published) version. This operation is idempotent. Supply a ClientToken to safely retry without creating duplicate resources.

INSERT INTO aws.quicksight.flows (
Name,
Description,
FlowDefinition,
Permissions,
ClientToken,
aws_account_id,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ FlowDefinition }}' /* required */,
'{{ Permissions }}',
'{{ ClientToken }}',
'{{ aws_account_id }}',
'{{ region }}'
RETURNING
arn,
flow_id,
request_id,
status
;

Manifest

# Description fields are for documentation purposes
- name: flows
props:
  - name: aws_account_id
    value: "{{ aws_account_id }}"
    description: Required parameter for the flows resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the flows resource.
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"
  - name: FlowDefinition
    value: "{{ FlowDefinition }}"
  - name: Permissions
    value:
      - Actions: "{{ Actions }}"
        Principal: "{{ Principal }}"
  - name: ClientToken
    value: "{{ ClientToken }}"

UPDATE examples

update_flow

Updates an existing flow. Supply only the fields you want to change. Updates both DRAFT and PUBLISHED versions. When FlowDefinition is provided, all existing steps are replaced with the new definition.

UPDATE aws.quicksight.flows
SET 
Name = '{{ Name }}',
Description = '{{ Description }}',
FlowDefinition = '{{ FlowDefinition }}',
ClientToken = '{{ ClientToken }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND flow_id = '{{ flow_id }}' --required
AND region = '{{ region }}' --required
RETURNING
arn,
flow_id,
request_id,
status;

DELETE examples

delete_flow

Permanently deletes a flow from the specified Amazon Web Services account. This operation cannot be undone.

DELETE FROM aws.quicksight.flows
WHERE aws_account_id = '{{ aws_account_id }}' --required
AND flow_id = '{{ flow_id }}' --required
AND region = '{{ region }}' --required
;