Class ListObjectsV2Request
Container for the parameters to the ListObjects operation.
Returns some or all (up to 1000) 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.
public class ListObjectsV2Request : AmazonWebServiceRequest- Inheritance
-
ListObjectsV2Request
Constructors
ListObjectsV2Request()
public ListObjectsV2Request()Properties
BucketName
Bucket name to list.
When using this API 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 operation 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 Simple Storage Service Developer Guide.
When using this API 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 operation 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 Simple Storage Service Developer Guide.
public string BucketName { get; set; }Property Value
ContinuationToken
ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key.
public string ContinuationToken { get; set; }Property Value
Delimiter
A delimiter is a character you use to group keys.
public string Delimiter { get; set; }Property Value
Encoding
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.
public EncodingType Encoding { get; set; }Property Value
ExpectedBucketOwner
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.
public string ExpectedBucketOwner { get; set; }Property Value
FetchOwner
The owner field is not present in ListObjectsV2 responses by default. If you want to return owner field with each key in the result then set this field to true. If not specified, the Owner field on S3Object will be null.
public bool FetchOwner { get; set; }Property Value
MaxKeys
Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.
public int MaxKeys { get; set; }Property Value
Prefix
Limits the response to keys that begin with the specified prefix.
public string Prefix { get; set; }Property Value
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.
public RequestPayer RequestPayer { get; set; }Property Value
StartAfter
StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket. Cannot be set at the same time as ContinuationToken.
public string StartAfter { get; set; }