QuickSight / Client / create_flow

create_flow

QuickSight.Client.create_flow(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_flow(
    AwsAccountId='string',
    Name='string',
    Description='string',
    FlowDefinition={...}|[...]|123|123.4|'string'|True|None,
    Permissions=[
        {
            'Actions': [
                'string',
            ],
            'Principal': 'string'
        },
    ],
    ClientToken='string'
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account where you want to create the flow.

  • Name (string) –

    [REQUIRED]

    The display name for the flow.

  • Description (string) – The description for the flow.

  • FlowDefinition (document) –

    [REQUIRED]

    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.

    Note

    Always derive or depend on the flow definition from the DescribeFlow operation to ensure you are working with the latest format.

  • Permissions (list) –

    Initial permissions for the flow. If omitted, the flow is created without any permissions.

    • (dict) –

      A structure that contains the permission information for one principal against one flow.

      • Actions (list) – [REQUIRED]

        A list of actions that the principal can perform against the flow.

        The following are the list of values to set a principal as a flow owner:

        • quicksight:PublishFlow

        • quicksight:GetFlow

        • quicksight:UpdateFlowPermissions

        • quicksight:GetFlowSession

        • quicksight:StartFlowSession

        • quicksight:StopFlowSession

        • quicksight:UpdateFlowSession

        • quicksight:UnpublishFlow

        • quicksight:GetFlowStages

        • quicksight:DeleteFlow

        • quicksight:DescribeFlowPermissions

        • quicksight:UpdateFlow

        • quicksight:CreatePresignedUrl

        The following are the list of values to set a principal as a flow viewer:

        • quicksight:GetFlow

        • quicksight:UpdateFlowSession

        • quicksight:StartFlowSession

        • quicksight:StopFlowSession

        • quicksight:GetFlowSession

        • quicksight:CreatePresignedUrl

        • quicksight:GetFlowStages

        • (string) –

      • Principal (string) – [REQUIRED]

        The Amazon Resource Name (ARN) of the principal. This can be an Amazon Quick user, group or namespace associated with the flow. Namespace principal can only be set as a viewer and will grant everyone in the same namespace viewer permissions.

  • ClientToken (string) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'FlowId': 'string',
    '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.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request.

Exceptions