list_pipelines ¶

list_pipelines(
    *,
    config_overrides: Optional[CodePipelineClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxPipelines] = None,
) -> ListPipelinesOutput

Gets a summary of all of the pipelines associated with your account.

Parameters:

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

An identifier that was returned from the previous list pipelines call. It can be used to return the next set of pipelines in the list.
max_results (Optional[MaxPipelines], default: None ) –

The maximum number of pipelines to return in a single call. To retrieve the remaining pipelines, make another call with the returned nextToken value. The minimum value you can specify is 1. The maximum accepted value is 1000.

Raises:

InvalidNextTokenException –

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.
ValidationException –

The validation was specified in an invalid format.
UnknownServiceError –

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

Source code in docs_src/capo_codepipeline/_services/code_pipeline.py

def list_pipelines(
    self,
    *,
    config_overrides: Optional[CodePipelineClientConfig] = None,
    next_token: Optional["capo_codepipeline.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_codepipeline.types.max_pipelines.MaxPipelines"
    ] = None,
) -> "capo_codepipeline.types.list_pipelines_output.ListPipelinesOutput":
    """<p>Gets a summary of all of the pipelines associated with your account.</p>

    Args:
        next_token: <p>An identifier that was returned from the previous list pipelines call. It can be used to return the next set of pipelines in the list.</p>
        max_results: <p>The maximum number of pipelines to return in a single call. To retrieve the remaining pipelines, make another call with the returned nextToken value. The minimum value you can specify is 1. The maximum accepted value is 1000.</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.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.
    """

    def _handler(
        req: "OperationRequest[capo_codepipeline.types.list_pipelines_input.ListPipelinesInput]",
    ) -> OperationResponse[
        "capo_codepipeline.types.list_pipelines_output.ListPipelinesOutput"
    ]:
        import capo_codepipeline._operations.code_pipeline_20150709.list_pipelines

        output, http_response = (
            capo_codepipeline._operations.code_pipeline_20150709.list_pipelines.list_pipelines(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListPipelines")
    )
    input_: capo_codepipeline.types.list_pipelines_input.ListPipelinesInput = {}
    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