paws.storage (version 0.1.7)

s3_list_objects: Returns some or all (up to 1,000) of the objects in a bucket

Description

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. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately.

Usage

s3_list_objects(Bucket, Delimiter, EncodingType, Marker, MaxKeys,
  Prefix, RequestPayer)

Arguments

Bucket

[required] The name of the bucket containing the objects.

Delimiter

A delimiter is a character you use to group keys.

EncodingType

Marker

Specifies the key to start with when listing objects in a bucket.

MaxKeys

Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.

Prefix

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

RequestPayer

Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

Request syntax

svc$list_objects(
  Bucket = "string",
  Delimiter = "string",
  EncodingType = "url",
  Marker = "string",
  MaxKeys = 123,
  Prefix = "string",
  RequestPayer = "requester"
)

Details

This API has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, Amazon S3 continues to support ListObjects.

The following operations are related to ListObjects:

• ListObjectsV2

• GetObject

• PutObject

• CreateBucket

• ListBuckets

Examples

# NOT RUN {
# The following example list two objects in a bucket.
# }
# NOT RUN {
svc$list_objects(
  Bucket = "examplebucket",
  MaxKeys = "2"
)
# }
# NOT RUN {
# }