list_sandboxes ¶

list_sandboxes(
    *,
    config_overrides: Optional[CodeBuildClientConfig] = None,
    max_results: Optional[PageSize] = None,
    sort_order: Optional[SortOrderType] = None,
    next_token: Optional[String] = None,
) -> ListSandboxesOutput

Gets a list of sandboxes.

Parameters:

max_results (Optional[PageSize], default: None ) –

The maximum number of sandbox records to be retrieved.
sort_order (Optional[SortOrderType], default: None ) –

The order in which sandbox records should be retrieved.
next_token (Optional[String], default: None ) –

The next token, if any, to get paginated results. You will get this value from previous execution of list sandboxes.

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_sandboxes(
    self,
    *,
    config_overrides: Optional[CodeBuildClientConfig] = None,
    max_results: Optional["capo_codebuild.types.page_size.PageSize"] = 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_sandboxes_output.ListSandboxesOutput":
    """<p>Gets a list of sandboxes.</p>

    Args:
        max_results: <p>The maximum number of sandbox records to be retrieved.</p>
        sort_order: <p>The order in which sandbox records should be retrieved.</p>
        next_token: <p>The next token, if any, to get paginated results. You will get this value from previous execution of list sandboxes.</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_sandboxes_input.ListSandboxesInput]",
    ) -> OperationResponse[
        "capo_codebuild.types.list_sandboxes_output.ListSandboxesOutput"
    ]:
        import capo_codebuild._operations.code_build_20161006.list_sandboxes

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListSandboxes")
    )
    input_: capo_codebuild.types.list_sandboxes_input.ListSandboxesInput = {}
    if max_results is not None:
        input_["max_results"] = max_results
    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