``list`` ======== .. contents:: :local: :depth: 1 Description ------------ Lists the notebook sessions in the specified compartment. Usage ----- .. code-block:: none oci data-science notebook-session list [OPTIONS] Required Parameters -------------------- .. option:: --compartment-id, -c [text] Filter results by the `OCID `__ of the compartment. Optional Parameters -------------------- .. option:: --all Fetches all pages of results. If you provide this option, then you cannot provide the ``--limit`` option. .. option:: --created-by [text] Filter results by the `OCID `__ of the user who created the resource. .. option:: --display-name [text] Filter results by its user-friendly name. .. 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:: --id [text] Filter results by `OCID `__. Must be an OCID of the correct type for the resource type. .. option:: --lifecycle-state [text] Filter results by the specified lifecycle state. Must be a valid state for the resource type. Accepted values are: .. code-block:: py ACTIVE, CREATING, DELETED, DELETING, FAILED, INACTIVE, UPDATING .. option:: --limit [integer] For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See `List Pagination `__. Example: .. code-block:: python 50 .. option:: --page [text] For list pagination. The value of the `opc-next-page` response header from the previous "List" call. See `List Pagination `__. .. 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:: --project-id [text] Filter results by the `OCID `__ of the project. .. option:: --sort-by [text] Specifies the field to sort by. Accepts only one field. By default, when you sort by `timeCreated`, the results are shown in descending order. When you sort by `displayName`, results are shown in ascending order. Sort order for the `displayName` field is case sensitive. Accepted values are: .. code-block:: py displayName, timeCreated .. option:: --sort-order [text] Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). Accepted values are: .. code-block:: py ASC, DESC 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:`--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 `__ and `appropriate security policies `__ before trying the examples. .. code-block:: none :class: copy-code-block export compartment_id= # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-science/notebook-session/list.html#cmdoption-compartment-id oci data-science notebook-session list --compartment-id $compartment_id