Skip to content

list_pipeline_executions async

list_pipeline_executions(
    pipeline_name: PipelineName,
    *,
    config_overrides: Optional[AsyncCodePipelineClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    filter: Optional[PipelineExecutionFilter] = None,
    next_token: Optional[NextToken] = None,
) -> ListPipelineExecutionsOutput

Gets a summary of the most recent executions for a pipeline.

When applying the filter for pipeline executions that have succeeded in the stage, the operation returns all executions in the current pipeline version beginning on February 1, 2024.

Parameters:

  • pipeline_name (PipelineName) –

    The name of the pipeline for which you want to get execution summary information.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Pipeline history is limited to the most recent 12 months, based on pipeline execution start times. Default value is 100.

  • filter (Optional[PipelineExecutionFilter], default: None ) –

    The pipeline execution to filter on.

  • next_token (Optional[NextToken], default: None ) –

    The token that was returned from the previous ListPipelineExecutions call, which can be used to return the next set of pipeline executions in the list.

Raises:

Source code in docs_src/capo_codepipeline/_services/async_code_pipeline.py
async def list_pipeline_executions(
    self,
    pipeline_name: "capo_codepipeline.types.pipeline_name.PipelineName",
    *,
    config_overrides: Optional[AsyncCodePipelineClientConfig] = None,
    max_results: Optional["capo_codepipeline.types.max_results.MaxResults"] = None,
    filter: Optional[
        "capo_codepipeline.types.pipeline_execution_filter.PipelineExecutionFilter"
    ] = None,
    next_token: Optional["capo_codepipeline.types.next_token.NextToken"] = None,
) -> "capo_codepipeline.types.list_pipeline_executions_output.ListPipelineExecutionsOutput":
    """<p>Gets a summary of the most recent executions for a pipeline.</p> <note> <p>When applying the filter for pipeline executions that have succeeded in the stage, the operation returns all executions in the current pipeline version beginning on February 1, 2024.</p> </note>

    Args:
        pipeline_name: <p>The name of the pipeline for which you want to get execution summary information.</p>
        max_results: <p>The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Pipeline history is limited to the most recent 12 months, based on pipeline execution start times. Default value is 100.</p>
        filter: <p>The pipeline execution to filter on.</p>
        next_token: <p>The token that was returned from the previous <code>ListPipelineExecutions</code> call, which can be used to return the next set of pipeline executions in the list.</p>

    Raises:
        capo_codepipeline.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.</p>
        capo_codepipeline.errors.pipeline_not_found_exception.PipelineNotFoundException: <p>The pipeline was specified in an invalid format or cannot be found.</p>
        capo_codepipeline.errors.validation_exception.ValidationException: <p>The validation was specified in an invalid format.</p>
        capo_codepipeline.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_codepipeline.types.list_pipeline_executions_input.ListPipelineExecutionsInput]",
    ) -> AsyncOperationResponse[
        "capo_codepipeline.types.list_pipeline_executions_output.ListPipelineExecutionsOutput"
    ]:
        import capo_codepipeline._operations.code_pipeline_20150709.list_pipeline_executions

        (
            output,
            http_response,
        ) = await capo_codepipeline._operations.code_pipeline_20150709.list_pipeline_executions.async_list_pipeline_executions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListPipelineExecutions")
    )
    input_: capo_codepipeline.types.list_pipeline_executions_input.ListPipelineExecutionsInput = {
        "pipeline_name": pipeline_name
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if filter is not None:
        input_["filter"] = filter
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output