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.Transfer.SendWorkflowStepState

Contents

Description

Sends a callback for asynchronous custom steps.

The ExecutionId, WorkflowId, and Token are passed to the target resource during execution of a custom step of a workflow. You must include those with their callback as well as providing a status.

Creating a Request

data SendWorkflowStepState Source #

See: newSendWorkflowStepState smart constructor.

Constructors

SendWorkflowStepState'
Fields workflowId :: Text A unique identifier for the workflow. executionId :: Text A unique identifier for the execution of a workflow. token :: Text Used to distinguish between multiple callbacks for multiple Lambda steps within the same execution. status :: CustomStepStatus Indicates whether the specified step succeeded or failed.

Instances

Instances details

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

newSendWorkflowStepState Source #

Arguments

:: Text	`SendWorkflowStepState`
-> Text	`SendWorkflowStepState`
-> Text	`$sel:token:SendWorkflowStepState'`
-> CustomStepStatus	`SendWorkflowStepState`
-> SendWorkflowStepState

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

SendWorkflowStepState, sendWorkflowStepState_workflowId - A unique identifier for the workflow.

SendWorkflowStepState, sendWorkflowStepState_executionId - A unique identifier for the execution of a workflow.

$sel:token:SendWorkflowStepState', sendWorkflowStepState_token - Used to distinguish between multiple callbacks for multiple Lambda steps within the same execution.

SendWorkflowStepState, sendWorkflowStepState_status - Indicates whether the specified step succeeded or failed.

Request Lenses

sendWorkflowStepState_workflowId :: Lens' SendWorkflowStepState Text Source #

A unique identifier for the workflow.

sendWorkflowStepState_executionId :: Lens' SendWorkflowStepState Text Source #

A unique identifier for the execution of a workflow.

sendWorkflowStepState_token :: Lens' SendWorkflowStepState Text Source #

Used to distinguish between multiple callbacks for multiple Lambda steps within the same execution.

sendWorkflowStepState_status :: Lens' SendWorkflowStepState CustomStepStatus Source #

Indicates whether the specified step succeeded or failed.

Destructuring the Response

data SendWorkflowStepStateResponse Source #

See: newSendWorkflowStepStateResponse smart constructor.

Constructors

SendWorkflowStepStateResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newSendWorkflowStepStateResponse Source #

Arguments

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

Create a value of SendWorkflowStepStateResponse 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:httpStatus:SendWorkflowStepStateResponse', sendWorkflowStepStateResponse_httpStatus - The response's http status code.

Response Lenses

sendWorkflowStepStateResponse_httpStatus :: Lens' SendWorkflowStepStateResponse Int Source #

The response's http status code.