Struct aws_sdk_s3::client::fluent_builders::ListObjectVersions

pub struct ListObjectVersions { /* private fields */ }

Fluent builder constructing a request to ListObjectVersions.

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 permissions 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.

This action is not supported by Amazon S3 on Outposts.

The following operations are related to ListObjectVersions:

• ListObjectsV2

• GetObject

• PutObject

• DeleteObject

Implementations

impl ListObjectVersions

pub async fn customize(
    self
) -> Result<CustomizableOperation<ListObjectVersions, AwsResponseRetryClassifier>, SdkError<ListObjectVersionsError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<ListObjectVersionsOutput, SdkError<ListObjectVersionsError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn bucket(self, input: impl Into<String>) -> Self

The bucket name that contains the objects.

pub fn set_bucket(self, input: Option<String>) -> Self

The bucket name that contains the objects.

pub fn delimiter(self, input: impl Into<String>) -> Self

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.

pub fn set_delimiter(self, input: Option<String>) -> Self

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.

pub fn encoding_type(self, input: EncodingType) -> Self

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.

pub fn set_encoding_type(self, input: Option<EncodingType>) -> Self

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.

pub fn key_marker(self, input: impl Into<String>) -> Self

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

pub fn set_key_marker(self, input: Option<String>) -> Self

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

pub fn max_keys(self, input: i32) -> Self

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.

pub fn set_max_keys(self, input: Option<i32>) -> Self

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.

pub fn prefix(self, input: impl Into<String>) -> Self

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.

pub fn set_prefix(self, input: Option<String>) -> Self

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.

pub fn version_id_marker(self, input: impl Into<String>) -> Self

Specifies the object version you want to start listing from.

pub fn set_version_id_marker(self, input: Option<String>) -> Self

Specifies the object version you want to start listing from.

pub fn expected_bucket_owner(self, input: impl Into<String>) -> Self

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).

pub fn set_expected_bucket_owner(self, input: Option<String>) -> Self

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).

Trait Implementations

impl Clone for ListObjectVersions

fn clone(&self) -> ListObjectVersions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListObjectVersions

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

Formats the value using the given formatter.