``list-sandbox-warm-pools``
===========================
.. contents:: :local:
 :depth: 1
Description
------------
Lists named MANAGED and CUSTOM pools for Sandbox-enabled Projects, including zero targets and in-progress management operations. Reserved defaults can be resized but cannot be created or deleted by customers. DELETED resources are excluded. Responses include CP management lifecycle but do not perform runtime reads or return ready capacity. 


Usage
-----
.. code-block:: none

  oci generative-ai sandbox-warm-pool-collection list-sandbox-warm-pools [OPTIONS]

Required Parameters
--------------------
.. option:: --project-id [text]

Owning Generative AI Project OCID. Resolve parent compartment for authorization.


Optional Parameters
--------------------
.. option:: --all

Fetches all pages of results. If you provide this option, then you cannot provide the ``--limit`` option.

.. option:: --from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The :option:`--generate-full-command-json-input` option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id --> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our "using CLI with advanced JSON options" link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

.. option:: --limit [integer]

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see `List Pagination <https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine>`__.

.. option:: --name [text]

Exact name filter.

.. option:: --page [text]

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see `List Pagination <https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine>`__.

.. option:: --page-size [integer]

When fetching results, the number of results to fetch per call. Only valid when used with ``--all`` or ``--limit``, and ignored otherwise.

.. option:: --shape [text]

Filter by shape.

Accepted values are:

.. code-block:: py

    LARGE, MEDIUM, SMALL

.. option:: --sort-by [text]

Filter by sortBy.

Accepted values are:

.. code-block:: py

    name, timeCreated

.. option:: --sort-order [text]

Filter by sortOrder.

Accepted values are:

.. code-block:: py

    ASC, DESC

.. option:: --type [text]

Filter by type.

Accepted values are:

.. code-block:: py

    CUSTOM, MANAGED



Global Parameters
------------------
Use ``oci --help`` for help on global parameters.

:option:`--auth-purpose`, :option:`--auth`, :option:`--cert-bundle`, :option:`--cli-auto-prompt`, :option:`--cli-rc-file`, :option:`--config-file`, :option:`--connection-timeout`, :option:`--debug`, :option:`--defaults-file`, :option:`--enable-dual-stack`, :option:`--enable-propagation`, :option:`--endpoint`, :option:`--federation-endpoint`, :option:`--generate-full-command-json-input`, :option:`--generate-param-json-input`, :option:`--help`, :option:`--latest-version`, :option:`--max-retries`, :option:`--no-retry`, :option:`--opc-client-request-id`, :option:`--opc-request-id`, :option:`--output`, :option:`--profile`, :option:`--proxy`, :option:`--query`, :option:`--raw-output`, :option:`--read-timeout`, :option:`--realm-specific-endpoint`, :option:`--region`, :option:`--release-info`, :option:`--request-id`, :option:`--version`, :option:`-?`, :option:`-d`, :option:`-h`, :option:`-i`, :option:`-v`



Example using required parameter
------------------

Copy the following CLI commands into a file named example.sh. Run the command by typing "bash example.sh" and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up `the OCI configuration  <https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile>`__ and `appropriate security policies  <https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm>`__ before trying the examples.

.. code-block:: none
    :class: copy-code-block

    
	export project_id=<substitute-value-of-project_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/generative-ai/sandbox-warm-pool-collection/list-sandbox-warm-pools.html#cmdoption-project-id
	
	oci generative-ai sandbox-warm-pool-collection list-sandbox-warm-pools --project-id $project_id



