send_workflow_step_state ¶

send_workflow_step_state(
    workflow_id: WorkflowId,
    execution_id: ExecutionId,
    token: CallbackToken,
    status: CustomStepStatus,
    *,
    config_overrides: Optional[TransferClientConfig] = None,
) -> SendWorkflowStepStateResponse

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.

Parameters:

workflow_id (WorkflowId) –

A unique identifier for the workflow.
execution_id (ExecutionId) –

A unique identifier for the execution of a workflow.
token (CallbackToken) –

Used to distinguish between multiple callbacks for multiple Lambda steps within the same execution.
status (CustomStepStatus) –

Indicates whether the specified step succeeded or failed.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
InternalServiceError –

This exception is thrown when an error occurs in the Transfer Family service.
InvalidRequestException –

This exception is thrown when the client submits a malformed request.
ResourceNotFoundException –

This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
ServiceUnavailableException –

The request has failed because the Amazon Web ServicesTransfer Family service is not available.
ThrottlingException –

The request was denied due to request throttling.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_transfer/_services/transfer.py

def send_workflow_step_state(
    self,
    workflow_id: "capo_transfer.types.workflow_id.WorkflowId",
    execution_id: "capo_transfer.types.execution_id.ExecutionId",
    token: "capo_transfer.types.callback_token.CallbackToken",
    status: "capo_transfer.types.custom_step_status.CustomStepStatus",
    *,
    config_overrides: Optional[TransferClientConfig] = None,
) -> "capo_transfer.types.send_workflow_step_state_response.SendWorkflowStepStateResponse":
    """<p>Sends a callback for asynchronous custom steps.</p> <p> The <code>ExecutionId</code>, <code>WorkflowId</code>, and <code>Token</code> 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. </p>

    Args:
        workflow_id: <p>A unique identifier for the workflow.</p>
        execution_id: <p>A unique identifier for the execution of a workflow.</p>
        token: <p>Used to distinguish between multiple callbacks for multiple Lambda steps within the same execution.</p>
        status: <p>Indicates whether the specified step succeeded or failed.</p>

    Raises:
        capo_transfer.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_transfer.errors.internal_service_error.InternalServiceError: <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
        capo_transfer.errors.invalid_request_exception.InvalidRequestException: <p>This exception is thrown when the client submits a malformed request.</p>
        capo_transfer.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
        capo_transfer.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
        capo_transfer.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_transfer.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_transfer.types.send_workflow_step_state_request.SendWorkflowStepStateRequest]",
    ) -> OperationResponse[
        "capo_transfer.types.send_workflow_step_state_response.SendWorkflowStepStateResponse"
    ]:
        import capo_transfer._operations.transfer_service.send_workflow_step_state

        output, http_response = (
            capo_transfer._operations.transfer_service.send_workflow_step_state.send_workflow_step_state(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SendWorkflowStepState")
    )
    input_: capo_transfer.types.send_workflow_step_state_request.SendWorkflowStepStateRequest = {
        "workflow_id": workflow_id,
        "execution_id": execution_id,
        "token": token,
        "status": status,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output