AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#created_atTime

Specifies when the flow was created.

Returns:

  • (Time)

    Specifies when the flow was created.

#created_byString

The ARN of the user who created the flow.

Returns:

  • (String)

    The ARN of the user who created the flow.

#descriptionString

A description of the flow.

Returns:

  • (String)

    A description of the flow.

#destination_flow_config_listArray<Types::DestinationFlowConfig>

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

Returns:

#flow_arnString

The flow\'s Amazon Resource Name (ARN).

Returns:

  • (String)

    The flow\'s Amazon Resource Name (ARN).

#flow_nameString

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

Returns:

  • (String)

    The specified name of the flow.

#flow_statusString

Indicates the current status of the flow.

Possible values:

  • Active
  • Deprecated
  • Deleted
  • Draft
  • Errored
  • Suspended

Returns:

  • (String)

    Indicates the current status of the flow.

#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)

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

#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)

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

#last_run_execution_detailsTypes::ExecutionDetails

Describes the details of the most recent flow run.

Returns:

#last_updated_atTime

Specifies when the flow was last updated.

Returns:

  • (Time)

    Specifies when the flow was last updated.

#last_updated_byString

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

Returns:

  • (String)

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

#source_flow_configTypes::SourceFlowConfig

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

Returns:

  • (Types::SourceFlowConfig)

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

#tagsHash<String,String>

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

Returns:

  • (Hash<String,String>)

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

#tasksArray<Types::Task>

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

Returns:

  • (Array<Types::Task>)

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

#trigger_configTypes::TriggerConfig

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

Returns: