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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Activates an existing flow. For on-demand flows, this operation runs the flow immediately. For schedule and event-triggered flows, this operation activates the flow.

Synopsis

Creating a Request

data StartFlow Source #

See: newStartFlow smart constructor.

Constructors

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

Instances

Instances details

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

newStartFlow Source #

Arguments

:: Text	`$sel:flowName:StartFlow'`
-> StartFlow

Create a value of StartFlow 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:StartFlow', startFlow_flowName - The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Request Lenses

startFlow_flowName :: Lens' StartFlow Text Source #

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

Destructuring the Response

data StartFlowResponse Source #

See: newStartFlowResponse smart constructor.

Constructors

StartFlowResponse'
Fields executionId :: Maybe Text Returns the internal execution ID of an on-demand flow when the flow is started. For scheduled or event-triggered flows, this value is null. 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

Eq StartFlowResponse Source #
Instance details Defined in Amazonka.AppFlow.StartFlow Methods (==) :: StartFlowResponse -> StartFlowResponse -> Bool # (/=) :: StartFlowResponse -> StartFlowResponse -> Bool #
Read StartFlowResponse Source #
Instance details Defined in Amazonka.AppFlow.StartFlow Methods readsPrec :: Int -> ReadS StartFlowResponse # readList :: ReadS [StartFlowResponse] # readPrec :: ReadPrec StartFlowResponse # readListPrec :: ReadPrec [StartFlowResponse] #
Show StartFlowResponse Source #
Instance details Defined in Amazonka.AppFlow.StartFlow Methods showsPrec :: Int -> StartFlowResponse -> ShowS # show :: StartFlowResponse -> String # showList :: [StartFlowResponse] -> ShowS #
Generic StartFlowResponse Source #
Instance details Defined in Amazonka.AppFlow.StartFlow Associated Types type Rep StartFlowResponse :: Type -> Type # Methods from :: StartFlowResponse -> Rep StartFlowResponse x # to :: Rep StartFlowResponse x -> StartFlowResponse #
NFData StartFlowResponse Source #
Instance details Defined in Amazonka.AppFlow.StartFlow Methods rnf :: StartFlowResponse -> () #
type Rep StartFlowResponse Source #
Instance details Defined in Amazonka.AppFlow.StartFlow type Rep StartFlowResponse = D1 ('MetaData "StartFlowResponse" "Amazonka.AppFlow.StartFlow" "libZSservicesZSamazonka-appflowZSamazonka-appflow" 'False) (C1 ('MetaCons "StartFlowResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "executionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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))))

newStartFlowResponse Source #

Arguments

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

Create a value of StartFlowResponse 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:executionId:StartFlowResponse', startFlowResponse_executionId - Returns the internal execution ID of an on-demand flow when the flow is started. For scheduled or event-triggered flows, this value is null.

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

$sel:flowStatus:StartFlowResponse', startFlowResponse_flowStatus - Indicates the current status of the flow.

$sel:httpStatus:StartFlowResponse', startFlowResponse_httpStatus - The response's http status code.

Response Lenses

startFlowResponse_executionId :: Lens' StartFlowResponse (Maybe Text) Source #

Returns the internal execution ID of an on-demand flow when the flow is started. For scheduled or event-triggered flows, this value is null.

startFlowResponse_flowArn :: Lens' StartFlowResponse (Maybe Text) Source #

The flow's Amazon Resource Name (ARN).

startFlowResponse_flowStatus :: Lens' StartFlowResponse (Maybe FlowStatus) Source #

Indicates the current status of the flow.

startFlowResponse_httpStatus :: Lens' StartFlowResponse Int Source #

The response's http status code.