Amazonka.AppFlow.StartFlow

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.

Creating a Request

data StartFlow

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

ToJSON StartFlow

Defined in Amazonka.AppFlow.StartFlow

Methods

toJSON :: StartFlow -> Value

toEncoding :: StartFlow -> Encoding

toJSONList :: [StartFlow] -> Value

toEncodingList :: [StartFlow] -> Encoding

ToHeaders StartFlow

Defined in Amazonka.AppFlow.StartFlow

Methods

toHeaders :: StartFlow -> [Header]

ToPath StartFlow

Defined in Amazonka.AppFlow.StartFlow

Methods

toPath :: StartFlow -> ByteString

ToQuery StartFlow

Defined in Amazonka.AppFlow.StartFlow

Methods

toQuery :: StartFlow -> QueryString

AWSRequest StartFlow

Defined in Amazonka.AppFlow.StartFlow

Associated Types

type AWSResponse StartFlow

Methods

request :: (Service -> Service) -> StartFlow -> Request StartFlow

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartFlow -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartFlow)))

Generic StartFlow

Defined in Amazonka.AppFlow.StartFlow

Associated Types

type Rep StartFlow :: Type -> Type

Methods

from :: StartFlow -> Rep StartFlow x

to :: Rep StartFlow x -> StartFlow

Read StartFlow

Defined in Amazonka.AppFlow.StartFlow

Methods

readsPrec :: Int -> ReadS StartFlow

readList :: ReadS [StartFlow]

readPrec :: ReadPrec StartFlow

readListPrec :: ReadPrec [StartFlow]

Show StartFlow

Defined in Amazonka.AppFlow.StartFlow

Methods

showsPrec :: Int -> StartFlow -> ShowS

show :: StartFlow -> String

showList :: [StartFlow] -> ShowS

NFData StartFlow

Defined in Amazonka.AppFlow.StartFlow

Methods

rnf :: StartFlow -> ()

Eq StartFlow

Defined in Amazonka.AppFlow.StartFlow

Methods

(==) :: StartFlow -> StartFlow -> Bool

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

Hashable StartFlow

Defined in Amazonka.AppFlow.StartFlow

Methods

hashWithSalt :: Int -> StartFlow -> Int

hash :: StartFlow -> Int

type AWSResponse StartFlow

Defined in Amazonka.AppFlow.StartFlow

type AWSResponse StartFlow = StartFlowResponse

type Rep StartFlow

Defined in Amazonka.AppFlow.StartFlow

type Rep StartFlow = D1 ('MetaData "StartFlow" "Amazonka.AppFlow.StartFlow" "amazonka-appflow-2.0-3aJWKTszi6ZKDtrkFSqVAB" 'False) (C1 ('MetaCons "StartFlow'" 'PrefixI 'True) (S1 ('MetaSel ('Just "flowName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStartFlow

Arguments

:: Text

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:

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

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

Destructuring the Response

data StartFlowResponse

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

Generic StartFlowResponse

Defined in Amazonka.AppFlow.StartFlow

Associated Types

type Rep StartFlowResponse :: Type -> Type

Methods

from :: StartFlowResponse -> Rep StartFlowResponse x

to :: Rep StartFlowResponse x -> StartFlowResponse

Read StartFlowResponse

Defined in Amazonka.AppFlow.StartFlow

Methods

readsPrec :: Int -> ReadS StartFlowResponse

readList :: ReadS [StartFlowResponse]

readPrec :: ReadPrec StartFlowResponse

readListPrec :: ReadPrec [StartFlowResponse]

Show StartFlowResponse

Defined in Amazonka.AppFlow.StartFlow

Methods

showsPrec :: Int -> StartFlowResponse -> ShowS

show :: StartFlowResponse -> String

showList :: [StartFlowResponse] -> ShowS

NFData StartFlowResponse

Defined in Amazonka.AppFlow.StartFlow

Methods

rnf :: StartFlowResponse -> ()

Eq StartFlowResponse

Defined in Amazonka.AppFlow.StartFlow

Methods

(==) :: StartFlowResponse -> StartFlowResponse -> Bool

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

type Rep StartFlowResponse

Defined in Amazonka.AppFlow.StartFlow

type Rep StartFlowResponse = D1 ('MetaData "StartFlowResponse" "Amazonka.AppFlow.StartFlow" "amazonka-appflow-2.0-3aJWKTszi6ZKDtrkFSqVAB" '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

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:

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.

StartFlowResponse, startFlowResponse_flowArn - The flow's Amazon Resource Name (ARN).

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)

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)

The flow's Amazon Resource Name (ARN).

startFlowResponse_flowStatus :: Lens' StartFlowResponse (Maybe FlowStatus)

Indicates the current status of the flow.

startFlowResponse_httpStatus :: Lens' StartFlowResponse Int

The response's http status code.