Struct aws_sdk_s3::operation::list_multipart_uploads::ListMultipartUploadsOutput

#[non_exhaustive]
pub struct ListMultipartUploadsOutput {

    pub bucket: Option<String>,
    pub key_marker: Option<String>,
    pub upload_id_marker: Option<String>,
    pub next_key_marker: Option<String>,
    pub prefix: Option<String>,
    pub delimiter: Option<String>,
    pub next_upload_id_marker: Option<String>,
    pub max_uploads: Option<i32>,
    pub is_truncated: Option<bool>,
    pub uploads: Option<Vec<MultipartUpload>>,
    pub common_prefixes: Option<Vec<CommonPrefix>>,
    pub encoding_type: Option<EncodingType>,
    pub request_charged: Option<RequestCharged>,
    /* private fields */
}

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 name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

key_marker: Option<String>

The key at or after which the listing began.

upload_id_marker: Option<String>

Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.

This functionality is not supported for directory buckets.

next_key_marker: Option<String>

When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.

prefix: Option<String>

When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

delimiter: Option<String>

Contains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element is absent from the response.

Directory buckets - For directory buckets, / is the only supported delimiter.

next_upload_id_marker: Option<String>

When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request.

This functionality is not supported for directory buckets.

max_uploads: Option<i32>

Maximum number of multipart uploads that could have been included in the response.

is_truncated: Option<bool>

Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.

uploads: Option<Vec<MultipartUpload>>

Container for elements related to a particular multipart upload. A response can contain zero or more Upload elements.

common_prefixes: Option<Vec<CommonPrefix>>

If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element. The distinct key prefixes are returned in the Prefix child element.

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

encoding_type: Option<EncodingType>

Encoding type used by Amazon S3 to encode object keys in the 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:

Delimiter, KeyMarker, Prefix, NextKeyMarker, Key.

request_charged: Option<RequestCharged>

If present, indicates that the requester was successfully charged for the request.

This functionality is not supported for directory buckets.

Implementations

impl ListMultipartUploadsOutput

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

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

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

The key at or after which the listing began.

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

Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.

This functionality is not supported for directory buckets.

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

When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.

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

When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

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

Contains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element is absent from the response.

Directory buckets - For directory buckets, / is the only supported delimiter.

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

When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request.

This functionality is not supported for directory buckets.

pub fn max_uploads(&self) -> Option<i32>

Maximum number of multipart uploads that could have been included in the response.

pub fn is_truncated(&self) -> Option<bool>

Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.

pub fn uploads(&self) -> &[MultipartUpload]

Container for elements related to a particular multipart upload. A response can contain zero or more Upload elements.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .uploads.is_none().

pub fn common_prefixes(&self) -> &[CommonPrefix]

If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element. The distinct key prefixes are returned in the Prefix child element.

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .common_prefixes.is_none().

pub fn encoding_type(&self) -> Option<&EncodingType>

Encoding type used by Amazon S3 to encode object keys in the 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:

Delimiter, KeyMarker, Prefix, NextKeyMarker, Key.

pub fn request_charged(&self) -> Option<&RequestCharged>

If present, indicates that the requester was successfully charged for the request.

This functionality is not supported for directory buckets.

impl ListMultipartUploadsOutput

pub fn builder() -> ListMultipartUploadsOutputBuilder

Creates a new builder-style object to manufacture ListMultipartUploadsOutput.

Trait Implementations

impl Clone for ListMultipartUploadsOutput

fn clone(&self) -> ListMultipartUploadsOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListMultipartUploadsOutput

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

Formats the value using the given formatter.

impl PartialEq for ListMultipartUploadsOutput

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for ListMultipartUploadsOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl RequestIdExt for ListMultipartUploadsOutput

fn extended_request_id(&self) -> Option<&str>

Returns the S3 Extended Request ID necessary when contacting AWS Support.

impl StructuralPartialEq for ListMultipartUploadsOutput