QuickSight / Client / update_flow

update_flow

QuickSight.Client.update_flow(**kwargs)

Updates an existing flow. Supply only the fields you want to change. Updates both DRAFT and PUBLISHED versions. When FlowDefinition is provided, all existing steps are replaced with the new definition.

See also: AWS API Documentation

Request Syntax

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

  • AwsAccountId (string) –

    [REQUIRED]

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

  • FlowId (string) –

    [REQUIRED]

    The unique identifier of the flow to update.

  • Name (string) – Updated display name for the flow. Omit to preserve the existing name.

  • Description (string) – Updated description for the flow. Omit to preserve the existing description.

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

    Note

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

  • 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

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.InvalidParameterValueException

  • QuickSight.Client.exceptions.InternalFailureException

  • QuickSight.Client.exceptions.ResourceNotFoundException

  • QuickSight.Client.exceptions.LimitExceededException

  • QuickSight.Client.exceptions.AccessDeniedException

  • QuickSight.Client.exceptions.ConflictException