Struct bonsaidb::keystorage::s3::aws_sdk_s3::operation::list_objects_v2::builders::ListObjectsV2FluentBuilder

pub struct ListObjectsV2FluentBuilder { /* private fields */ }

Fluent builder constructing a request to ListObjectsV2.

Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. 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. Objects are returned sorted in an ascending order of the respective key names in the list. For more information about listing objects, see Listing object keys programmatically in the Amazon S3 User Guide.

To use this operation, you must have READ access to the bucket.

To use this action in an Identity and Access Management (IAM) policy, you must have permission to perform the s3:ListBucket action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.

This section describes the latest revision of this action. We recommend that you use this revised API operation for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API operation, ListObjects.

To get a list of your buckets, see ListBuckets.

The following operations are related to ListObjectsV2:

• GetObject

• PutObject

• CreateBucket

Implementations

impl ListObjectsV2FluentBuilder

pub fn as_input(&self) -> &ListObjectsV2InputBuilder

Access the ListObjectsV2 as a reference.

pub async fn send( self ) -> impl Future<Output = Result<ListObjectsV2Output, SdkError<ListObjectsV2Error, Response<SdkBody>>>>

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 async fn customize( self ) -> impl Future<Output = Result<CustomizableOperation<ListObjectsV2Output, ListObjectsV2Error, ListObjectsV2FluentBuilder>, SdkError<ListObjectsV2Error, Response>>>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn into_paginator(self) -> ListObjectsV2Paginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

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

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 you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

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

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 you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

pub fn get_bucket(&self) -> &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 you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

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

A delimiter is a character that you use to group keys.

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

A delimiter is a character that you use to group keys.

pub fn get_delimiter(&self) -> &Option<String>

A delimiter is a character that you use to group keys.

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

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

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

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

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

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

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

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 set_max_keys(self, input: Option<i32>) -> ListObjectsV2FluentBuilder

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 get_max_keys(&self) -> &Option<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, input: impl Into<String>) -> ListObjectsV2FluentBuilder

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

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

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

pub fn get_prefix(&self) -> &Option<String>

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

pub fn continuation_token( self, input: impl Into<String> ) -> ListObjectsV2FluentBuilder

ContinuationToken indicates to 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 set_continuation_token( self, input: Option<String> ) -> ListObjectsV2FluentBuilder

ContinuationToken indicates to 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 get_continuation_token(&self) -> &Option<String>

ContinuationToken indicates to 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, input: bool) -> ListObjectsV2FluentBuilder

The owner field is not present in ListObjectsV2 by default. If you want to return the owner field with each key in the result, then set the FetchOwner field to true.

pub fn set_fetch_owner(self, input: Option<bool>) -> ListObjectsV2FluentBuilder

The owner field is not present in ListObjectsV2 by default. If you want to return the owner field with each key in the result, then set the FetchOwner field to true.

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

The owner field is not present in ListObjectsV2 by default. If you want to return the owner field with each key in the result, then set the FetchOwner field to true.

pub fn start_after(self, input: impl Into<String>) -> ListObjectsV2FluentBuilder

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 set_start_after( self, input: Option<String> ) -> ListObjectsV2FluentBuilder

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 get_start_after(&self) -> &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.

pub fn request_payer(self, input: RequestPayer) -> ListObjectsV2FluentBuilder

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 set_request_payer( self, input: Option<RequestPayer> ) -> ListObjectsV2FluentBuilder

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 get_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, input: impl Into<String> ) -> ListObjectsV2FluentBuilder

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

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 get_expected_bucket_owner(&self) -> &Option<String>

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 optional_object_attributes( self, input: OptionalObjectAttributes ) -> ListObjectsV2FluentBuilder

Appends an item to OptionalObjectAttributes.

To override the contents of this collection use set_optional_object_attributes.

Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

pub fn set_optional_object_attributes( self, input: Option<Vec<OptionalObjectAttributes, Global>> ) -> ListObjectsV2FluentBuilder

Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

pub fn get_optional_object_attributes( &self ) -> &Option<Vec<OptionalObjectAttributes, Global>>

Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

Trait Implementations

impl Clone for ListObjectsV2FluentBuilder

fn clone(&self) -> ListObjectsV2FluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListObjectsV2FluentBuilder

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

Formats the value using the given formatter.