AWS SDK Version 3 for .NET
API Reference

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.

This is the response object from the DescribeFlow operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.Appflow.Model.DescribeFlowResponse

Namespace: Amazon.Appflow.Model
Assembly: AWSSDK.Appflow.dll
Version: 3.x.y.z

Syntax

C#
public class DescribeFlowResponse : AmazonWebServiceResponse

The DescribeFlowResponse type exposes the following members

Constructors

NameDescription
Public Method DescribeFlowResponse()

Properties

NameTypeDescription
Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property CreatedAt System.DateTime

Gets and sets the property CreatedAt.

Specifies when the flow was created.

Public Property CreatedBy System.String

Gets and sets the property CreatedBy.

The ARN of the user who created the flow.

Public Property Description System.String

Gets and sets the property Description.

A description of the flow.

Public Property DestinationFlowConfigList System.Collections.Generic.List<Amazon.Appflow.Model.DestinationFlowConfig>

Gets and sets the property DestinationFlowConfigList.

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

Public Property FlowArn System.String

Gets and sets the property FlowArn.

The flow's Amazon Resource Name (ARN).

Public Property FlowName System.String

Gets and sets the property FlowName.

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

Public Property FlowStatus Amazon.Appflow.FlowStatus

Gets and sets the property FlowStatus.

Indicates the current status of the flow.

Public Property FlowStatusMessage System.String

Gets and sets the property FlowStatusMessage.

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

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property KmsArn System.String

Gets and sets the property KmsArn.

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.

Public Property LastRunExecutionDetails Amazon.Appflow.Model.ExecutionDetails

Gets and sets the property LastRunExecutionDetails.

Describes the details of the most recent flow run.

Public Property LastRunMetadataCatalogDetails System.Collections.Generic.List<Amazon.Appflow.Model.MetadataCatalogDetail>

Gets and sets the property LastRunMetadataCatalogDetails.

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

Public Property LastUpdatedAt System.DateTime

Gets and sets the property LastUpdatedAt.

Specifies when the flow was last updated.

Public Property LastUpdatedBy System.String

Gets and sets the property LastUpdatedBy.

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

Public Property MetadataCatalogConfig Amazon.Appflow.Model.MetadataCatalogConfig

Gets and sets the property 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.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property SchemaVersion System.Int64

Gets and sets the property SchemaVersion.

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

Public Property SourceFlowConfig Amazon.Appflow.Model.SourceFlowConfig

Gets and sets the property SourceFlowConfig.

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

Public Property Tags System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Tags.

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

Public Property Tasks System.Collections.Generic.List<Amazon.Appflow.Model.Task>

Gets and sets the property Tasks.

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

Public Property TriggerConfig Amazon.Appflow.Model.TriggerConfig

Gets and sets the property TriggerConfig.

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5