Struct aws_sdk_s3::input::ListObjectVersionsInput

#[non_exhaustive]
pub struct ListObjectVersionsInput {
    pub bucket: Option<String>,
    pub delimiter: Option<String>,
    pub encoding_type: Option<EncodingType>,
    pub key_marker: Option<String>,
    pub max_keys: i32,
    pub prefix: Option<String>,
    pub version_id_marker: Option<String>,
    pub expected_bucket_owner: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

bucket: Option<String>

The bucket name that contains the objects.

delimiter: Option<String>

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

key_marker: Option<String>

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

max_keys: i32

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.

prefix: Option<String>

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.

version_id_marker: Option<String>

Specifies the object version you want to start listing from.

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.

Implementations

impl ListObjectVersionsInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<ListObjectVersions, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<ListObjectVersions>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture ListObjectVersionsInput

impl ListObjectVersionsInput

pub fn bucket(&self) -> Option<&str>

The bucket name that contains the objects.

pub fn delimiter(&self) -> Option<&str>

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

pub fn key_marker(&self) -> Option<&str>

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

pub fn max_keys(&self) -> i32

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) -> Option<&str>

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) -> Option<&str>

Specifies the object version you want to start listing from.

pub fn expected_bucket_owner(&self) -> Option<&str>

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.

Trait Implementations

impl Clone for ListObjectVersionsInput

fn clone(&self) -> ListObjectVersionsInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListObjectVersionsInput

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

Formats the value using the given formatter.

impl PartialEq<ListObjectVersionsInput> for ListObjectVersionsInput

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

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

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

This method tests for !=.

impl StructuralPartialEq for ListObjectVersionsInput