libZSservicesZSamazonka-appflowZSamazonka-appflow
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AppFlow.StartFlow

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

Read StartFlow Source # 
Instance details

Defined in Amazonka.AppFlow.StartFlow

Show StartFlow Source # 
Instance details

Defined in Amazonka.AppFlow.StartFlow

Generic StartFlow Source # 
Instance details

Defined in Amazonka.AppFlow.StartFlow

Associated Types

type Rep StartFlow :: Type -> Type #

NFData StartFlow Source # 
Instance details

Defined in Amazonka.AppFlow.StartFlow

Methods

rnf :: StartFlow -> () #

Hashable StartFlow Source # 
Instance details

Defined in Amazonka.AppFlow.StartFlow

ToJSON StartFlow Source # 
Instance details

Defined in Amazonka.AppFlow.StartFlow

AWSRequest StartFlow Source # 
Instance details

Defined in Amazonka.AppFlow.StartFlow

Associated Types

type 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

ToQuery StartFlow Source # 
Instance details

Defined in Amazonka.AppFlow.StartFlow

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

newStartFlow Source #

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

Instances

Instances details
Eq StartFlowResponse Source # 
Instance details

Defined in Amazonka.AppFlow.StartFlow

Read StartFlowResponse Source # 
Instance details

Defined in Amazonka.AppFlow.StartFlow

Show StartFlowResponse Source # 
Instance details

Defined in Amazonka.AppFlow.StartFlow

Generic StartFlowResponse Source # 
Instance details

Defined in Amazonka.AppFlow.StartFlow

Associated Types

type Rep StartFlowResponse :: Type -> Type #

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 #

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.