list-objects¶

Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket.

Synopsis¶

list-objects
  --bucket <value>
  [--delimiter <value>]
  [--encoding-type <value>]
  [--prefix <value>]
  [--cli-input-json <value>]
  [--starting-token <value>]
  [--page-size <value>]
  [--max-items <value>]

Options¶

--bucket (string)

--delimiter (string)

A delimiter is a character you use to group keys.

--encoding-type (string)

Requests Zenko to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request Zenko to encode the keys in the response.

Possible values:

url

--prefix (string)

Limits the response to keys that begin with the specified prefix.

Possible values:

requester

--cli-input-json (string)

Operates a service or services based on the provided JSON string. If other arguments are provided on the command line, the CLI values override the JSON-provided values. You cannot pass arbitrary binary values using a JSON-provided value, because the string is taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide.

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide.

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide.

Examples¶

The following example uses the list-objects command to display the names of all the objects in the specified bucket:

$ aws s3api list-objects --bucket text-content --query 'Contents[].{Key: Key, Size: Size}'

The example uses the --query argument to filter the output of list-objects down to the key value and size for each object

For more information about objects, see Working with Amazon S3 Objects in the Amazon S3 Developer Guide.

Output¶

IsTruncated -> (Boolean)

This flag indicates whether Zenko returned all results that satisfied the search criteria.

Marker -> (string)

NextMarker -> (string)

When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Zenko lists objects in alphabetical order.

Note

This element is only returned if the Delimiter request parameter is specified. If the response is truncated and does not include the NextMarker, use the value of the last Key field in the response as the marker in the subsequent request to get the next set of object keys.

Contents -> (list)

(structure)

Key -> (string)

LastModified -> (timestamp)

ETag -> (string)

Size -> (integer)

StorageClass -> (string)

The class of storage used to store the object.

Owner -> (structure)

DisplayName -> (string)

ID -> (string)

Name -> (string)

Prefix -> (string)

Delimiter -> (string)

MaxKeys -> (integer)

CommonPrefixes -> (list)

(structure)

Prefix -> (string)

EncodingType -> (string)

Encoding type used by Zenko to encode object keys in the response.