list_fleets ¶

def list_fleets(
    self,
    *,
    config_overrides: Optional[CodeBuildClientConfig] = None,
    next_token: Optional[
        "capo_codebuild.types.sensitive_string.SensitiveString"
    ] = None,
    max_results: Optional["capo_codebuild.types.page_size.PageSize"] = None,
    sort_order: Optional[
        "capo_codebuild.types.sort_order_type.SortOrderType"
    ] = None,
    sort_by: Optional[
        "capo_codebuild.types.fleet_sort_by_type.FleetSortByType"
    ] = None,
) -> "capo_codebuild.types.list_fleets_output.ListFleetsOutput":
    """<p>Gets a list of compute fleet names with each compute fleet name representing a single compute fleet.</p>

    Args:
        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>
        max_results: <p>The maximum number of paginated compute fleets returned per response. Use <code>nextToken</code> to iterate pages in the list of returned compute fleets.</p>
        sort_order: <p>The order in which to list compute fleets. 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 compute fleet names.</p>
        sort_by: <p>The criterion to be used to list compute fleet names. Valid values include:</p> <ul> <li> <p> <code>CREATED_TIME</code>: List based on when each compute fleet was created.</p> </li> <li> <p> <code>LAST_MODIFIED_TIME</code>: List based on when information about each compute fleet was last changed.</p> </li> <li> <p> <code>NAME</code>: List based on each compute fleet's name.</p> </li> </ul> <p>Use <code>sortOrder</code> to specify in what order to list the compute fleet names based on the preceding criteria.</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_fleets_input.ListFleetsInput]",
    ) -> OperationResponse[
        "capo_codebuild.types.list_fleets_output.ListFleetsOutput"
    ]:
        import capo_codebuild._operations.code_build_20161006.list_fleets

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

    def _redact_input(
        input_: "capo_codebuild.types.list_fleets_input.ListFleetsInput",
    ) -> dict[str, Any]:
        import capo_codebuild.types.list_fleets_input

        return capo_codebuild.types.list_fleets_input.redact_sensitive(input_)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListFleets", redact_input=_redact_input)
    )
    input_: capo_codebuild.types.list_fleets_input.ListFleetsInput = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if sort_order is not None:
        input_["sort_order"] = sort_order
    if sort_by is not None:
        input_["sort_by"] = sort_by

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