list_builds ¶

list_builds(
    *,
    config_overrides: Optional[CodeBuildClientConfig] = None,
    sort_order: Optional[SortOrderType] = None,
    next_token: Optional[String] = None,
) -> ListBuildsOutput

Gets a list of build IDs, with each build ID representing a single build.

Parameters:

sort_order (Optional[SortOrderType], default: None ) –
The order to list build IDs. Valid values include:
- ASCENDING: List the build IDs in ascending order by build ID.
- DESCENDING: List the build IDs in descending order by build ID.
next_token (Optional[String], default: None ) –

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 nextToken. 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.

Raises:

InvalidInputException –

The input value that was provided is not valid.
UnknownServiceError –

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

Source code in docs_src/capo_codebuild/_services/code_build.py

def list_builds(
    self,
    *,
    config_overrides: Optional[CodeBuildClientConfig] = None,
    sort_order: Optional[
        "capo_codebuild.types.sort_order_type.SortOrderType"
    ] = None,
    next_token: Optional["capo_codebuild.types.string.String"] = None,
) -> "capo_codebuild.types.list_builds_output.ListBuildsOutput":
    """<p>Gets a list of build IDs, with each build ID representing a single build.</p>

    Args:
        sort_order: <p>The order to list build IDs. Valid values include:</p> <ul> <li> <p> <code>ASCENDING</code>: List the build IDs in ascending order by build ID.</p> </li> <li> <p> <code>DESCENDING</code>: List the build IDs in descending order by build ID.</p> </li> </ul>
        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_builds_input.ListBuildsInput]",
    ) -> OperationResponse[
        "capo_codebuild.types.list_builds_output.ListBuildsOutput"
    ]:
        import capo_codebuild._operations.code_build_20161006.list_builds

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

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