Class: Aws::Appflow::Types::DescribeFlowResponse

Inherits:

Struct

• Object
• Struct
• Aws::Appflow::Types::DescribeFlowResponse

Includes:

Structure

Defined in:

lib/aws-sdk-appflow/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created_at ⇒ Time

  Specifies when the flow was created.

• #created_by ⇒ String

  The ARN of the user who created the flow.

• #description ⇒ String

  A description of the flow.

• #destination_flow_config_list ⇒ Array<Types::DestinationFlowConfig>

  The configuration that controls how Amazon AppFlow transfers data to the destination connector.

• #flow_arn ⇒ String

  The flow’s Amazon Resource Name (ARN).

• #flow_name ⇒ String

  The specified name of the flow.

• #flow_status ⇒ String

  Indicates the current status of the flow.

• #flow_status_message ⇒ String

  Contains an error message if the flow status is in a suspended or error state.

• #kms_arn ⇒ String

  The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.

• #last_run_execution_details ⇒ Types::ExecutionDetails

  Describes the details of the most recent flow run.

• #last_updated_at ⇒ Time

  Specifies when the flow was last updated.

• #last_updated_by ⇒ String

  Specifies the user name of the account that performed the most recent update.

• #source_flow_config ⇒ Types::SourceFlowConfig

  The configuration that controls how Amazon AppFlow retrieves data from the source connector.

• #tags ⇒ Hash<String,String>

  The tags used to organize, track, or control access for your flow.

• #tasks ⇒ Array<Types::Task>

  A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

• #trigger_config ⇒ Types::TriggerConfig

  The trigger settings that determine how and when the flow runs.

Instance Attribute Details

#created_at ⇒ Time

Specifies when the flow was created.

# File 'lib/aws-sdk-appflow/types.rb', line 2038

class DescribeFlowResponse < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :kms_arn,
  :flow_status,
  :flow_status_message,
  :source_flow_config,
  :destination_flow_config_list,
  :last_run_execution_details,
  :trigger_config,
  :tasks,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#created_by ⇒ String

The ARN of the user who created the flow.

# File 'lib/aws-sdk-appflow/types.rb', line 2038

class DescribeFlowResponse < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :kms_arn,
  :flow_status,
  :flow_status_message,
  :source_flow_config,
  :destination_flow_config_list,
  :last_run_execution_details,
  :trigger_config,
  :tasks,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the flow.

# File 'lib/aws-sdk-appflow/types.rb', line 2038

class DescribeFlowResponse < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :kms_arn,
  :flow_status,
  :flow_status_message,
  :source_flow_config,
  :destination_flow_config_list,
  :last_run_execution_details,
  :trigger_config,
  :tasks,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#destination_flow_config_list ⇒ Array<Types::DestinationFlowConfig>

The configuration that controls how Amazon AppFlow transfers data to the destination connector.

# File 'lib/aws-sdk-appflow/types.rb', line 2038

class DescribeFlowResponse < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :kms_arn,
  :flow_status,
  :flow_status_message,
  :source_flow_config,
  :destination_flow_config_list,
  :last_run_execution_details,
  :trigger_config,
  :tasks,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#flow_arn ⇒ String

The flow’s Amazon Resource Name (ARN).

# File 'lib/aws-sdk-appflow/types.rb', line 2038

class DescribeFlowResponse < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :kms_arn,
  :flow_status,
  :flow_status_message,
  :source_flow_config,
  :destination_flow_config_list,
  :last_run_execution_details,
  :trigger_config,
  :tasks,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#flow_name ⇒ String

The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

# File 'lib/aws-sdk-appflow/types.rb', line 2038

class DescribeFlowResponse < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :kms_arn,
  :flow_status,
  :flow_status_message,
  :source_flow_config,
  :destination_flow_config_list,
  :last_run_execution_details,
  :trigger_config,
  :tasks,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#flow_status ⇒ String

Indicates the current status of the flow.

# File 'lib/aws-sdk-appflow/types.rb', line 2038

class DescribeFlowResponse < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :kms_arn,
  :flow_status,
  :flow_status_message,
  :source_flow_config,
  :destination_flow_config_list,
  :last_run_execution_details,
  :trigger_config,
  :tasks,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#flow_status_message ⇒ String

Contains an error message if the flow status is in a suspended or error state. This applies only to scheduled or event-triggered flows.

# File 'lib/aws-sdk-appflow/types.rb', line 2038

class DescribeFlowResponse < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :kms_arn,
  :flow_status,
  :flow_status_message,
  :source_flow_config,
  :destination_flow_config_list,
  :last_run_execution_details,
  :trigger_config,
  :tasks,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#kms_arn ⇒ String

The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don’t provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.

# File 'lib/aws-sdk-appflow/types.rb', line 2038

class DescribeFlowResponse < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :kms_arn,
  :flow_status,
  :flow_status_message,
  :source_flow_config,
  :destination_flow_config_list,
  :last_run_execution_details,
  :trigger_config,
  :tasks,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_run_execution_details ⇒ Types::ExecutionDetails

Describes the details of the most recent flow run.

# File 'lib/aws-sdk-appflow/types.rb', line 2038

class DescribeFlowResponse < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :kms_arn,
  :flow_status,
  :flow_status_message,
  :source_flow_config,
  :destination_flow_config_list,
  :last_run_execution_details,
  :trigger_config,
  :tasks,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_at ⇒ Time

Specifies when the flow was last updated.

# File 'lib/aws-sdk-appflow/types.rb', line 2038

class DescribeFlowResponse < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :kms_arn,
  :flow_status,
  :flow_status_message,
  :source_flow_config,
  :destination_flow_config_list,
  :last_run_execution_details,
  :trigger_config,
  :tasks,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_by ⇒ String

Specifies the user name of the account that performed the most recent update.

# File 'lib/aws-sdk-appflow/types.rb', line 2038

class DescribeFlowResponse < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :kms_arn,
  :flow_status,
  :flow_status_message,
  :source_flow_config,
  :destination_flow_config_list,
  :last_run_execution_details,
  :trigger_config,
  :tasks,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#source_flow_config ⇒ Types::SourceFlowConfig

The configuration that controls how Amazon AppFlow retrieves data from the source connector.

# File 'lib/aws-sdk-appflow/types.rb', line 2038

class DescribeFlowResponse < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :kms_arn,
  :flow_status,
  :flow_status_message,
  :source_flow_config,
  :destination_flow_config_list,
  :last_run_execution_details,
  :trigger_config,
  :tasks,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags used to organize, track, or control access for your flow.

# File 'lib/aws-sdk-appflow/types.rb', line 2038

class DescribeFlowResponse < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :kms_arn,
  :flow_status,
  :flow_status_message,
  :source_flow_config,
  :destination_flow_config_list,
  :last_run_execution_details,
  :trigger_config,
  :tasks,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tasks ⇒ Array<Types::Task>

A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

# File 'lib/aws-sdk-appflow/types.rb', line 2038

class DescribeFlowResponse < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :kms_arn,
  :flow_status,
  :flow_status_message,
  :source_flow_config,
  :destination_flow_config_list,
  :last_run_execution_details,
  :trigger_config,
  :tasks,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#trigger_config ⇒ Types::TriggerConfig

The trigger settings that determine how and when the flow runs.

# File 'lib/aws-sdk-appflow/types.rb', line 2038

class DescribeFlowResponse < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :kms_arn,
  :flow_status,
  :flow_status_message,
  :source_flow_config,
  :destination_flow_config_list,
  :last_run_execution_details,
  :trigger_config,
  :tasks,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end