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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deactivates the existing flow. For on-demand flows, this operation returns an unsupportedOperationException error message. For schedule and event-triggered flows, this operation deactivates the flow.

Synopsis

data StopFlow = StopFlow' {
- flowName :: Text
}
newStopFlow :: Text -> StopFlow
stopFlow_flowName :: Lens' StopFlow Text
data StopFlowResponse = StopFlowResponse' {
- flowArn :: Maybe Text
- flowStatus :: Maybe FlowStatus
- httpStatus :: Int
}
newStopFlowResponse :: Int -> StopFlowResponse
stopFlowResponse_flowArn :: Lens' StopFlowResponse (Maybe Text)
stopFlowResponse_flowStatus :: Lens' StopFlowResponse (Maybe FlowStatus)
stopFlowResponse_httpStatus :: Lens' StopFlowResponse Int

Creating a Request

data StopFlow Source #

See: newStopFlow smart constructor.

Constructors

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

Instances

Instances details

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

newStopFlow Source #

Arguments

:: Text	`StopFlow`
-> StopFlow

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

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

Request Lenses

stopFlow_flowName :: Lens' StopFlow Text Source #

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

Destructuring the Response

data StopFlowResponse Source #

See: newStopFlowResponse smart constructor.

Constructors

StopFlowResponse'
Fields flowArn :: Maybe Text The flow's Amazon Resource Name (ARN). flowStatus :: Maybe FlowStatus Indicates the current status of the flow. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newStopFlowResponse Source #

Arguments

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

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

StopFlowResponse, stopFlowResponse_flowArn - The flow's Amazon Resource Name (ARN).

StopFlowResponse, stopFlowResponse_flowStatus - Indicates the current status of the flow.

$sel:httpStatus:StopFlowResponse', stopFlowResponse_httpStatus - The response's http status code.

Response Lenses

stopFlowResponse_flowArn :: Lens' StopFlowResponse (Maybe Text) Source #

The flow's Amazon Resource Name (ARN).

stopFlowResponse_flowStatus :: Lens' StopFlowResponse (Maybe FlowStatus) Source #

Indicates the current status of the flow.

stopFlowResponse_httpStatus :: Lens' StopFlowResponse Int Source #

The response's http status code.