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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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)


2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
# File 'lib/aws-sdk-appflow/types.rb', line 2098

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,
  :metadata_catalog_config,
  :last_run_metadata_catalog_details,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#created_byString

The ARN of the user who created the flow.

Returns:

  • (String)


2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
# File 'lib/aws-sdk-appflow/types.rb', line 2098

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,
  :metadata_catalog_config,
  :last_run_metadata_catalog_details,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description of the flow.

Returns:

  • (String)


2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
# File 'lib/aws-sdk-appflow/types.rb', line 2098

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,
  :metadata_catalog_config,
  :last_run_metadata_catalog_details,
  :schema_version)
  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:



2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
# File 'lib/aws-sdk-appflow/types.rb', line 2098

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,
  :metadata_catalog_config,
  :last_run_metadata_catalog_details,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#flow_arnString

The flow’s Amazon Resource Name (ARN).

Returns:

  • (String)


2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
# File 'lib/aws-sdk-appflow/types.rb', line 2098

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,
  :metadata_catalog_config,
  :last_run_metadata_catalog_details,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#flow_nameString

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

Returns:

  • (String)


2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
# File 'lib/aws-sdk-appflow/types.rb', line 2098

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,
  :metadata_catalog_config,
  :last_run_metadata_catalog_details,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#flow_statusString

Indicates the current status of the flow.

Returns:

  • (String)


2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
# File 'lib/aws-sdk-appflow/types.rb', line 2098

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,
  :metadata_catalog_config,
  :last_run_metadata_catalog_details,
  :schema_version)
  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)


2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
# File 'lib/aws-sdk-appflow/types.rb', line 2098

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,
  :metadata_catalog_config,
  :last_run_metadata_catalog_details,
  :schema_version)
  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)


2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
# File 'lib/aws-sdk-appflow/types.rb', line 2098

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,
  :metadata_catalog_config,
  :last_run_metadata_catalog_details,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#last_run_execution_detailsTypes::ExecutionDetails

Describes the details of the most recent flow run.



2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
# File 'lib/aws-sdk-appflow/types.rb', line 2098

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,
  :metadata_catalog_config,
  :last_run_metadata_catalog_details,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#last_run_metadata_catalog_detailsArray<Types::MetadataCatalogDetail>

Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.

Returns:



2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
# File 'lib/aws-sdk-appflow/types.rb', line 2098

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,
  :metadata_catalog_config,
  :last_run_metadata_catalog_details,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_atTime

Specifies when the flow was last updated.

Returns:

  • (Time)


2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
# File 'lib/aws-sdk-appflow/types.rb', line 2098

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,
  :metadata_catalog_config,
  :last_run_metadata_catalog_details,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_byString

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

Returns:

  • (String)


2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
# File 'lib/aws-sdk-appflow/types.rb', line 2098

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,
  :metadata_catalog_config,
  :last_run_metadata_catalog_details,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#metadata_catalog_configTypes::MetadataCatalogConfig

Specifies the configuration that Amazon AppFlow uses when it catalogs the data that’s transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.



2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
# File 'lib/aws-sdk-appflow/types.rb', line 2098

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,
  :metadata_catalog_config,
  :last_run_metadata_catalog_details,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#schema_versionInteger

The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration:

  • Source-to-destination field mappings

  • Field data types

  • Partition keys

Returns:

  • (Integer)


2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
# File 'lib/aws-sdk-appflow/types.rb', line 2098

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,
  :metadata_catalog_config,
  :last_run_metadata_catalog_details,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#source_flow_configTypes::SourceFlowConfig

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



2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
# File 'lib/aws-sdk-appflow/types.rb', line 2098

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,
  :metadata_catalog_config,
  :last_run_metadata_catalog_details,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

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

Returns:

  • (Hash<String,String>)


2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
# File 'lib/aws-sdk-appflow/types.rb', line 2098

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,
  :metadata_catalog_config,
  :last_run_metadata_catalog_details,
  :schema_version)
  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:



2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
# File 'lib/aws-sdk-appflow/types.rb', line 2098

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,
  :metadata_catalog_config,
  :last_run_metadata_catalog_details,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end

#trigger_configTypes::TriggerConfig

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



2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
# File 'lib/aws-sdk-appflow/types.rb', line 2098

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,
  :metadata_catalog_config,
  :last_run_metadata_catalog_details,
  :schema_version)
  SENSITIVE = []
  include Aws::Structure
end