Skip to content

Updates an existing flow

Description

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.

Usage

quicksight_update_flow(AwsAccountId, FlowId, Name, Description,
  FlowDefinition, ClientToken)

Arguments

  • AwsAccountId

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

  • FlowId

[required] The unique identifier of the flow to update.

  • Name

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

  • Description

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

  • FlowDefinition

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 describe_flow operation to ensure you are working with the latest format.

  • ClientToken

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

Value

A list with the following syntax:

list(
  Arn = "string",
  FlowId = "string",
  RequestId = "string",
  Status = 123
)

Request syntax

svc$update_flow(
  AwsAccountId = "string",
  FlowId = "string",
  Name = "string",
  Description = "string",
  FlowDefinition = list(),
  ClientToken = "string"
)