DescribeFlowResponse

import type { DescribeFlowResponse } from "https://aws-api.deno.dev/v0.4/services/appflow.ts?docs=full";

interface DescribeFlowResponse {

createdAt?: Date | number | null;

createdBy?: string | null;

description?: string | null;

destinationFlowConfigList?: DestinationFlowConfig[] | null;

flowArn?: string | null;

flowName?: string | null;

flowStatus?: FlowStatus | null;

flowStatusMessage?: string | null;

kmsArn?: string | null;

lastRunExecutionDetails?: ExecutionDetails | null;

lastRunMetadataCatalogDetails?: MetadataCatalogDetail[] | null;

lastUpdatedAt?: Date | number | null;

lastUpdatedBy?: string | null;

metadataCatalogConfig?: MetadataCatalogConfig | null;

schemaVersion?: number | null;

sourceFlowConfig?: SourceFlowConfig | null;

tags?: {

[key: string]: string | null | undefined;

} | null;

tasks?: Task[] | null;

triggerConfig?: TriggerConfig | null;

}

§Properties

createdAt?: Date | number | null

[src]

Specifies when the flow was created.

createdBy?: string | null

[src]

The ARN of the user who created the flow.

description?: string | null

[src]

A description of the flow.

destinationFlowConfigList?: DestinationFlowConfig[] | null

[src]

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

flowArn?: string | null

[src]

The flow's Amazon Resource Name (ARN).

flowName?: string | null

[src]

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

flowStatus?: FlowStatus | null

[src]

Indicates the current status of the flow.

flowStatusMessage?: string | null

[src]

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

kmsArn?: string | null

[src]

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.

lastRunExecutionDetails?: ExecutionDetails | null

[src]

Describes the details of the most recent flow run.

lastRunMetadataCatalogDetails?: MetadataCatalogDetail[] | null

[src]

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

lastUpdatedAt?: Date | number | null

[src]

Specifies when the flow was last updated.

lastUpdatedBy?: string | null

[src]

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

metadataCatalogConfig?: MetadataCatalogConfig | null

[src]

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.

schemaVersion?: number | null

[src]

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

sourceFlowConfig?: SourceFlowConfig | null

[src]

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

tags?: {

[key: string]: string | null | undefined;

} | null

[src]

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

tasks?: Task[] | null

[src]

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

triggerConfig?: TriggerConfig | null

[src]

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