ListVersionsRequest Class | AWS SDK for .NET V3

Container for the parameters to the ListVersions operation.

This operation is not supported by directory buckets.

Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions.

To use this operation, you must have permission to perform the s3:ListBucketVersions action. Be aware of the name difference.

A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.

To use this operation, you must have READ access to the bucket.

The following operations are related to ListObjectVersions:

Inheritance Hierarchy

System.Object
Amazon.Runtime.AmazonWebServiceRequest
Amazon.S3.Model.ListVersionsRequest

Namespace: Amazon.S3.Model
Assembly: AWSSDK.S3.dll
Version: 3.x.y.z

Syntax

public class ListVersionsRequest : AmazonWebServiceRequest
         IAmazonWebServiceRequest

The ListVersionsRequest type exposes the following members

Constructors

	Name	Description
	ListVersionsRequest()

Properties

Name	Type	Description
BucketName	System.String	Gets and sets the property BucketName. The bucket name that contains the objects.
Delimiter	System.String	Gets and sets the property Delimiter. 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.
Encoding	Amazon.S3.EncodingType	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.
ExpectedBucketOwner	System.String	Gets and sets the property ExpectedBucketOwner. The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code `403 Forbidden` (access denied).
KeyMarker	System.String	Specifies the key to start with when listing objects in a bucket.
MaxKeys	System.Int32	Gets and sets the property MaxKeys. 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`.
OptionalObjectAttributes	System.Collections.Generic.List<System.String>	Gets and sets the property OptionalObjectAttributes. Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
Prefix	System.String	Gets and sets the property Prefix. 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 that 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`.
RequestPayer	Amazon.S3.RequestPayer	Gets and sets the property RequestPayer.
VersionIdMarker	System.String	Specifies the object version you want to start listing from.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5