Struct aws_sdk_s3::operation::list_objects_v2::builders::ListObjectsV2InputBuilder

#[non_exhaustive]
pub struct ListObjectsV2InputBuilder { /* private fields */ }

A builder for ListObjectsV2Input.

Implementations

impl ListObjectsV2InputBuilder

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

Appends an item to optional_object_attributes.

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

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

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

pub fn build(self) -> Result<ListObjectsV2Input, BuildError>

Consumes the builder and constructs a ListObjectsV2Input.

impl ListObjectsV2InputBuilder

pub async fn send_with( self, client: &Client ) -> Result<ListObjectsV2Output, SdkError<ListObjectsV2Error, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for ListObjectsV2InputBuilder

fn clone(&self) -> ListObjectsV2InputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListObjectsV2InputBuilder

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

Formats the value using the given formatter.

impl Default for ListObjectsV2InputBuilder

fn default() -> ListObjectsV2InputBuilder

Returns the “default value” for a type.

impl PartialEq<ListObjectsV2InputBuilder> for ListObjectsV2InputBuilder

fn eq(&self, other: &ListObjectsV2InputBuilder) -> 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 StructuralPartialEq for ListObjectsV2InputBuilder