"list"
******


Description
===========

Gets a list of all BucketSummary items in a compartment. A
BucketSummary contains only summary fields for the bucket and does not
contain fields like the user-defined metadata.

To use this and other API operations, you must be authorized in an IAM
policy. If you are not authorized, talk to an administrator. If you
are an administrator who needs to write policies to give users access,
see Getting Started with Policies.


Usage
=====

   oci os bucket list [OPTIONS]


Required Parameters
===================

--compartment-id, -c [text]

The ID of the compartment in which to list buckets.


Optional Parameters
===================

--all

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

--fields [text]

Bucket summary in list of buckets includes the 'namespace', 'name',
'compartmentId', 'createdBy', 'timeCreated', and 'etag' fields. This
parameter can also include 'tags' (freeformTags and definedTags). The
only supported value of this parameter is 'tags' for now. Example
'tags'.

Accepted values are:

   tags

--from-json [text]

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

The "--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/Conte
nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--limit [integer]

The maximum number of items to return.

--namespace-name, --namespace, -ns [text]

The Object Storage namespace used for the request. If not provided,
this parameter will be obtained internally using a call to 'oci os ns
get'

--page [text]

The page at which to start retrieving results.

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


Global Parameters
=================

Use "oci --help" for help on global parameters.

"--auth", "--cert-bundle", "--cli-rc-file", "--config-file", "--
debug", "--defaults-file", "--endpoint", "--generate-full-command-
json-input", "--generate-param-json-input", "--help", "--no-retry", "
--opc-client-request-id", "--opc-request-id", "--output", "--profile",
"--query", "--raw-output", "--region", "--request-id", "--version",
"-?", "-d", "-h", "-v"
