Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AppFlow.DescribeFlow

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides a description of the specified flow.

Synopsis

data DescribeFlow = DescribeFlow' {
- flowName :: Text
}
newDescribeFlow :: Text -> DescribeFlow
describeFlow_flowName :: Lens' DescribeFlow Text
data DescribeFlowResponse = DescribeFlowResponse' {
- createdAt :: Maybe POSIX
- createdBy :: Maybe Text
- description :: Maybe Text
- destinationFlowConfigList :: Maybe [DestinationFlowConfig]
- flowArn :: Maybe Text
- flowName :: Maybe Text
- flowStatus :: Maybe FlowStatus
- flowStatusMessage :: Maybe Text
- kmsArn :: Maybe Text
- lastRunExecutionDetails :: Maybe ExecutionDetails
- lastRunMetadataCatalogDetails :: Maybe [MetadataCatalogDetail]
- lastUpdatedAt :: Maybe POSIX
- lastUpdatedBy :: Maybe Text
- metadataCatalogConfig :: Maybe MetadataCatalogConfig
- schemaVersion :: Maybe Integer
- sourceFlowConfig :: Maybe SourceFlowConfig
- tags :: Maybe (HashMap Text Text)
- tasks :: Maybe [Task]
- triggerConfig :: Maybe TriggerConfig
- httpStatus :: Int
}
newDescribeFlowResponse :: Int -> DescribeFlowResponse
describeFlowResponse_createdAt :: Lens' DescribeFlowResponse (Maybe UTCTime)
describeFlowResponse_createdBy :: Lens' DescribeFlowResponse (Maybe Text)
describeFlowResponse_description :: Lens' DescribeFlowResponse (Maybe Text)
describeFlowResponse_destinationFlowConfigList :: Lens' DescribeFlowResponse (Maybe [DestinationFlowConfig])
describeFlowResponse_flowArn :: Lens' DescribeFlowResponse (Maybe Text)
describeFlowResponse_flowName :: Lens' DescribeFlowResponse (Maybe Text)
describeFlowResponse_flowStatus :: Lens' DescribeFlowResponse (Maybe FlowStatus)
describeFlowResponse_flowStatusMessage :: Lens' DescribeFlowResponse (Maybe Text)
describeFlowResponse_kmsArn :: Lens' DescribeFlowResponse (Maybe Text)
describeFlowResponse_lastRunExecutionDetails :: Lens' DescribeFlowResponse (Maybe ExecutionDetails)
describeFlowResponse_lastRunMetadataCatalogDetails :: Lens' DescribeFlowResponse (Maybe [MetadataCatalogDetail])
describeFlowResponse_lastUpdatedAt :: Lens' DescribeFlowResponse (Maybe UTCTime)
describeFlowResponse_lastUpdatedBy :: Lens' DescribeFlowResponse (Maybe Text)
describeFlowResponse_metadataCatalogConfig :: Lens' DescribeFlowResponse (Maybe MetadataCatalogConfig)
describeFlowResponse_schemaVersion :: Lens' DescribeFlowResponse (Maybe Integer)
describeFlowResponse_sourceFlowConfig :: Lens' DescribeFlowResponse (Maybe SourceFlowConfig)
describeFlowResponse_tags :: Lens' DescribeFlowResponse (Maybe (HashMap Text Text))
describeFlowResponse_tasks :: Lens' DescribeFlowResponse (Maybe [Task])
describeFlowResponse_triggerConfig :: Lens' DescribeFlowResponse (Maybe TriggerConfig)
describeFlowResponse_httpStatus :: Lens' DescribeFlowResponse Int

Creating a Request

data DescribeFlow Source #

See: newDescribeFlow smart constructor.

Constructors

DescribeFlow'
Fields flowName :: Text The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Instances

Instances details

ToJSON DescribeFlow Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow Methods toJSON :: DescribeFlow -> Value # toEncoding :: DescribeFlow -> Encoding # toJSONList :: [DescribeFlow] -> Value # toEncodingList :: [DescribeFlow] -> Encoding #
ToHeaders DescribeFlow Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow Methods toHeaders :: DescribeFlow -> [Header] #
ToPath DescribeFlow Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow Methods toPath :: DescribeFlow -> ByteString #
ToQuery DescribeFlow Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow Methods toQuery :: DescribeFlow -> QueryString #
AWSRequest DescribeFlow Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow Associated Types type AWSResponse DescribeFlow # Methods request :: (Service -> Service) -> DescribeFlow -> Request DescribeFlow # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeFlow -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeFlow))) #
Generic DescribeFlow Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow Associated Types type Rep DescribeFlow :: Type -> Type # Methods from :: DescribeFlow -> Rep DescribeFlow x # to :: Rep DescribeFlow x -> DescribeFlow #
Read DescribeFlow Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow Methods readsPrec :: Int -> ReadS DescribeFlow # readList :: ReadS [DescribeFlow] # readPrec :: ReadPrec DescribeFlow # readListPrec :: ReadPrec [DescribeFlow] #
Show DescribeFlow Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow Methods showsPrec :: Int -> DescribeFlow -> ShowS # show :: DescribeFlow -> String # showList :: [DescribeFlow] -> ShowS #
NFData DescribeFlow Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow Methods rnf :: DescribeFlow -> () #
Eq DescribeFlow Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow Methods (==) :: DescribeFlow -> DescribeFlow -> Bool # (/=) :: DescribeFlow -> DescribeFlow -> Bool #
Hashable DescribeFlow Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow Methods hashWithSalt :: Int -> DescribeFlow -> Int # hash :: DescribeFlow -> Int #
type AWSResponse DescribeFlow Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow type AWSResponse DescribeFlow = DescribeFlowResponse
type Rep DescribeFlow Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow type Rep DescribeFlow = D1 ('MetaData "DescribeFlow" "Amazonka.AppFlow.DescribeFlow" "amazonka-appflow-2.0-3aJWKTszi6ZKDtrkFSqVAB" 'False) (C1 ('MetaCons "DescribeFlow'" 'PrefixI 'True) (S1 ('MetaSel ('Just "flowName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeFlow Source #

Arguments

:: Text	`DescribeFlow`
-> DescribeFlow

Create a value of DescribeFlow with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

Request Lenses

describeFlow_flowName :: Lens' DescribeFlow Text Source #

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

Destructuring the Response

data DescribeFlowResponse Source #

See: newDescribeFlowResponse smart constructor.

Constructors

DescribeFlowResponse'

Fields

createdAt :: Maybe POSIX
Specifies when the flow was created.
createdBy :: Maybe Text
The ARN of the user who created the flow.
description :: Maybe Text
A description of the flow.
destinationFlowConfigList :: Maybe [DestinationFlowConfig]
The configuration that controls how Amazon AppFlow transfers data to the destination connector.
flowArn :: Maybe Text
The flow's Amazon Resource Name (ARN).
flowName :: Maybe Text
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
flowStatus :: Maybe FlowStatus
Indicates the current status of the flow.
flowStatusMessage :: Maybe Text
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 :: Maybe Text
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 :: Maybe ExecutionDetails
Describes the details of the most recent flow run.
lastRunMetadataCatalogDetails :: Maybe [MetadataCatalogDetail]
Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.
lastUpdatedAt :: Maybe POSIX
Specifies when the flow was last updated.
lastUpdatedBy :: Maybe Text
Specifies the user name of the account that performed the most recent update.
metadataCatalogConfig :: Maybe 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.
schemaVersion :: Maybe Integer
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 :: Maybe SourceFlowConfig
The configuration that controls how Amazon AppFlow retrieves data from the source connector.
tags :: Maybe (HashMap Text Text)
The tags used to organize, track, or control access for your flow.
tasks :: Maybe [Task]
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
triggerConfig :: Maybe TriggerConfig
The trigger settings that determine how and when the flow runs.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeFlowResponse Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow Associated Types type Rep DescribeFlowResponse :: Type -> Type # Methods from :: DescribeFlowResponse -> Rep DescribeFlowResponse x # to :: Rep DescribeFlowResponse x -> DescribeFlowResponse #
Read DescribeFlowResponse Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow Methods readsPrec :: Int -> ReadS DescribeFlowResponse # readList :: ReadS [DescribeFlowResponse] # readPrec :: ReadPrec DescribeFlowResponse # readListPrec :: ReadPrec [DescribeFlowResponse] #
Show DescribeFlowResponse Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow Methods showsPrec :: Int -> DescribeFlowResponse -> ShowS # show :: DescribeFlowResponse -> String # showList :: [DescribeFlowResponse] -> ShowS #
NFData DescribeFlowResponse Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow Methods rnf :: DescribeFlowResponse -> () #
Eq DescribeFlowResponse Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow Methods (==) :: DescribeFlowResponse -> DescribeFlowResponse -> Bool # (/=) :: DescribeFlowResponse -> DescribeFlowResponse -> Bool #
type Rep DescribeFlowResponse Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow type Rep DescribeFlowResponse = D1 ('MetaData "DescribeFlowResponse" "Amazonka.AppFlow.DescribeFlow" "amazonka-appflow-2.0-3aJWKTszi6ZKDtrkFSqVAB" 'False) (C1 ('MetaCons "DescribeFlowResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "createdBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "destinationFlowConfigList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DestinationFlowConfig])) :: S1 ('MetaSel ('Just "flowArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "flowName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "flowStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FlowStatus))) :: (S1 ('MetaSel ('Just "flowStatusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "kmsArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "lastRunExecutionDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionDetails)))))) :: (((S1 ('MetaSel ('Just "lastRunMetadataCatalogDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetadataCatalogDetail])) :: S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "lastUpdatedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "metadataCatalogConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MetadataCatalogConfig)) :: S1 ('MetaSel ('Just "schemaVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))) :: ((S1 ('MetaSel ('Just "sourceFlowConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceFlowConfig)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "tasks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Task])) :: (S1 ('MetaSel ('Just "triggerConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TriggerConfig)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newDescribeFlowResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeFlowResponse'`
-> DescribeFlowResponse

Create a value of DescribeFlowResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeFlowResponse, describeFlowResponse_createdAt - Specifies when the flow was created.

DescribeFlowResponse, describeFlowResponse_createdBy - The ARN of the user who created the flow.

DescribeFlowResponse, describeFlowResponse_description - A description of the flow.

$sel:destinationFlowConfigList:DescribeFlowResponse', describeFlowResponse_destinationFlowConfigList - The configuration that controls how Amazon AppFlow transfers data to the destination connector.

DescribeFlowResponse, describeFlowResponse_flowArn - The flow's Amazon Resource Name (ARN).

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

DescribeFlowResponse, describeFlowResponse_flowStatus - Indicates the current status of the flow.

$sel:flowStatusMessage:DescribeFlowResponse', describeFlowResponse_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.

$sel:kmsArn:DescribeFlowResponse', describeFlowResponse_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.

DescribeFlowResponse, describeFlowResponse_lastRunExecutionDetails - Describes the details of the most recent flow run.

$sel:lastRunMetadataCatalogDetails:DescribeFlowResponse', describeFlowResponse_lastRunMetadataCatalogDetails - Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.

DescribeFlowResponse, describeFlowResponse_lastUpdatedAt - Specifies when the flow was last updated.

DescribeFlowResponse, describeFlowResponse_lastUpdatedBy - Specifies the user name of the account that performed the most recent update.

$sel:metadataCatalogConfig:DescribeFlowResponse', describeFlowResponse_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.

$sel:schemaVersion:DescribeFlowResponse', describeFlowResponse_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

$sel:sourceFlowConfig:DescribeFlowResponse', describeFlowResponse_sourceFlowConfig - The configuration that controls how Amazon AppFlow retrieves data from the source connector.

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

$sel:tasks:DescribeFlowResponse', describeFlowResponse_tasks - A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

$sel:triggerConfig:DescribeFlowResponse', describeFlowResponse_triggerConfig - The trigger settings that determine how and when the flow runs.

$sel:httpStatus:DescribeFlowResponse', describeFlowResponse_httpStatus - The response's http status code.

Response Lenses

describeFlowResponse_createdAt :: Lens' DescribeFlowResponse (Maybe UTCTime) Source #

Specifies when the flow was created.

describeFlowResponse_createdBy :: Lens' DescribeFlowResponse (Maybe Text) Source #

The ARN of the user who created the flow.

describeFlowResponse_description :: Lens' DescribeFlowResponse (Maybe Text) Source #

A description of the flow.

describeFlowResponse_destinationFlowConfigList :: Lens' DescribeFlowResponse (Maybe [DestinationFlowConfig]) Source #

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

describeFlowResponse_flowArn :: Lens' DescribeFlowResponse (Maybe Text) Source #

The flow's Amazon Resource Name (ARN).

describeFlowResponse_flowName :: Lens' DescribeFlowResponse (Maybe Text) Source #

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

describeFlowResponse_flowStatus :: Lens' DescribeFlowResponse (Maybe FlowStatus) Source #

Indicates the current status of the flow.

describeFlowResponse_flowStatusMessage :: Lens' DescribeFlowResponse (Maybe Text) Source #

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

describeFlowResponse_kmsArn :: Lens' DescribeFlowResponse (Maybe Text) Source #

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.

describeFlowResponse_lastRunExecutionDetails :: Lens' DescribeFlowResponse (Maybe ExecutionDetails) Source #

Describes the details of the most recent flow run.

describeFlowResponse_lastRunMetadataCatalogDetails :: Lens' DescribeFlowResponse (Maybe [MetadataCatalogDetail]) Source #

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

describeFlowResponse_lastUpdatedAt :: Lens' DescribeFlowResponse (Maybe UTCTime) Source #

Specifies when the flow was last updated.

describeFlowResponse_lastUpdatedBy :: Lens' DescribeFlowResponse (Maybe Text) Source #

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

describeFlowResponse_metadataCatalogConfig :: Lens' DescribeFlowResponse (Maybe MetadataCatalogConfig) Source #

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.

describeFlowResponse_schemaVersion :: Lens' DescribeFlowResponse (Maybe Integer) Source #

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

describeFlowResponse_sourceFlowConfig :: Lens' DescribeFlowResponse (Maybe SourceFlowConfig) Source #

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

describeFlowResponse_tags :: Lens' DescribeFlowResponse (Maybe (HashMap Text Text)) Source #

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

describeFlowResponse_tasks :: Lens' DescribeFlowResponse (Maybe [Task]) Source #

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

describeFlowResponse_triggerConfig :: Lens' DescribeFlowResponse (Maybe TriggerConfig) Source #

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

describeFlowResponse_httpStatus :: Lens' DescribeFlowResponse Int Source #

The response's http status code.