Skip to content

UpdateFlowRequest

Source code in docs_src/capo_quicksight/types/update_flow_request.py
class UpdateFlowRequest(TypedDict, closed=True):
    aws_account_id: "capo_quicksight.types.account_id.AccountId"
    """<p>The ID of the Amazon Web Services account that contains the flow that you are updating.</p>"""
    flow_id: "capo_quicksight.types.flow_id.FlowId"
    """<p>The unique identifier of the flow to update.</p>"""
    name: NotRequired["capo_quicksight.types.title_input.TitleInput"]
    """<p>Updated display name for the flow. Omit to preserve the existing name.</p>"""
    description: NotRequired[
        "capo_quicksight.types.flow_description_input.FlowDescriptionInput"
    ]
    """<p>Updated description for the flow. Omit to preserve the existing description.</p>"""
    flow_definition: NotRequired[
        "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. When provided, all existing steps are replaced. Omit to preserve the existing definition.</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>"""
    client_token: NotRequired[
        "capo_quicksight.types.update_flow_request_client_token_string.UpdateFlowRequestClientTokenString"
    ]
    """<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 that contains the flow that you are updating.

client_token instance-attribute

client_token: NotRequired[UpdateFlowRequestClientTokenString]

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

description instance-attribute

description: NotRequired[FlowDescriptionInput]

Updated description for the flow. Omit to preserve the existing description.

flow_definition instance-attribute

flow_definition: NotRequired[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. When provided, all existing steps are replaced. Omit to preserve the existing definition.

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

flow_id instance-attribute

flow_id: FlowId

The unique identifier of the flow to update.

name instance-attribute

name: NotRequired[TitleInput]

Updated display name for the flow. Omit to preserve the existing name.