Amazonka.AppFlow.StopFlow

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.

Creating a Request

data StopFlow

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

ToJSON StopFlow

Defined in Amazonka.AppFlow.StopFlow

Methods

toJSON :: StopFlow -> Value

toEncoding :: StopFlow -> Encoding

toJSONList :: [StopFlow] -> Value

toEncodingList :: [StopFlow] -> Encoding

ToHeaders StopFlow

Defined in Amazonka.AppFlow.StopFlow

Methods

toHeaders :: StopFlow -> [Header]

ToPath StopFlow

Defined in Amazonka.AppFlow.StopFlow

Methods

toPath :: StopFlow -> ByteString

ToQuery StopFlow

Defined in Amazonka.AppFlow.StopFlow

Methods

toQuery :: StopFlow -> QueryString

AWSRequest StopFlow

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

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

Defined in Amazonka.AppFlow.StopFlow

Methods

readsPrec :: Int -> ReadS StopFlow

readList :: ReadS [StopFlow]

readPrec :: ReadPrec StopFlow

readListPrec :: ReadPrec [StopFlow]

Show StopFlow

Defined in Amazonka.AppFlow.StopFlow

Methods

showsPrec :: Int -> StopFlow -> ShowS

show :: StopFlow -> String

showList :: [StopFlow] -> ShowS

NFData StopFlow

Defined in Amazonka.AppFlow.StopFlow

Methods

rnf :: StopFlow -> ()

Eq StopFlow

Defined in Amazonka.AppFlow.StopFlow

Methods

(==) :: StopFlow -> StopFlow -> Bool

(/=) :: StopFlow -> StopFlow -> Bool

Hashable StopFlow

Defined in Amazonka.AppFlow.StopFlow

Methods

hashWithSalt :: Int -> StopFlow -> Int

hash :: StopFlow -> Int

type AWSResponse StopFlow

Defined in Amazonka.AppFlow.StopFlow

type AWSResponse StopFlow = StopFlowResponse

type Rep StopFlow

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

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

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

Destructuring the Response

data StopFlowResponse

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

Generic StopFlowResponse

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

Defined in Amazonka.AppFlow.StopFlow

Methods

readsPrec :: Int -> ReadS StopFlowResponse

readList :: ReadS [StopFlowResponse]

readPrec :: ReadPrec StopFlowResponse

readListPrec :: ReadPrec [StopFlowResponse]

Show StopFlowResponse

Defined in Amazonka.AppFlow.StopFlow

Methods

showsPrec :: Int -> StopFlowResponse -> ShowS

show :: StopFlowResponse -> String

showList :: [StopFlowResponse] -> ShowS

NFData StopFlowResponse

Defined in Amazonka.AppFlow.StopFlow

Methods

rnf :: StopFlowResponse -> ()

Eq StopFlowResponse

Defined in Amazonka.AppFlow.StopFlow

Methods

(==) :: StopFlowResponse -> StopFlowResponse -> Bool

(/=) :: StopFlowResponse -> StopFlowResponse -> Bool

type Rep StopFlowResponse

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

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)

The flow's Amazon Resource Name (ARN).

stopFlowResponse_flowStatus :: Lens' StopFlowResponse (Maybe FlowStatus)

Indicates the current status of the flow.

stopFlowResponse_httpStatus :: Lens' StopFlowResponse Int

The response's http status code.