Skip to content

CreateFlowRequest

Source code in docs_src/capo_quicksight/types/create_flow_request.py
class CreateFlowRequest(TypedDict, closed=True):
    aws_account_id: "capo_quicksight.types.account_id.AccountId"
    """<p>The ID of the Amazon Web Services account where you want to create the flow.</p>"""
    name: "capo_quicksight.types.title_input.TitleInput"
    """<p>The display name for the flow.</p>"""
    description: NotRequired[
        "capo_quicksight.types.flow_description_input.FlowDescriptionInput"
    ]
    """<p>The description for the flow.</p>"""
    flow_definition: "capo_quicksight.types.sensitive_document.SensitiveDocument"
    """<p>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.</p> <note> <p>Always derive or depend on the flow definition from the <code>DescribeFlow</code> operation to ensure you are working with the latest format.</p> </note>"""
    permissions: NotRequired["capo_quicksight.types.permissions_list.PermissionsList"]
    """<p>Initial permissions for the flow. If omitted, the flow is created without any permissions.</p>"""
    client_token: NotRequired[
        "capo_quicksight.types.create_flow_request_client_token_string.CreateFlowRequestClientTokenString"
    ]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"""

aws_account_id instance-attribute

aws_account_id: AccountId

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

client_token instance-attribute

client_token: NotRequired[CreateFlowRequestClientTokenString]

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

description instance-attribute

description: NotRequired[FlowDescriptionInput]

The description for the flow.

flow_definition instance-attribute

flow_definition: SensitiveDocument

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.

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

name instance-attribute

name: TitleInput

The display name for the flow.

permissions instance-attribute

permissions: NotRequired[PermissionsList]

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