list_projects ¶

def list_projects(
    self,
    *,
    config_overrides: Optional[CodeBuildClientConfig] = None,
    sort_by: Optional[
        "capo_codebuild.types.project_sort_by_type.ProjectSortByType"
    ] = None,
    sort_order: Optional[
        "capo_codebuild.types.sort_order_type.SortOrderType"
    ] = None,
    next_token: Optional[
        "capo_codebuild.types.non_empty_string.NonEmptyString"
    ] = None,
) -> "capo_codebuild.types.list_projects_output.ListProjectsOutput":
    """<p>Gets a list of build project names, with each build project name representing a single build project.</p>

    Args:
        sort_by: <p>The criterion to be used to list build project names. Valid values include:</p> <ul> <li> <p> <code>CREATED_TIME</code>: List based on when each build project was created.</p> </li> <li> <p> <code>LAST_MODIFIED_TIME</code>: List based on when information about each build project was last changed.</p> </li> <li> <p> <code>NAME</code>: List based on each build project's name.</p> </li> </ul> <p>Use <code>sortOrder</code> to specify in what order to list the build project names based on the preceding criteria.</p>
        sort_order: <p>The order in which to list build projects. Valid values include:</p> <ul> <li> <p> <code>ASCENDING</code>: List in ascending order.</p> </li> <li> <p> <code>DESCENDING</code>: List in descending order.</p> </li> </ul> <p>Use <code>sortBy</code> to specify the criterion to be used to list build project names.</p>
        next_token: <p>During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a <i>nextToken</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.</p>

    Raises:
        capo_codebuild.errors.invalid_input_exception.InvalidInputException: <p>The input value that was provided is not valid.</p>
        capo_codebuild.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_codebuild.types.list_projects_input.ListProjectsInput]",
    ) -> OperationResponse[
        "capo_codebuild.types.list_projects_output.ListProjectsOutput"
    ]:
        import capo_codebuild._operations.code_build_20161006.list_projects

        output, http_response = (
            capo_codebuild._operations.code_build_20161006.list_projects.list_projects(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListProjects")
    )
    input_: capo_codebuild.types.list_projects_input.ListProjectsInput = {}
    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

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