Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ListObjectsRequest

Hierarchy

  • ListObjectsRequest

Index

Properties

Bucket

Bucket: string

The name of the bucket containing the objects. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon S3 User Guide. When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Optional Delimiter

Delimiter: string

A delimiter is a character you use to group keys.

Optional EncodingType

EncodingType: string

Optional ExpectedBucketOwner

ExpectedBucketOwner: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Optional Marker

Marker: string

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

Optional MaxKeys

MaxKeys: number

Sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

Optional Prefix

Prefix: string

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

Optional RequestPayer

RequestPayer: string

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.

Generated using TypeDoc