AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

This is the response object from the ListVersions operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.S3.Model.ListVersionsResponse

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

Syntax

C#
public class ListVersionsResponse : AmazonWebServiceResponse

The ListVersionsResponse type exposes the following members

Constructors

NameDescription
Public Method ListVersionsResponse()

Properties

NameTypeDescription
Public Property CommonPrefixes System.Collections.Generic.List<System.String>

Gets and sets the property CommonPrefixes.

All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property Delimiter System.String

Gets and sets the property Delimiter.

The delimiter grouping the included keys. 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.

Public Property Encoding Amazon.S3.EncodingType

Gets and sets the property Encoding.

Encoding type used by Amazon S3 to encode object key names in the XML response.

If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property IsTruncated System.Nullable<System.Boolean>

Gets and sets the property IsTruncated.

A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request by using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.

Public Property KeyMarker System.String

Gets and sets the property KeyMarker.

Marks the last key returned in a truncated response.

Public Property MaxKeys System.Nullable<System.Int32>

Gets and sets the property MaxKeys.

Specifies the maximum number of objects to return.

Public Property Name System.String

Gets and sets the property Name.

The bucket name.

Public Property NextKeyMarker System.String

Gets and sets the property NextKeyMarker.

When the number of responses exceeds the value of MaxKeys, NextKeyMarker specifies the first key not returned that satisfies the search criteria. Use this value for the key-marker request parameter in a subsequent request.

Public Property NextVersionIdMarker System.String

Gets and sets the property NextVersionIdMarker.

When the number of responses exceeds the value of MaxKeys, NextVersionIdMarker specifies the first object version not returned that satisfies the search criteria. Use this value for the version-id-marker request parameter in a subsequent request.

Public Property Prefix System.String

Gets and sets the property Prefix.

Selects objects that start with the value supplied by this parameter.

Public Property RequestCharged Amazon.S3.RequestCharged

Gets and sets the property RequestCharged.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property VersionIdMarker System.String

Gets and sets the property VersionIdMarker.

Marks the last version of the key returned in a truncated response.

Public Property Versions System.Collections.Generic.List<Amazon.S3.Model.S3ObjectVersion>

Gets and sets the property Versions.

Container for version information.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer