QuickSight / Client / describe_flow

describe_flow

QuickSight.Client.describe_flow(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_flow(
    AwsAccountId='string',
    FlowId='string',
    PublishState='PUBLISHED'|'DRAFT'|'PENDING_APPROVAL'
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account that contains the flow that you are describing.

  • FlowId (string) –

    [REQUIRED]

    The unique identifier of the flow.

  • PublishState (string) –

    [REQUIRED]

    The publish state of the flow version to describe. Valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL.

Return type:

dict

Returns:

Response Syntax

{
    'Flow': {
        'Arn': 'string',
        'FlowId': 'string',
        'Name': 'string',
        'Description': 'string',
        'PublishState': 'PUBLISHED'|'DRAFT'|'PENDING_APPROVAL',
        'CreatedTime': datetime(2015, 1, 1),
        'CreatedBy': 'string',
        'LastUpdatedTime': datetime(2015, 1, 1),
        'LastUpdatedBy': 'string',
        'FlowDefinition': {...}|[...]|123|123.4|'string'|True|None,
        'StepAliases': [
            {
                'StepId': 'string',
                'StepAlias': 'string'
            },
        ]
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) –

    • Flow (dict) –

      The full details of the flow.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the flow.

      • FlowId (string) –

        The unique identifier of the flow.

      • Name (string) –

        The display name of the flow.

      • Description (string) –

        The description of the flow.

      • PublishState (string) –

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

      • CreatedTime (datetime) –

        The time this flow was created.

      • CreatedBy (string) –

        The identifier of the principal who created the flow.

      • LastUpdatedTime (datetime) –

        The last time this flow was modified.

      • LastUpdatedBy (string) –

        The identifier of the last principal who updated the flow.

      • FlowDefinition (document) –

        The definition of the flow, specifying the steps and configurations. This is the flow definition in Quick Flow’s internal format. The format is subject to change.

      • StepAliases (list) –

        A list of step alias mappings for the flow.

        • (dict) –

          A mapping between a step identifier and its alias in a flow.

          • StepId (string) –

            The unique identifier of the step.

          • StepAlias (string) –

            The alias for the step.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request.

Exceptions