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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an existing flow.

Synopsis

data UpdateFlow = UpdateFlow' {
- description :: Maybe Text
- metadataCatalogConfig :: Maybe MetadataCatalogConfig
- flowName :: Text
- triggerConfig :: TriggerConfig
- sourceFlowConfig :: SourceFlowConfig
- destinationFlowConfigList :: [DestinationFlowConfig]
- tasks :: [Task]
}
newUpdateFlow :: Text -> TriggerConfig -> SourceFlowConfig -> UpdateFlow
updateFlow_description :: Lens' UpdateFlow (Maybe Text)
updateFlow_metadataCatalogConfig :: Lens' UpdateFlow (Maybe MetadataCatalogConfig)
updateFlow_flowName :: Lens' UpdateFlow Text
updateFlow_triggerConfig :: Lens' UpdateFlow TriggerConfig
updateFlow_sourceFlowConfig :: Lens' UpdateFlow SourceFlowConfig
updateFlow_destinationFlowConfigList :: Lens' UpdateFlow [DestinationFlowConfig]
updateFlow_tasks :: Lens' UpdateFlow [Task]
data UpdateFlowResponse = UpdateFlowResponse' {
- flowStatus :: Maybe FlowStatus
- httpStatus :: Int
}
newUpdateFlowResponse :: Int -> UpdateFlowResponse
updateFlowResponse_flowStatus :: Lens' UpdateFlowResponse (Maybe FlowStatus)
updateFlowResponse_httpStatus :: Lens' UpdateFlowResponse Int

Creating a Request

data UpdateFlow Source #

See: newUpdateFlow smart constructor.

Constructors

UpdateFlow'

Fields

description :: Maybe Text
A description of the flow.
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.
flowName :: Text
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
triggerConfig :: TriggerConfig
The trigger settings that determine how and when the flow runs.
sourceFlowConfig :: SourceFlowConfig
destinationFlowConfigList :: [DestinationFlowConfig]
The configuration that controls how Amazon AppFlow transfers data to the destination connector.
tasks :: [Task]
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

Instances

Instances details

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

newUpdateFlow Source #

Arguments

:: Text	`UpdateFlow`
-> TriggerConfig	`$sel:triggerConfig:UpdateFlow'`
-> SourceFlowConfig	`$sel:sourceFlowConfig:UpdateFlow'`
-> UpdateFlow

Create a value of UpdateFlow 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:

UpdateFlow, updateFlow_description - A description of the flow.

$sel:metadataCatalogConfig:UpdateFlow', updateFlow_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.

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

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

$sel:sourceFlowConfig:UpdateFlow', updateFlow_sourceFlowConfig - Undocumented member.

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

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

Request Lenses

updateFlow_description :: Lens' UpdateFlow (Maybe Text) Source #

A description of the flow.

updateFlow_metadataCatalogConfig :: Lens' UpdateFlow (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.

updateFlow_flowName :: Lens' UpdateFlow Text Source #

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

updateFlow_triggerConfig :: Lens' UpdateFlow TriggerConfig Source #

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

updateFlow_sourceFlowConfig :: Lens' UpdateFlow SourceFlowConfig Source #

Undocumented member.

updateFlow_destinationFlowConfigList :: Lens' UpdateFlow [DestinationFlowConfig] Source #

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

updateFlow_tasks :: Lens' UpdateFlow [Task] Source #

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

Destructuring the Response

data UpdateFlowResponse Source #

See: newUpdateFlowResponse smart constructor.

Constructors

UpdateFlowResponse'
Fields flowStatus :: Maybe FlowStatus Indicates the current status of the flow. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateFlowResponse Source #
Instance details Defined in Amazonka.AppFlow.UpdateFlow Associated Types type Rep UpdateFlowResponse :: Type -> Type # Methods from :: UpdateFlowResponse -> Rep UpdateFlowResponse x # to :: Rep UpdateFlowResponse x -> UpdateFlowResponse #
Read UpdateFlowResponse Source #
Instance details Defined in Amazonka.AppFlow.UpdateFlow Methods readsPrec :: Int -> ReadS UpdateFlowResponse # readList :: ReadS [UpdateFlowResponse] # readPrec :: ReadPrec UpdateFlowResponse # readListPrec :: ReadPrec [UpdateFlowResponse] #
Show UpdateFlowResponse Source #
Instance details Defined in Amazonka.AppFlow.UpdateFlow Methods showsPrec :: Int -> UpdateFlowResponse -> ShowS # show :: UpdateFlowResponse -> String # showList :: [UpdateFlowResponse] -> ShowS #
NFData UpdateFlowResponse Source #
Instance details Defined in Amazonka.AppFlow.UpdateFlow Methods rnf :: UpdateFlowResponse -> () #
Eq UpdateFlowResponse Source #
Instance details Defined in Amazonka.AppFlow.UpdateFlow Methods (==) :: UpdateFlowResponse -> UpdateFlowResponse -> Bool # (/=) :: UpdateFlowResponse -> UpdateFlowResponse -> Bool #
type Rep UpdateFlowResponse Source #
Instance details Defined in Amazonka.AppFlow.UpdateFlow type Rep UpdateFlowResponse = D1 ('MetaData "UpdateFlowResponse" "Amazonka.AppFlow.UpdateFlow" "amazonka-appflow-2.0-3aJWKTszi6ZKDtrkFSqVAB" 'False) (C1 ('MetaCons "UpdateFlowResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "flowStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FlowStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateFlowResponse Source #

Arguments

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

Create a value of UpdateFlowResponse 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:

UpdateFlowResponse, updateFlowResponse_flowStatus - Indicates the current status of the flow.

$sel:httpStatus:UpdateFlowResponse', updateFlowResponse_httpStatus - The response's http status code.

Response Lenses

updateFlowResponse_flowStatus :: Lens' UpdateFlowResponse (Maybe FlowStatus) Source #

Indicates the current status of the flow.

updateFlowResponse_httpStatus :: Lens' UpdateFlowResponse Int Source #

The response's http status code.