amazonka-transfer-2.0: Amazon Transfer Family SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Transfer.SendWorkflowStepState

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.

Synopsis

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

ToHeaders SendWorkflowStepState Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

ToPath SendWorkflowStepState Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

ToQuery SendWorkflowStepState Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

AWSRequest SendWorkflowStepState Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

Associated Types

type AWSResponse SendWorkflowStepState #

Generic SendWorkflowStepState Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

Associated Types

type Rep SendWorkflowStepState :: Type -> Type #

Read SendWorkflowStepState Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

Show SendWorkflowStepState Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

NFData SendWorkflowStepState Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

Methods

rnf :: SendWorkflowStepState -> () #

Eq SendWorkflowStepState Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

Hashable SendWorkflowStepState Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

type AWSResponse SendWorkflowStepState Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

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 #

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_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

Instances

Instances details
Generic SendWorkflowStepStateResponse Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

Associated Types

type Rep SendWorkflowStepStateResponse :: Type -> Type #

Read SendWorkflowStepStateResponse Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

Show SendWorkflowStepStateResponse Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

NFData SendWorkflowStepStateResponse Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

Eq SendWorkflowStepStateResponse Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

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 #

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