Struct rusoto_s3::ListObjectsRequest

pub struct ListObjectsRequest {
    pub bucket: String,
    pub delimiter: Option<String>,
    pub encoding_type: Option<String>,
    pub expected_bucket_owner: Option<String>,
    pub marker: Option<String>,
    pub max_keys: Option<i64>,
    pub prefix: Option<String>,
    pub request_payer: Option<String>,
}

Fields

bucket: String

The name of the bucket containing the objects.

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.

delimiter: Option<String>

A delimiter is a character you use to group keys.

encoding_type: Option<String>

expected_bucket_owner: Option<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.

marker: Option<String>

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

max_keys: Option<i64>

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

prefix: Option<String>

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

request_payer: Option<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.

Trait Implementations

impl Clone for ListObjectsRequest

pub fn clone(&self) -> ListObjectsRequest

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListObjectsRequest

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ListObjectsRequest

pub fn default() -> ListObjectsRequest

Returns the "default value" for a type.

impl PartialEq<ListObjectsRequest> for ListObjectsRequest

pub fn eq(&self, other: &ListObjectsRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &ListObjectsRequest) -> bool

This method tests for !=.

impl StructuralPartialEq for ListObjectsRequest