QuickSight / Client / get_flow_metadata

get_flow_metadata

QuickSight.Client.get_flow_metadata(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_flow_metadata(
    AwsAccountId='string',
    FlowId='string'
)

Parameters:

• AwsAccountId (string) –

  [REQUIRED]

  The ID of the Amazon Web Services account that contains the flow that you are getting metadata for.

• FlowId (string) –

  [REQUIRED]

  The unique identifier of the flow.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'FlowId': 'string',
    'Name': 'string',
    'Description': 'string',
    'PublishState': 'PUBLISHED'|'DRAFT'|'PENDING_APPROVAL',
    'UserCount': 123,
    'RunCount': 123,
    'CreatedTime': datetime(2015, 1, 1),
    'LastUpdatedTime': datetime(2015, 1, 1),
    'RequestId': 'string',
    'Status': 123
}

Response Structure

• (dict) –

  • Arn (string) –

    The Amazon Resource Name (ARN) of the flow.

  • FlowId (string) –

    The unique identifier of the flow.

  • Name (string) –

    A display name for the flow.

  • Description (string) –

    The description for the flow.

  • PublishState (string) –

    The publish state for the flow. Valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL.

  • UserCount (integer) –

    The number of users who have used the flow.

  • RunCount (integer) –

    The number of runs done for the flow.

  • CreatedTime (datetime) –

    The time this flow was created.

  • LastUpdatedTime (datetime) –

    The last time this flow was modified.

  • RequestId (string) –

    The Amazon Web Services request ID for this operation.

  • Status (integer) –

    The HTTP status of the request.

Exceptions

• QuickSight.Client.exceptions.ThrottlingException

• QuickSight.Client.exceptions.InvalidParameterValueException

• QuickSight.Client.exceptions.InternalFailureException

• QuickSight.Client.exceptions.AccessDeniedException