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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Enables your application to delete an existing flow. Before deleting the flow, Amazon AppFlow validates the request by checking the flow configuration and status. You can delete flows one at a time.

Synopsis

data DeleteFlow = DeleteFlow' {
- forceDelete :: Maybe Bool
- flowName :: Text
}
newDeleteFlow :: Text -> DeleteFlow
deleteFlow_forceDelete :: Lens' DeleteFlow (Maybe Bool)
deleteFlow_flowName :: Lens' DeleteFlow Text
data DeleteFlowResponse = DeleteFlowResponse' {
- httpStatus :: Int
}
newDeleteFlowResponse :: Int -> DeleteFlowResponse
deleteFlowResponse_httpStatus :: Lens' DeleteFlowResponse Int

Creating a Request

data DeleteFlow Source #

See: newDeleteFlow smart constructor.

Constructors

DeleteFlow'
Fields forceDelete :: Maybe Bool Indicates whether Amazon AppFlow should delete the flow, even if it is currently in use. flowName :: Text The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Instances

Instances details

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

newDeleteFlow Source #

Arguments

:: Text	`DeleteFlow`
-> DeleteFlow

Create a value of DeleteFlow 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:forceDelete:DeleteFlow', deleteFlow_forceDelete - Indicates whether Amazon AppFlow should delete the flow, even if it is currently in use.

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

Request Lenses

deleteFlow_forceDelete :: Lens' DeleteFlow (Maybe Bool) Source #

Indicates whether Amazon AppFlow should delete the flow, even if it is currently in use.

deleteFlow_flowName :: Lens' DeleteFlow Text Source #

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

Destructuring the Response

data DeleteFlowResponse Source #

See: newDeleteFlowResponse smart constructor.

Constructors

DeleteFlowResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDeleteFlowResponse Source #

Arguments

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

Create a value of DeleteFlowResponse 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:httpStatus:DeleteFlowResponse', deleteFlowResponse_httpStatus - The response's http status code.

Response Lenses

deleteFlowResponse_httpStatus :: Lens' DeleteFlowResponse Int Source #

The response's http status code.