AWS SDK for C++  1.9.130
AWS SDK for C++
Public Member Functions | List of all members
Aws::S3::Model::ListObjectsV2Request Class Reference

#include <ListObjectsV2Request.h>

+ Inheritance diagram for Aws::S3::Model::ListObjectsV2Request:

Public Member Functions

 ListObjectsV2Request ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetBucket () const
 
bool BucketHasBeenSet () const
 
void SetBucket (const Aws::String &value)
 
void SetBucket (Aws::String &&value)
 
void SetBucket (const char *value)
 
ListObjectsV2RequestWithBucket (const Aws::String &value)
 
ListObjectsV2RequestWithBucket (Aws::String &&value)
 
ListObjectsV2RequestWithBucket (const char *value)
 
const Aws::StringGetDelimiter () const
 
bool DelimiterHasBeenSet () const
 
void SetDelimiter (const Aws::String &value)
 
void SetDelimiter (Aws::String &&value)
 
void SetDelimiter (const char *value)
 
ListObjectsV2RequestWithDelimiter (const Aws::String &value)
 
ListObjectsV2RequestWithDelimiter (Aws::String &&value)
 
ListObjectsV2RequestWithDelimiter (const char *value)
 
const EncodingTypeGetEncodingType () const
 
bool EncodingTypeHasBeenSet () const
 
void SetEncodingType (const EncodingType &value)
 
void SetEncodingType (EncodingType &&value)
 
ListObjectsV2RequestWithEncodingType (const EncodingType &value)
 
ListObjectsV2RequestWithEncodingType (EncodingType &&value)
 
int GetMaxKeys () const
 
bool MaxKeysHasBeenSet () const
 
void SetMaxKeys (int value)
 
ListObjectsV2RequestWithMaxKeys (int value)
 
const Aws::StringGetPrefix () const
 
bool PrefixHasBeenSet () const
 
void SetPrefix (const Aws::String &value)
 
void SetPrefix (Aws::String &&value)
 
void SetPrefix (const char *value)
 
ListObjectsV2RequestWithPrefix (const Aws::String &value)
 
ListObjectsV2RequestWithPrefix (Aws::String &&value)
 
ListObjectsV2RequestWithPrefix (const char *value)
 
const Aws::StringGetContinuationToken () const
 
bool ContinuationTokenHasBeenSet () const
 
void SetContinuationToken (const Aws::String &value)
 
void SetContinuationToken (Aws::String &&value)
 
void SetContinuationToken (const char *value)
 
ListObjectsV2RequestWithContinuationToken (const Aws::String &value)
 
ListObjectsV2RequestWithContinuationToken (Aws::String &&value)
 
ListObjectsV2RequestWithContinuationToken (const char *value)
 
bool GetFetchOwner () const
 
bool FetchOwnerHasBeenSet () const
 
void SetFetchOwner (bool value)
 
ListObjectsV2RequestWithFetchOwner (bool value)
 
const Aws::StringGetStartAfter () const
 
bool StartAfterHasBeenSet () const
 
void SetStartAfter (const Aws::String &value)
 
void SetStartAfter (Aws::String &&value)
 
void SetStartAfter (const char *value)
 
ListObjectsV2RequestWithStartAfter (const Aws::String &value)
 
ListObjectsV2RequestWithStartAfter (Aws::String &&value)
 
ListObjectsV2RequestWithStartAfter (const char *value)
 
const RequestPayerGetRequestPayer () const
 
bool RequestPayerHasBeenSet () const
 
void SetRequestPayer (const RequestPayer &value)
 
void SetRequestPayer (RequestPayer &&value)
 
ListObjectsV2RequestWithRequestPayer (const RequestPayer &value)
 
ListObjectsV2RequestWithRequestPayer (RequestPayer &&value)
 
const Aws::StringGetExpectedBucketOwner () const
 
bool ExpectedBucketOwnerHasBeenSet () const
 
void SetExpectedBucketOwner (const Aws::String &value)
 
void SetExpectedBucketOwner (Aws::String &&value)
 
void SetExpectedBucketOwner (const char *value)
 
ListObjectsV2RequestWithExpectedBucketOwner (const Aws::String &value)
 
ListObjectsV2RequestWithExpectedBucketOwner (Aws::String &&value)
 
ListObjectsV2RequestWithExpectedBucketOwner (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag () const
 
bool CustomizedAccessLogTagHasBeenSet () const
 
void SetCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
ListObjectsV2RequestWithCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
ListObjectsV2RequestWithCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
ListObjectsV2RequestAddCustomizedAccessLogTag (const Aws::String &key, const Aws::String &value)
 
ListObjectsV2RequestAddCustomizedAccessLogTag (Aws::String &&key, const Aws::String &value)
 
ListObjectsV2RequestAddCustomizedAccessLogTag (const Aws::String &key, Aws::String &&value)
 
ListObjectsV2RequestAddCustomizedAccessLogTag (Aws::String &&key, Aws::String &&value)
 
ListObjectsV2RequestAddCustomizedAccessLogTag (const char *key, Aws::String &&value)
 
ListObjectsV2RequestAddCustomizedAccessLogTag (Aws::String &&key, const char *value)
 
ListObjectsV2RequestAddCustomizedAccessLogTag (const char *key, const char *value)
 
- Public Member Functions inherited from Aws::S3::S3Request
virtual ~S3Request ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 28 of file ListObjectsV2Request.h.

Constructor & Destructor Documentation

◆ ListObjectsV2Request()

Aws::S3::Model::ListObjectsV2Request::ListObjectsV2Request ( )

Member Function Documentation

◆ AddCustomizedAccessLogTag() [1/7]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::AddCustomizedAccessLogTag ( Aws::String &&  key,
Aws::String &&  value 
)
inline

Definition at line 628 of file ListObjectsV2Request.h.

◆ AddCustomizedAccessLogTag() [2/7]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::AddCustomizedAccessLogTag ( Aws::String &&  key,
const Aws::String value 
)
inline

Definition at line 622 of file ListObjectsV2Request.h.

◆ AddCustomizedAccessLogTag() [3/7]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::AddCustomizedAccessLogTag ( Aws::String &&  key,
const char *  value 
)
inline

Definition at line 634 of file ListObjectsV2Request.h.

◆ AddCustomizedAccessLogTag() [4/7]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::AddCustomizedAccessLogTag ( const Aws::String key,
Aws::String &&  value 
)
inline

Definition at line 625 of file ListObjectsV2Request.h.

◆ AddCustomizedAccessLogTag() [5/7]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::AddCustomizedAccessLogTag ( const Aws::String key,
const Aws::String value 
)
inline

Definition at line 619 of file ListObjectsV2Request.h.

◆ AddCustomizedAccessLogTag() [6/7]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::AddCustomizedAccessLogTag ( const char *  key,
Aws::String &&  value 
)
inline

Definition at line 631 of file ListObjectsV2Request.h.

◆ AddCustomizedAccessLogTag() [7/7]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::AddCustomizedAccessLogTag ( const char *  key,
const char *  value 
)
inline

Definition at line 637 of file ListObjectsV2Request.h.

◆ AddQueryStringParameters()

void Aws::S3::Model::ListObjectsV2Request::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

Do nothing virtual, override this to add query strings to the request

Reimplemented from Aws::AmazonWebServiceRequest.

◆ BucketHasBeenSet()

bool Aws::S3::Model::ListObjectsV2Request::BucketHasBeenSet ( ) const
inline

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.

Definition at line 86 of file ListObjectsV2Request.h.

◆ ContinuationTokenHasBeenSet()

bool Aws::S3::Model::ListObjectsV2Request::ContinuationTokenHasBeenSet ( ) const
inline

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.

Definition at line 369 of file ListObjectsV2Request.h.

◆ CustomizedAccessLogTagHasBeenSet()

bool Aws::S3::Model::ListObjectsV2Request::CustomizedAccessLogTagHasBeenSet ( ) const
inline

Definition at line 604 of file ListObjectsV2Request.h.

◆ DelimiterHasBeenSet()

bool Aws::S3::Model::ListObjectsV2Request::DelimiterHasBeenSet ( ) const
inline

A delimiter is a character you use to group keys.

Definition at line 223 of file ListObjectsV2Request.h.

◆ EncodingTypeHasBeenSet()

bool Aws::S3::Model::ListObjectsV2Request::EncodingTypeHasBeenSet ( ) const
inline

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

Definition at line 264 of file ListObjectsV2Request.h.

◆ ExpectedBucketOwnerHasBeenSet()

bool Aws::S3::Model::ListObjectsV2Request::ExpectedBucketOwnerHasBeenSet ( ) const
inline

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.

Definition at line 555 of file ListObjectsV2Request.h.

◆ FetchOwnerHasBeenSet()

bool Aws::S3::Model::ListObjectsV2Request::FetchOwnerHasBeenSet ( ) const
inline

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.

Definition at line 426 of file ListObjectsV2Request.h.

◆ GetBucket()

const Aws::String& Aws::S3::Model::ListObjectsV2Request::GetBucket ( ) const
inline

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.

Definition at line 65 of file ListObjectsV2Request.h.

◆ GetContinuationToken()

const Aws::String& Aws::S3::Model::ListObjectsV2Request::GetContinuationToken ( ) const
inline

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.

Definition at line 362 of file ListObjectsV2Request.h.

◆ GetCustomizedAccessLogTag()

const Aws::Map<Aws::String, Aws::String>& Aws::S3::Model::ListObjectsV2Request::GetCustomizedAccessLogTag ( ) const
inline

Definition at line 601 of file ListObjectsV2Request.h.

◆ GetDelimiter()

const Aws::String& Aws::S3::Model::ListObjectsV2Request::GetDelimiter ( ) const
inline

A delimiter is a character you use to group keys.

Definition at line 218 of file ListObjectsV2Request.h.

◆ GetEncodingType()

const EncodingType& Aws::S3::Model::ListObjectsV2Request::GetEncodingType ( ) const
inline

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

Definition at line 259 of file ListObjectsV2Request.h.

◆ GetExpectedBucketOwner()

const Aws::String& Aws::S3::Model::ListObjectsV2Request::GetExpectedBucketOwner ( ) const
inline

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.

Definition at line 548 of file ListObjectsV2Request.h.

◆ GetFetchOwner()

bool Aws::S3::Model::ListObjectsV2Request::GetFetchOwner ( ) const
inline

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.

Definition at line 419 of file ListObjectsV2Request.h.

◆ GetMaxKeys()

int Aws::S3::Model::ListObjectsV2Request::GetMaxKeys ( ) const
inline

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.

Definition at line 292 of file ListObjectsV2Request.h.

◆ GetPrefix()

const Aws::String& Aws::S3::Model::ListObjectsV2Request::GetPrefix ( ) const
inline

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

Definition at line 319 of file ListObjectsV2Request.h.

◆ GetRequestPayer()

const RequestPayer& Aws::S3::Model::ListObjectsV2Request::GetRequestPayer ( ) const
inline

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.

Definition at line 505 of file ListObjectsV2Request.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::S3::Model::ListObjectsV2Request::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::S3::S3Request.

◆ GetServiceRequestName()

virtual const char* Aws::S3::Model::ListObjectsV2Request::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file ListObjectsV2Request.h.

◆ GetStartAfter()

const Aws::String& Aws::S3::Model::ListObjectsV2Request::GetStartAfter ( ) const
inline

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.

Definition at line 448 of file ListObjectsV2Request.h.

◆ MaxKeysHasBeenSet()

bool Aws::S3::Model::ListObjectsV2Request::MaxKeysHasBeenSet ( ) const
inline

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.

Definition at line 299 of file ListObjectsV2Request.h.

◆ PrefixHasBeenSet()

bool Aws::S3::Model::ListObjectsV2Request::PrefixHasBeenSet ( ) const
inline

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

Definition at line 324 of file ListObjectsV2Request.h.

◆ RequestPayerHasBeenSet()

bool Aws::S3::Model::ListObjectsV2Request::RequestPayerHasBeenSet ( ) const
inline

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.

Definition at line 512 of file ListObjectsV2Request.h.

◆ SerializePayload()

Aws::String Aws::S3::Model::ListObjectsV2Request::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBucket() [1/3]

void Aws::S3::Model::ListObjectsV2Request::SetBucket ( Aws::String &&  value)
inline

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.

Definition at line 128 of file ListObjectsV2Request.h.

◆ SetBucket() [2/3]

void Aws::S3::Model::ListObjectsV2Request::SetBucket ( const Aws::String value)
inline

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.

Definition at line 107 of file ListObjectsV2Request.h.

◆ SetBucket() [3/3]

void Aws::S3::Model::ListObjectsV2Request::SetBucket ( const char *  value)
inline

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.

Definition at line 149 of file ListObjectsV2Request.h.

◆ SetContinuationToken() [1/3]

void Aws::S3::Model::ListObjectsV2Request::SetContinuationToken ( Aws::String &&  value)
inline

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.

Definition at line 383 of file ListObjectsV2Request.h.

◆ SetContinuationToken() [2/3]

void Aws::S3::Model::ListObjectsV2Request::SetContinuationToken ( const Aws::String value)
inline

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.

Definition at line 376 of file ListObjectsV2Request.h.

◆ SetContinuationToken() [3/3]

void Aws::S3::Model::ListObjectsV2Request::SetContinuationToken ( const char *  value)
inline

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.

Definition at line 390 of file ListObjectsV2Request.h.

◆ SetCustomizedAccessLogTag() [1/2]

void Aws::S3::Model::ListObjectsV2Request::SetCustomizedAccessLogTag ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Definition at line 610 of file ListObjectsV2Request.h.

◆ SetCustomizedAccessLogTag() [2/2]

void Aws::S3::Model::ListObjectsV2Request::SetCustomizedAccessLogTag ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Definition at line 607 of file ListObjectsV2Request.h.

◆ SetDelimiter() [1/3]

void Aws::S3::Model::ListObjectsV2Request::SetDelimiter ( Aws::String &&  value)
inline

A delimiter is a character you use to group keys.

Definition at line 233 of file ListObjectsV2Request.h.

◆ SetDelimiter() [2/3]

void Aws::S3::Model::ListObjectsV2Request::SetDelimiter ( const Aws::String value)
inline

A delimiter is a character you use to group keys.

Definition at line 228 of file ListObjectsV2Request.h.

◆ SetDelimiter() [3/3]

void Aws::S3::Model::ListObjectsV2Request::SetDelimiter ( const char *  value)
inline

A delimiter is a character you use to group keys.

Definition at line 238 of file ListObjectsV2Request.h.

◆ SetEncodingType() [1/2]

void Aws::S3::Model::ListObjectsV2Request::SetEncodingType ( const EncodingType value)
inline

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

Definition at line 269 of file ListObjectsV2Request.h.

◆ SetEncodingType() [2/2]

void Aws::S3::Model::ListObjectsV2Request::SetEncodingType ( EncodingType &&  value)
inline

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

Definition at line 274 of file ListObjectsV2Request.h.

◆ SetExpectedBucketOwner() [1/3]

void Aws::S3::Model::ListObjectsV2Request::SetExpectedBucketOwner ( Aws::String &&  value)
inline

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.

Definition at line 569 of file ListObjectsV2Request.h.

◆ SetExpectedBucketOwner() [2/3]

void Aws::S3::Model::ListObjectsV2Request::SetExpectedBucketOwner ( const Aws::String value)
inline

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.

Definition at line 562 of file ListObjectsV2Request.h.

◆ SetExpectedBucketOwner() [3/3]

void Aws::S3::Model::ListObjectsV2Request::SetExpectedBucketOwner ( const char *  value)
inline

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.

Definition at line 576 of file ListObjectsV2Request.h.

◆ SetFetchOwner()

void Aws::S3::Model::ListObjectsV2Request::SetFetchOwner ( bool  value)
inline

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.

Definition at line 433 of file ListObjectsV2Request.h.

◆ SetMaxKeys()

void Aws::S3::Model::ListObjectsV2Request::SetMaxKeys ( int  value)
inline

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.

Definition at line 306 of file ListObjectsV2Request.h.

◆ SetPrefix() [1/3]

void Aws::S3::Model::ListObjectsV2Request::SetPrefix ( Aws::String &&  value)
inline

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

Definition at line 334 of file ListObjectsV2Request.h.

◆ SetPrefix() [2/3]

void Aws::S3::Model::ListObjectsV2Request::SetPrefix ( const Aws::String value)
inline

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

Definition at line 329 of file ListObjectsV2Request.h.

◆ SetPrefix() [3/3]

void Aws::S3::Model::ListObjectsV2Request::SetPrefix ( const char *  value)
inline

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

Definition at line 339 of file ListObjectsV2Request.h.

◆ SetRequestPayer() [1/2]

void Aws::S3::Model::ListObjectsV2Request::SetRequestPayer ( const RequestPayer value)
inline

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.

Definition at line 519 of file ListObjectsV2Request.h.

◆ SetRequestPayer() [2/2]

void Aws::S3::Model::ListObjectsV2Request::SetRequestPayer ( RequestPayer &&  value)
inline

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.

Definition at line 526 of file ListObjectsV2Request.h.

◆ SetStartAfter() [1/3]

void Aws::S3::Model::ListObjectsV2Request::SetStartAfter ( Aws::String &&  value)
inline

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.

Definition at line 469 of file ListObjectsV2Request.h.

◆ SetStartAfter() [2/3]

void Aws::S3::Model::ListObjectsV2Request::SetStartAfter ( const Aws::String value)
inline

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.

Definition at line 462 of file ListObjectsV2Request.h.

◆ SetStartAfter() [3/3]

void Aws::S3::Model::ListObjectsV2Request::SetStartAfter ( const char *  value)
inline

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.

Definition at line 476 of file ListObjectsV2Request.h.

◆ StartAfterHasBeenSet()

bool Aws::S3::Model::ListObjectsV2Request::StartAfterHasBeenSet ( ) const
inline

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.

Definition at line 455 of file ListObjectsV2Request.h.

◆ WithBucket() [1/3]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithBucket ( Aws::String &&  value)
inline

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.

Definition at line 191 of file ListObjectsV2Request.h.

◆ WithBucket() [2/3]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithBucket ( const Aws::String value)
inline

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.

Definition at line 170 of file ListObjectsV2Request.h.

◆ WithBucket() [3/3]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithBucket ( const char *  value)
inline

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.

Definition at line 212 of file ListObjectsV2Request.h.

◆ WithContinuationToken() [1/3]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithContinuationToken ( Aws::String &&  value)
inline

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.

Definition at line 404 of file ListObjectsV2Request.h.

◆ WithContinuationToken() [2/3]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithContinuationToken ( const Aws::String value)
inline

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.

Definition at line 397 of file ListObjectsV2Request.h.

◆ WithContinuationToken() [3/3]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithContinuationToken ( const char *  value)
inline

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.

Definition at line 411 of file ListObjectsV2Request.h.

◆ WithCustomizedAccessLogTag() [1/2]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithCustomizedAccessLogTag ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Definition at line 616 of file ListObjectsV2Request.h.

◆ WithCustomizedAccessLogTag() [2/2]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithCustomizedAccessLogTag ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Definition at line 613 of file ListObjectsV2Request.h.

◆ WithDelimiter() [1/3]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithDelimiter ( Aws::String &&  value)
inline

A delimiter is a character you use to group keys.

Definition at line 248 of file ListObjectsV2Request.h.

◆ WithDelimiter() [2/3]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithDelimiter ( const Aws::String value)
inline

A delimiter is a character you use to group keys.

Definition at line 243 of file ListObjectsV2Request.h.

◆ WithDelimiter() [3/3]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithDelimiter ( const char *  value)
inline

A delimiter is a character you use to group keys.

Definition at line 253 of file ListObjectsV2Request.h.

◆ WithEncodingType() [1/2]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithEncodingType ( const EncodingType value)
inline

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

Definition at line 279 of file ListObjectsV2Request.h.

◆ WithEncodingType() [2/2]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithEncodingType ( EncodingType &&  value)
inline

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

Definition at line 284 of file ListObjectsV2Request.h.

◆ WithExpectedBucketOwner() [1/3]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithExpectedBucketOwner ( Aws::String &&  value)
inline

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.

Definition at line 590 of file ListObjectsV2Request.h.

◆ WithExpectedBucketOwner() [2/3]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithExpectedBucketOwner ( const Aws::String value)
inline

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.

Definition at line 583 of file ListObjectsV2Request.h.

◆ WithExpectedBucketOwner() [3/3]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithExpectedBucketOwner ( const char *  value)
inline

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.

Definition at line 597 of file ListObjectsV2Request.h.

◆ WithFetchOwner()

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithFetchOwner ( bool  value)
inline

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.

Definition at line 440 of file ListObjectsV2Request.h.

◆ WithMaxKeys()

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithMaxKeys ( int  value)
inline

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.

Definition at line 313 of file ListObjectsV2Request.h.

◆ WithPrefix() [1/3]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithPrefix ( Aws::String &&  value)
inline

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

Definition at line 349 of file ListObjectsV2Request.h.

◆ WithPrefix() [2/3]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithPrefix ( const Aws::String value)
inline

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

Definition at line 344 of file ListObjectsV2Request.h.

◆ WithPrefix() [3/3]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithPrefix ( const char *  value)
inline

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

Definition at line 354 of file ListObjectsV2Request.h.

◆ WithRequestPayer() [1/2]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithRequestPayer ( const RequestPayer value)
inline

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.

Definition at line 533 of file ListObjectsV2Request.h.

◆ WithRequestPayer() [2/2]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithRequestPayer ( RequestPayer &&  value)
inline

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.

Definition at line 540 of file ListObjectsV2Request.h.

◆ WithStartAfter() [1/3]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithStartAfter ( Aws::String &&  value)
inline

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.

Definition at line 490 of file ListObjectsV2Request.h.

◆ WithStartAfter() [2/3]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithStartAfter ( const Aws::String value)
inline

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.

Definition at line 483 of file ListObjectsV2Request.h.

◆ WithStartAfter() [3/3]

ListObjectsV2Request& Aws::S3::Model::ListObjectsV2Request::WithStartAfter ( const char *  value)
inline

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.

Definition at line 497 of file ListObjectsV2Request.h.


The documentation for this class was generated from the following file: