Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

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' {
- lastUpdatedBy :: Maybe Text
- flowArn :: Maybe Text
- lastUpdatedAt :: Maybe POSIX
- createdAt :: Maybe POSIX
- createdBy :: Maybe Text
- tasks :: Maybe [Task]
- triggerConfig :: Maybe TriggerConfig
- flowName :: Maybe Text
- sourceFlowConfig :: Maybe SourceFlowConfig
- flowStatusMessage :: Maybe Text
- kmsArn :: Maybe Text
- lastRunExecutionDetails :: Maybe ExecutionDetails
- flowStatus :: Maybe FlowStatus
- destinationFlowConfigList :: Maybe [DestinationFlowConfig]
- description :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
}
newDescribeFlowResponse :: Int -> DescribeFlowResponse
describeFlowResponse_lastUpdatedBy :: Lens' DescribeFlowResponse (Maybe Text)
describeFlowResponse_flowArn :: Lens' DescribeFlowResponse (Maybe Text)
describeFlowResponse_lastUpdatedAt :: Lens' DescribeFlowResponse (Maybe UTCTime)
describeFlowResponse_createdAt :: Lens' DescribeFlowResponse (Maybe UTCTime)
describeFlowResponse_createdBy :: Lens' DescribeFlowResponse (Maybe Text)
describeFlowResponse_tasks :: Lens' DescribeFlowResponse (Maybe [Task])
describeFlowResponse_triggerConfig :: Lens' DescribeFlowResponse (Maybe TriggerConfig)
describeFlowResponse_flowName :: Lens' DescribeFlowResponse (Maybe Text)
describeFlowResponse_sourceFlowConfig :: Lens' DescribeFlowResponse (Maybe SourceFlowConfig)
describeFlowResponse_flowStatusMessage :: Lens' DescribeFlowResponse (Maybe Text)
describeFlowResponse_kmsArn :: Lens' DescribeFlowResponse (Maybe Text)
describeFlowResponse_lastRunExecutionDetails :: Lens' DescribeFlowResponse (Maybe ExecutionDetails)
describeFlowResponse_flowStatus :: Lens' DescribeFlowResponse (Maybe FlowStatus)
describeFlowResponse_destinationFlowConfigList :: Lens' DescribeFlowResponse (Maybe [DestinationFlowConfig])
describeFlowResponse_description :: Lens' DescribeFlowResponse (Maybe Text)
describeFlowResponse_tags :: Lens' DescribeFlowResponse (Maybe (HashMap Text Text))
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

Eq DescribeFlow Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow Methods (==) :: DescribeFlow -> DescribeFlow -> Bool # (/=) :: DescribeFlow -> DescribeFlow -> Bool #
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 #
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 #
NFData DescribeFlow Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow Methods rnf :: DescribeFlow -> () #
Hashable DescribeFlow Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow Methods hashWithSalt :: Int -> DescribeFlow -> Int # hash :: DescribeFlow -> Int #
ToJSON DescribeFlow Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow Methods toJSON :: DescribeFlow -> Value # toEncoding :: DescribeFlow -> Encoding # toJSONList :: [DescribeFlow] -> Value # toEncodingList :: [DescribeFlow] -> Encoding #
AWSRequest DescribeFlow Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow Associated Types type AWSResponse DescribeFlow # Methods request :: DescribeFlow -> Request DescribeFlow # response :: MonadResource m => Logger -> Service -> Proxy DescribeFlow -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeFlow))) #
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 #
type Rep DescribeFlow Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow type Rep DescribeFlow = D1 ('MetaData "DescribeFlow" "Amazonka.AppFlow.DescribeFlow" "libZSservicesZSamazonka-appflowZSamazonka-appflow" 'False) (C1 ('MetaCons "DescribeFlow'" 'PrefixI 'True) (S1 ('MetaSel ('Just "flowName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeFlow Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow type AWSResponse DescribeFlow = DescribeFlowResponse

newDescribeFlow Source #

Arguments

:: Text	`$sel:flowName: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:

$sel:flowName: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

lastUpdatedBy :: Maybe Text
Specifies the user name of the account that performed the most recent update.
flowArn :: Maybe Text
The flow's Amazon Resource Name (ARN).
lastUpdatedAt :: Maybe POSIX
Specifies when the flow was last updated.
createdAt :: Maybe POSIX
Specifies when the flow was created.
createdBy :: Maybe Text
The ARN of the user who created the 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.
flowName :: Maybe Text
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
sourceFlowConfig :: Maybe SourceFlowConfig
The configuration that controls how Amazon AppFlow retrieves data from the source connector.
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.
flowStatus :: Maybe FlowStatus
Indicates the current status of the flow.
destinationFlowConfigList :: Maybe [DestinationFlowConfig]
The configuration that controls how Amazon AppFlow transfers data to the destination connector.
description :: Maybe Text
A description of the flow.
tags :: Maybe (HashMap Text Text)
The tags used to organize, track, or control access for your flow.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeFlowResponse Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow Methods (==) :: DescribeFlowResponse -> DescribeFlowResponse -> Bool # (/=) :: DescribeFlowResponse -> DescribeFlowResponse -> Bool #
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 #
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 #
NFData DescribeFlowResponse Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow Methods rnf :: DescribeFlowResponse -> () #
type Rep DescribeFlowResponse Source #
Instance details Defined in Amazonka.AppFlow.DescribeFlow type Rep DescribeFlowResponse = D1 ('MetaData "DescribeFlowResponse" "Amazonka.AppFlow.DescribeFlow" "libZSservicesZSamazonka-appflowZSamazonka-appflow" 'False) (C1 ('MetaCons "DescribeFlowResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "lastUpdatedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "flowArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "createdBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tasks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Task]))) :: (S1 ('MetaSel ('Just "triggerConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TriggerConfig)) :: S1 ('MetaSel ('Just "flowName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "sourceFlowConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceFlowConfig)) :: 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 "flowStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FlowStatus)) :: S1 ('MetaSel ('Just "destinationFlowConfigList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DestinationFlowConfig]))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: 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:

$sel:lastUpdatedBy:DescribeFlowResponse', describeFlowResponse_lastUpdatedBy - Specifies the user name of the account that performed the most recent update.

$sel:flowArn:DescribeFlowResponse', describeFlowResponse_flowArn - The flow's Amazon Resource Name (ARN).

$sel:lastUpdatedAt:DescribeFlowResponse', describeFlowResponse_lastUpdatedAt - Specifies when the flow was last updated.

$sel:createdAt:DescribeFlowResponse', describeFlowResponse_createdAt - Specifies when the flow was created.

$sel:createdBy:DescribeFlowResponse', describeFlowResponse_createdBy - The ARN of the user who created the 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:flowName:DescribeFlow', describeFlowResponse_flowName - The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

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

$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.

$sel:lastRunExecutionDetails:DescribeFlowResponse', describeFlowResponse_lastRunExecutionDetails - Describes the details of the most recent flow run.

$sel:flowStatus:DescribeFlowResponse', describeFlowResponse_flowStatus - Indicates the current status of the flow.

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

$sel:description:DescribeFlowResponse', describeFlowResponse_description - A description of the flow.

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

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

Response Lenses

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

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

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

The flow's Amazon Resource Name (ARN).

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

Specifies when the flow was last updated.

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_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_flowName :: Lens' DescribeFlowResponse (Maybe Text) Source #

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

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

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

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_flowStatus :: Lens' DescribeFlowResponse (Maybe FlowStatus) Source #

Indicates the current status of the flow.

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

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

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

A description of the flow.

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

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

describeFlowResponse_httpStatus :: Lens' DescribeFlowResponse Int Source #

The response's http status code.