Skip to content

get_workflow_step_execution

get_workflow_step_execution(
    step_execution_id: WorkflowStepExecutionId,
    *,
    config_overrides: Optional[imagebuilderClientConfig] = None,
) -> GetWorkflowStepExecutionResponse

Retrieves runtime information for a specific runtime instance of the workflow step.

Parameters:

  • step_execution_id (WorkflowStepExecutionId) –

    The unique identifier for the runtime instance of the workflow step that you want to get runtime details for. To get the identifiers for the steps that ran in a workflow, call ListWorkflowStepExecutions.

Raises:

  • CallRateLimitExceededException –

    You have exceeded the permitted request rate for the Amazon EC2 APIs that Image Builder calls on your behalf. Retry with an increasing or variable delay between requests.

  • ClientException –

    A generic client error. This error usually indicates that the request failed a validation check, such as when a downstream service rejects a configured value.

  • ForbiddenException –

    You are not authorized to perform the requested operation.

  • InvalidRequestException –

    The request is malformed or otherwise invalid. Verify the request and try again.

  • ServiceException –

    An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.

  • ServiceUnavailableException –

    The service is unable to process your request at this time.

  • UnknownServiceError –

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

Examples:

Get the runtime details of a workflow step The following example retrieves runtime details for the step that launched the build instance during an image build, with the step's input parameters and output values returned as JSON-encoded strings.

>>> client.get_workflow_step_execution(step_execution_id='step-2e6fef0d-657c-4b7e-8706-ff24da9afa01')
Source code in docs_src/capo_imagebuilder/_services/imagebuilder.py
def get_workflow_step_execution(
    self,
    step_execution_id: "capo_imagebuilder.types.workflow_step_execution_id.WorkflowStepExecutionId",
    *,
    config_overrides: Optional[imagebuilderClientConfig] = None,
) -> "capo_imagebuilder.types.get_workflow_step_execution_response.GetWorkflowStepExecutionResponse":
    """<p>Retrieves runtime information for a specific runtime instance of the workflow step.</p>

    Args:
        step_execution_id: <p>The unique identifier for the runtime instance of the workflow step that you want to get runtime details for. To get the identifiers for the steps that ran in a workflow, call <a>ListWorkflowStepExecutions</a>.</p>

    Raises:
        capo_imagebuilder.errors.call_rate_limit_exceeded_exception.CallRateLimitExceededException: <p>You have exceeded the permitted request rate for the Amazon EC2 APIs that Image Builder calls on your behalf. Retry with an increasing or variable delay between requests.</p>
        capo_imagebuilder.errors.client_exception.ClientException: <p>A generic client error. This error usually indicates that the request failed a validation check, such as when a downstream service rejects a configured value.</p>
        capo_imagebuilder.errors.forbidden_exception.ForbiddenException: <p>You are not authorized to perform the requested operation.</p>
        capo_imagebuilder.errors.invalid_request_exception.InvalidRequestException: <p>The request is malformed or otherwise invalid. Verify the request and try again.</p>
        capo_imagebuilder.errors.service_exception.ServiceException: <p>An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.</p>
        capo_imagebuilder.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is unable to process your request at this time.</p>
        capo_imagebuilder.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Get the runtime details of a workflow step
        The following example retrieves runtime details for the step that launched the build instance during an image build, with the step's input parameters and output values returned as JSON-encoded strings.

        >>> client.get_workflow_step_execution(step_execution_id='step-2e6fef0d-657c-4b7e-8706-ff24da9afa01')
    """

    def _handler(
        req: "OperationRequest[capo_imagebuilder.types.get_workflow_step_execution_request.GetWorkflowStepExecutionRequest]",
    ) -> OperationResponse[
        "capo_imagebuilder.types.get_workflow_step_execution_response.GetWorkflowStepExecutionResponse"
    ]:
        import capo_imagebuilder._operations.imagebuilder.get_workflow_step_execution

        output, http_response = (
            capo_imagebuilder._operations.imagebuilder.get_workflow_step_execution.get_workflow_step_execution(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetWorkflowStepExecution")
    )
    input_: capo_imagebuilder.types.get_workflow_step_execution_request.GetWorkflowStepExecutionRequest = {
        "step_execution_id": step_execution_id
    }

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