list_pipeline_executions ¶

def list_pipeline_executions(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    pipeline_name: Optional[
        "capo_sagemaker.types.pipeline_name_or_arn.PipelineNameOrArn"
    ] = None,
    created_after: Optional["capo_sagemaker.types.timestamp.Timestamp"] = None,
    created_before: Optional["capo_sagemaker.types.timestamp.Timestamp"] = None,
    sort_by: Optional[
        "capo_sagemaker.types.sort_pipeline_executions_by.SortPipelineExecutionsBy"
    ] = None,
    sort_order: Optional["capo_sagemaker.types.sort_order.SortOrder"] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
    max_results: Optional["capo_sagemaker.types.max_results.MaxResults"] = None,
) -> "capo_sagemaker.types.list_pipeline_executions_response.ListPipelineExecutionsResponse":
    """<p>Gets a list of the pipeline executions.</p>

    Args:
        pipeline_name: <p>The name or Amazon Resource Name (ARN) of the pipeline.</p>
        created_after: <p>A filter that returns the pipeline executions that were created after a specified time.</p>
        created_before: <p>A filter that returns the pipeline executions that were created before a specified time.</p>
        sort_by: <p>The field by which to sort results. The default is <code>CreatedTime</code>.</p>
        sort_order: <p>The sort order for results.</p>
        next_token: <p>If the result of the previous <code>ListPipelineExecutions</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of pipeline executions, use the token in the next request.</p>
        max_results: <p>The maximum number of pipeline executions to return in the response.</p>

    Raises:
        capo_sagemaker.errors.resource_not_found.ResourceNotFound: <p>Resource being access is not found.</p>
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sagemaker.types.list_pipeline_executions_request.ListPipelineExecutionsRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.list_pipeline_executions_response.ListPipelineExecutionsResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.list_pipeline_executions

        output, http_response = (
            capo_sagemaker._operations.sage_maker.list_pipeline_executions.list_pipeline_executions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListPipelineExecutions")
    )
    input_: capo_sagemaker.types.list_pipeline_executions_request.ListPipelineExecutionsRequest = {}
    if pipeline_name is not None:
        input_["pipeline_name"] = pipeline_name
    if created_after is not None:
        input_["created_after"] = created_after
    if created_before is not None:
        input_["created_before"] = created_before
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order
    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