Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ListObjectVersionsCommandInput

Hierarchy

Index

Properties

Bucket

Bucket: string | undefined

The bucket name that contains the objects.

Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues

Optional Delimiter

Delimiter: undefined | string

A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

Optional EncodingType

EncodingType: EncodingType | string

Requests Amazon S3 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 that Amazon S3 encode the keys in the response.

Optional ExpectedBucketOwner

ExpectedBucketOwner: undefined | string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Optional KeyMarker

KeyMarker: undefined | string

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

Optional MaxKeys

MaxKeys: undefined | 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. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains true. To return the additional keys, see key-marker and version-id-marker.

Optional Prefix

Prefix: undefined | string

Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

Optional VersionIdMarker

VersionIdMarker: undefined | string

Specifies the object version you want to start listing from.