get_workflow ¶

def get_workflow(
    self,
    workflow_build_version_arn: "capo_imagebuilder.types.workflow_version_arn_or_build_version_arn.WorkflowVersionArnOrBuildVersionArn",
    *,
    config_overrides: Optional[imagebuilderClientConfig] = None,
) -> "capo_imagebuilder.types.get_workflow_response.GetWorkflowResponse":
    """<p>Retrieves a workflow resource object.</p>

    Args:
        workflow_build_version_arn: <p>The Amazon Resource Name (ARN) of the workflow resource that you want to get. You can specify a build version ARN, or a version ARN with or without wildcards (<code>x</code>) in its version segments. Image Builder resolves version and wildcard ARNs to the most recent matching build version.</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 details of a workflow build version
        The following example retrieves a workflow build version. The response includes the YAML workflow document in the data field and the parameters that Image Builder extracted from it when the workflow was created.

        >>> client.get_workflow(workflow_build_version_arn='arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.0/1')
    """

    def _handler(
        req: "OperationRequest[capo_imagebuilder.types.get_workflow_request.GetWorkflowRequest]",
    ) -> OperationResponse[
        "capo_imagebuilder.types.get_workflow_response.GetWorkflowResponse"
    ]:
        import capo_imagebuilder._operations.imagebuilder.get_workflow

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetWorkflow")
    )
    input_: capo_imagebuilder.types.get_workflow_request.GetWorkflowRequest = {
        "workflow_build_version_arn": workflow_build_version_arn
    }

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