describe_pipeline_execution ¶

def describe_pipeline_execution(
    self,
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName",
    pipeline_name: "capo_iotsitewise.types.resource_name.ResourceName",
    pipeline_execution_id: "capo_iotsitewise.types.id.ID",
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    next_token: Optional[
        "capo_iotsitewise.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional[
        "capo_iotsitewise.types.describe_pipeline_execution_request_max_results_integer.DescribePipelineExecutionRequestMaxResultsInteger"
    ] = None,
) -> "capo_iotsitewise.types.describe_pipeline_execution_response.DescribePipelineExecutionResponse":
    """<p>Retrieves detailed information about a specific pipeline execution, including the overall execution status and the status of each individual compute node. Use this operation to monitor execution progress and inspect per-node results, environment variables, and error details.</p>

    Args:
        workspace_name: <p>The name of the workspace.</p>
        pipeline_name: <p>The name of the pipeline.</p>
        pipeline_execution_id: <p>The unique identifier of the pipeline execution.</p>
        next_token: <p>The token to be used for the next set of paginated results.</p>
        max_results: <p>The maximum number of compute nodes to return per request. This is an upper bound; the actual number of results may be less. Default: 50.</p>

    Raises:
        capo_iotsitewise.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</p>
        capo_iotsitewise.errors.internal_failure_exception.InternalFailureException: <p>IoT SiteWise can't process your request right now. Try again later.</p>
        capo_iotsitewise.errors.invalid_request_exception.InvalidRequestException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.</p>
        capo_iotsitewise.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_iotsitewise.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iotsitewise.types.describe_pipeline_execution_request.DescribePipelineExecutionRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.describe_pipeline_execution_response.DescribePipelineExecutionResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.describe_pipeline_execution

        output, http_response = (
            capo_iotsitewise._operations.aws_io_t_site_wise.describe_pipeline_execution.describe_pipeline_execution(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_iotsitewise.types.describe_pipeline_execution_response.DescribePipelineExecutionResponse",
    ) -> dict[str, Any]:
        import capo_iotsitewise.types.describe_pipeline_execution_response

        return capo_iotsitewise.types.describe_pipeline_execution_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribePipelineExecution", redact_output=_redact_output),
    )
    input_: capo_iotsitewise.types.describe_pipeline_execution_request.DescribePipelineExecutionRequest = {
        "workspace_name": workspace_name,
        "pipeline_name": pipeline_name,
        "pipeline_execution_id": pipeline_execution_id,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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