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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#created_atTime

Specifies when the flow was created.

Returns:

  • (Time)


2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2203

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_byString

The ARN of the user who created the flow.

Returns:

  • (String)


2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2203

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

#descriptionString

A description of the flow.

Returns:

  • (String)


2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2203

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_listArray<Types::DestinationFlowConfig>

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

Returns:



2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2203

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_arnString

The flow's Amazon Resource Name (ARN).

Returns:

  • (String)


2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2203

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_nameString

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

Returns:

  • (String)


2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2203

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_statusString

Indicates the current status of the flow.

Returns:

  • (String)


2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2203

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_messageString

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

Returns:

  • (String)


2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2203

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_arnString

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.

Returns:

  • (String)


2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2203

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_detailsTypes::ExecutionDetails

Describes the details of the most recent flow run.



2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2203

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_atTime

Specifies when the flow was last updated.

Returns:

  • (Time)


2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2203

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_byString

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

Returns:

  • (String)


2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2203

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_configTypes::SourceFlowConfig

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



2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2203

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

#tagsHash<String,String>

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

Returns:

  • (Hash<String,String>)


2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2203

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

#tasksArray<Types::Task>

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

Returns:



2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2203

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_configTypes::TriggerConfig

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



2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2203

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