Class: Aws::QuickSight::Types::UpdateFlowRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[:flow_definition]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_id ⇒ String

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

Returns:

  • (String)


51889
51890
51891
51892
51893
51894
51895
51896
51897
51898
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 51889

class UpdateFlowRequest < Struct.new(
  :aws_account_id,
  :flow_id,
  :name,
  :description,
  :flow_definition,
  :client_token)
  SENSITIVE = [:flow_definition]
  include Aws::Structure
end

#client_token ⇒ String

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

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


51889
51890
51891
51892
51893
51894
51895
51896
51897
51898
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 51889

class UpdateFlowRequest < Struct.new(
  :aws_account_id,
  :flow_id,
  :name,
  :description,
  :flow_definition,
  :client_token)
  SENSITIVE = [:flow_definition]
  include Aws::Structure
end

#description ⇒ String

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

Returns:

  • (String)


51889
51890
51891
51892
51893
51894
51895
51896
51897
51898
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 51889

class UpdateFlowRequest < Struct.new(
  :aws_account_id,
  :flow_id,
  :name,
  :description,
  :flow_definition,
  :client_token)
  SENSITIVE = [:flow_definition]
  include Aws::Structure
end

#flow_definition ⇒ Hash, ...

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.

Returns:

  • (Hash, Array, String, Numeric, Boolean)


51889
51890
51891
51892
51893
51894
51895
51896
51897
51898
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 51889

class UpdateFlowRequest < Struct.new(
  :aws_account_id,
  :flow_id,
  :name,
  :description,
  :flow_definition,
  :client_token)
  SENSITIVE = [:flow_definition]
  include Aws::Structure
end

#flow_id ⇒ String

The unique identifier of the flow to update.

Returns:

  • (String)


51889
51890
51891
51892
51893
51894
51895
51896
51897
51898
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 51889

class UpdateFlowRequest < Struct.new(
  :aws_account_id,
  :flow_id,
  :name,
  :description,
  :flow_definition,
  :client_token)
  SENSITIVE = [:flow_definition]
  include Aws::Structure
end

#name ⇒ String

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

Returns:

  • (String)


51889
51890
51891
51892
51893
51894
51895
51896
51897
51898
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 51889

class UpdateFlowRequest < Struct.new(
  :aws_account_id,
  :flow_id,
  :name,
  :description,
  :flow_definition,
  :client_token)
  SENSITIVE = [:flow_definition]
  include Aws::Structure
end