flow_metadatas

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

Overview

Name	flow_metadatas
Type	Resource
Id	aws.quicksight.flow_metadatas

Fields

The following fields are returned by SELECT queries:

get_flow_metadata

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the flow.
created_time	string (date-time)	The time this flow was created.
description	string	The description for 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_updated_time	string (date-time)	The last time this flow was modified.
name	string	A display name for the flow.
publish_state	string	The publish state for the flow. Valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL. (PUBLISHED, DRAFT, PENDING_APPROVAL)
request_id	string	The Amazon Web Services request ID for this operation.
run_count	integer	The number of runs done for the flow.
status	integer	The HTTP status of the request.
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
get_flow_metadata	select	aws_account_id, flow_id, region		Retrieves the metadata of a flow, not including its definition specifying the steps.

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 getting metadata for.
flow_id	string	The unique identifier of the flow.
region	string	AWS region (default: us-east-1)

SELECT examples

get_flow_metadata

Retrieves the metadata of a flow, not including its definition specifying the steps.

SELECT
arn,
created_time,
description,
flow_id,
last_updated_time,
name,
publish_state,
request_id,
run_count,
status,
user_count
FROM aws.quicksight.flow_metadatas
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND flow_id = '{{ flow_id }}' -- required
AND region = '{{ region }}' -- required
;