Class: Aws::QuickSight::Types::CreateFlowRequest

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::CreateFlowRequest

Defined in:

gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:flow_definition]

Instance Attribute Summary

• #aws_account_id ⇒ String

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

• #client_token ⇒ String

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

• #description ⇒ String

  The description for the flow.

• #flow_definition ⇒ Hash, ...

  The definition of the flow, specifying the steps and configurations.

• #name ⇒ String

  The display name for the flow.

• #permissions ⇒ Array<Types::Permission>

  Initial permissions for the flow.

Instance Attribute Details

#aws_account_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 9001

class CreateFlowRequest < Struct.new(
  :aws_account_id,
  :name,
  :description,
  :flow_definition,
  :permissions,
  :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)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 9001

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

#description ⇒ String

The description for the flow.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 9001

class CreateFlowRequest < Struct.new(
  :aws_account_id,
  :name,
  :description,
  :flow_definition,
  :permissions,
  :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.

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)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 9001

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

#name ⇒ String

The display name for the flow.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 9001

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

#permissions ⇒ Array<Types::Permission>

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

Returns:

• (Array<Types::Permission>)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 9001

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