Struct aws_sdk_s3::input::ListObjectsV2Input

#[non_exhaustive]
pub struct ListObjectsV2Input {
    pub bucket: Option<String>,
    pub delimiter: Option<String>,
    pub encoding_type: Option<EncodingType>,
    pub max_keys: i32,
    pub prefix: Option<String>,
    pub continuation_token: Option<String>,
    pub fetch_owner: bool,
    pub start_after: Option<String>,
    pub request_payer: Option<RequestPayer>,
    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>

Bucket name to list.

When using this action 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

When using this action 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 action using S3 on Outposts through the Amazon Web Services 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 S3 User Guide.

delimiter: Option<String>

A delimiter is a character you use to group keys.

encoding_type: Option<EncodingType>

Encoding type used by Amazon S3 to encode object keys in the response.

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.

prefix: Option<String>

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

continuation_token: Option<String>

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.

fetch_owner: bool

The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true.

start_after: Option<String>

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.

request_payer: Option<RequestPayer>

Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.

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 ListObjectsV2Input

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

Consumes the builder and constructs an Operation<ListObjectsV2>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture ListObjectsV2Input.

impl ListObjectsV2Input

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

Bucket name to list.

When using this action 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

When using this action 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 action using S3 on Outposts through the Amazon Web Services 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 S3 User Guide.

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

A delimiter is a character you use to group keys.

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

Encoding type used by Amazon S3 to encode object keys in the response.

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.

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

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

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

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.

pub fn fetch_owner(&self) -> bool

The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true.

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

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.

pub fn request_payer(&self) -> Option<&RequestPayer>

Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.

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 ListObjectsV2Input

fn clone(&self) -> ListObjectsV2Input

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListObjectsV2Input

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

Formats the value using the given formatter.

impl PartialEq<ListObjectsV2Input> for ListObjectsV2Input

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

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

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

This method tests for !=.

impl StructuralPartialEq for ListObjectsV2Input