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

#include <ListObjectsRequest.h>

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

Public Member Functions

 ListObjectsRequest ()
 
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)
 
ListObjectsRequestWithBucket (const Aws::String &value)
 
ListObjectsRequestWithBucket (Aws::String &&value)
 
ListObjectsRequestWithBucket (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)
 
ListObjectsRequestWithDelimiter (const Aws::String &value)
 
ListObjectsRequestWithDelimiter (Aws::String &&value)
 
ListObjectsRequestWithDelimiter (const char *value)
 
const EncodingTypeGetEncodingType () const
 
bool EncodingTypeHasBeenSet () const
 
void SetEncodingType (const EncodingType &value)
 
void SetEncodingType (EncodingType &&value)
 
ListObjectsRequestWithEncodingType (const EncodingType &value)
 
ListObjectsRequestWithEncodingType (EncodingType &&value)
 
const Aws::StringGetMarker () const
 
bool MarkerHasBeenSet () const
 
void SetMarker (const Aws::String &value)
 
void SetMarker (Aws::String &&value)
 
void SetMarker (const char *value)
 
ListObjectsRequestWithMarker (const Aws::String &value)
 
ListObjectsRequestWithMarker (Aws::String &&value)
 
ListObjectsRequestWithMarker (const char *value)
 
int GetMaxKeys () const
 
bool MaxKeysHasBeenSet () const
 
void SetMaxKeys (int value)
 
ListObjectsRequestWithMaxKeys (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)
 
ListObjectsRequestWithPrefix (const Aws::String &value)
 
ListObjectsRequestWithPrefix (Aws::String &&value)
 
ListObjectsRequestWithPrefix (const char *value)
 
const RequestPayerGetRequestPayer () const
 
bool RequestPayerHasBeenSet () const
 
void SetRequestPayer (const RequestPayer &value)
 
void SetRequestPayer (RequestPayer &&value)
 
ListObjectsRequestWithRequestPayer (const RequestPayer &value)
 
ListObjectsRequestWithRequestPayer (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)
 
ListObjectsRequestWithExpectedBucketOwner (const Aws::String &value)
 
ListObjectsRequestWithExpectedBucketOwner (Aws::String &&value)
 
ListObjectsRequestWithExpectedBucketOwner (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)
 
ListObjectsRequestWithCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
ListObjectsRequestWithCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
ListObjectsRequestAddCustomizedAccessLogTag (const Aws::String &key, const Aws::String &value)
 
ListObjectsRequestAddCustomizedAccessLogTag (Aws::String &&key, const Aws::String &value)
 
ListObjectsRequestAddCustomizedAccessLogTag (const Aws::String &key, Aws::String &&value)
 
ListObjectsRequestAddCustomizedAccessLogTag (Aws::String &&key, Aws::String &&value)
 
ListObjectsRequestAddCustomizedAccessLogTag (const char *key, Aws::String &&value)
 
ListObjectsRequestAddCustomizedAccessLogTag (Aws::String &&key, const char *value)
 
ListObjectsRequestAddCustomizedAccessLogTag (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 ListObjectsRequest.h.

Constructor & Destructor Documentation

◆ ListObjectsRequest()

Aws::S3::Model::ListObjectsRequest::ListObjectsRequest ( )

Member Function Documentation

◆ AddCustomizedAccessLogTag() [1/7]

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

Definition at line 505 of file ListObjectsRequest.h.

◆ AddCustomizedAccessLogTag() [2/7]

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

Definition at line 508 of file ListObjectsRequest.h.

◆ AddCustomizedAccessLogTag() [3/7]

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

Definition at line 511 of file ListObjectsRequest.h.

◆ AddCustomizedAccessLogTag() [4/7]

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

Definition at line 514 of file ListObjectsRequest.h.

◆ AddCustomizedAccessLogTag() [5/7]

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

Definition at line 517 of file ListObjectsRequest.h.

◆ AddCustomizedAccessLogTag() [6/7]

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

Definition at line 520 of file ListObjectsRequest.h.

◆ AddCustomizedAccessLogTag() [7/7]

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

Definition at line 523 of file ListObjectsRequest.h.

◆ AddQueryStringParameters()

void Aws::S3::Model::ListObjectsRequest::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::ListObjectsRequest::BucketHasBeenSet ( ) const
inline

The name of the bucket containing the objects.

When using this API 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 operation using an access point through the AWS 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 Simple Storage Service Developer Guide.

When using this API 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 operation using S3 on Outposts through the AWS 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 Simple Storage Service Developer Guide.

Definition at line 86 of file ListObjectsRequest.h.

◆ CustomizedAccessLogTagHasBeenSet()

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

Definition at line 490 of file ListObjectsRequest.h.

◆ DelimiterHasBeenSet()

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

A delimiter is a character you use to group keys.

Definition at line 223 of file ListObjectsRequest.h.

◆ EncodingTypeHasBeenSet()

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

Definition at line 260 of file ListObjectsRequest.h.

◆ ExpectedBucketOwnerHasBeenSet()

bool Aws::S3::Model::ListObjectsRequest::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 441 of file ListObjectsRequest.h.

◆ GetBucket()

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

The name of the bucket containing the objects.

When using this API 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 operation using an access point through the AWS 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 Simple Storage Service Developer Guide.

When using this API 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 operation using S3 on Outposts through the AWS 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 Simple Storage Service Developer Guide.

Definition at line 65 of file ListObjectsRequest.h.

◆ GetCustomizedAccessLogTag()

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

Definition at line 487 of file ListObjectsRequest.h.

◆ GetDelimiter()

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

A delimiter is a character you use to group keys.

Definition at line 218 of file ListObjectsRequest.h.

◆ GetEncodingType()

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

Definition at line 257 of file ListObjectsRequest.h.

◆ GetExpectedBucketOwner()

const Aws::String& Aws::S3::Model::ListObjectsRequest::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 434 of file ListObjectsRequest.h.

◆ GetMarker()

const Aws::String& Aws::S3::Model::ListObjectsRequest::GetMarker ( ) const
inline

Specifies the key to start with when listing objects in a bucket.

Definition at line 278 of file ListObjectsRequest.h.

◆ GetMaxKeys()

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

Sets the maximum number of keys returned in the response. By default the API returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

Definition at line 321 of file ListObjectsRequest.h.

◆ GetPrefix()

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

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

Definition at line 348 of file ListObjectsRequest.h.

◆ GetRequestPayer()

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

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

Definition at line 391 of file ListObjectsRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::S3::S3Request.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file ListObjectsRequest.h.

◆ MarkerHasBeenSet()

bool Aws::S3::Model::ListObjectsRequest::MarkerHasBeenSet ( ) const
inline

Specifies the key to start with when listing objects in a bucket.

Definition at line 283 of file ListObjectsRequest.h.

◆ MaxKeysHasBeenSet()

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

Sets the maximum number of keys returned in the response. By default the API returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

Definition at line 328 of file ListObjectsRequest.h.

◆ PrefixHasBeenSet()

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

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

Definition at line 353 of file ListObjectsRequest.h.

◆ RequestPayerHasBeenSet()

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

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

Definition at line 398 of file ListObjectsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBucket() [1/3]

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

The name of the bucket containing the objects.

When using this API 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 operation using an access point through the AWS 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 Simple Storage Service Developer Guide.

When using this API 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 operation using S3 on Outposts through the AWS 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 Simple Storage Service Developer Guide.

Definition at line 107 of file ListObjectsRequest.h.

◆ SetBucket() [2/3]

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

The name of the bucket containing the objects.

When using this API 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 operation using an access point through the AWS 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 Simple Storage Service Developer Guide.

When using this API 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 operation using S3 on Outposts through the AWS 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 Simple Storage Service Developer Guide.

Definition at line 128 of file ListObjectsRequest.h.

◆ SetBucket() [3/3]

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

The name of the bucket containing the objects.

When using this API 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 operation using an access point through the AWS 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 Simple Storage Service Developer Guide.

When using this API 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 operation using S3 on Outposts through the AWS 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 Simple Storage Service Developer Guide.

Definition at line 149 of file ListObjectsRequest.h.

◆ SetCustomizedAccessLogTag() [1/2]

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

Definition at line 493 of file ListObjectsRequest.h.

◆ SetCustomizedAccessLogTag() [2/2]

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

Definition at line 496 of file ListObjectsRequest.h.

◆ SetDelimiter() [1/3]

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

A delimiter is a character you use to group keys.

Definition at line 228 of file ListObjectsRequest.h.

◆ SetDelimiter() [2/3]

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

A delimiter is a character you use to group keys.

Definition at line 233 of file ListObjectsRequest.h.

◆ SetDelimiter() [3/3]

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

A delimiter is a character you use to group keys.

Definition at line 238 of file ListObjectsRequest.h.

◆ SetEncodingType() [1/2]

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

Definition at line 263 of file ListObjectsRequest.h.

◆ SetEncodingType() [2/2]

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

Definition at line 266 of file ListObjectsRequest.h.

◆ SetExpectedBucketOwner() [1/3]

void Aws::S3::Model::ListObjectsRequest::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 448 of file ListObjectsRequest.h.

◆ SetExpectedBucketOwner() [2/3]

void Aws::S3::Model::ListObjectsRequest::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 455 of file ListObjectsRequest.h.

◆ SetExpectedBucketOwner() [3/3]

void Aws::S3::Model::ListObjectsRequest::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 462 of file ListObjectsRequest.h.

◆ SetMarker() [1/3]

void Aws::S3::Model::ListObjectsRequest::SetMarker ( const Aws::String value)
inline

Specifies the key to start with when listing objects in a bucket.

Definition at line 288 of file ListObjectsRequest.h.

◆ SetMarker() [2/3]

void Aws::S3::Model::ListObjectsRequest::SetMarker ( Aws::String &&  value)
inline

Specifies the key to start with when listing objects in a bucket.

Definition at line 293 of file ListObjectsRequest.h.

◆ SetMarker() [3/3]

void Aws::S3::Model::ListObjectsRequest::SetMarker ( const char *  value)
inline

Specifies the key to start with when listing objects in a bucket.

Definition at line 298 of file ListObjectsRequest.h.

◆ SetMaxKeys()

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

Sets the maximum number of keys returned in the response. By default the API returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

Definition at line 335 of file ListObjectsRequest.h.

◆ SetPrefix() [1/3]

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

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

Definition at line 358 of file ListObjectsRequest.h.

◆ SetPrefix() [2/3]

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

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

Definition at line 363 of file ListObjectsRequest.h.

◆ SetPrefix() [3/3]

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

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

Definition at line 368 of file ListObjectsRequest.h.

◆ SetRequestPayer() [1/2]

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

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

Definition at line 405 of file ListObjectsRequest.h.

◆ SetRequestPayer() [2/2]

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

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

Definition at line 412 of file ListObjectsRequest.h.

◆ WithBucket() [1/3]

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

The name of the bucket containing the objects.

When using this API 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 operation using an access point through the AWS 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 Simple Storage Service Developer Guide.

When using this API 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 operation using S3 on Outposts through the AWS 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 Simple Storage Service Developer Guide.

Definition at line 170 of file ListObjectsRequest.h.

◆ WithBucket() [2/3]

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

The name of the bucket containing the objects.

When using this API 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 operation using an access point through the AWS 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 Simple Storage Service Developer Guide.

When using this API 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 operation using S3 on Outposts through the AWS 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 Simple Storage Service Developer Guide.

Definition at line 191 of file ListObjectsRequest.h.

◆ WithBucket() [3/3]

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

The name of the bucket containing the objects.

When using this API 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 operation using an access point through the AWS 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 Simple Storage Service Developer Guide.

When using this API 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 operation using S3 on Outposts through the AWS 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 Simple Storage Service Developer Guide.

Definition at line 212 of file ListObjectsRequest.h.

◆ WithCustomizedAccessLogTag() [1/2]

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

Definition at line 499 of file ListObjectsRequest.h.

◆ WithCustomizedAccessLogTag() [2/2]

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

Definition at line 502 of file ListObjectsRequest.h.

◆ WithDelimiter() [1/3]

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

A delimiter is a character you use to group keys.

Definition at line 243 of file ListObjectsRequest.h.

◆ WithDelimiter() [2/3]

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

A delimiter is a character you use to group keys.

Definition at line 248 of file ListObjectsRequest.h.

◆ WithDelimiter() [3/3]

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

A delimiter is a character you use to group keys.

Definition at line 253 of file ListObjectsRequest.h.

◆ WithEncodingType() [1/2]

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

Definition at line 269 of file ListObjectsRequest.h.

◆ WithEncodingType() [2/2]

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

Definition at line 272 of file ListObjectsRequest.h.

◆ WithExpectedBucketOwner() [1/3]

ListObjectsRequest& Aws::S3::Model::ListObjectsRequest::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 469 of file ListObjectsRequest.h.

◆ WithExpectedBucketOwner() [2/3]

ListObjectsRequest& Aws::S3::Model::ListObjectsRequest::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 476 of file ListObjectsRequest.h.

◆ WithExpectedBucketOwner() [3/3]

ListObjectsRequest& Aws::S3::Model::ListObjectsRequest::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 483 of file ListObjectsRequest.h.

◆ WithMarker() [1/3]

ListObjectsRequest& Aws::S3::Model::ListObjectsRequest::WithMarker ( const Aws::String value)
inline

Specifies the key to start with when listing objects in a bucket.

Definition at line 303 of file ListObjectsRequest.h.

◆ WithMarker() [2/3]

ListObjectsRequest& Aws::S3::Model::ListObjectsRequest::WithMarker ( Aws::String &&  value)
inline

Specifies the key to start with when listing objects in a bucket.

Definition at line 308 of file ListObjectsRequest.h.

◆ WithMarker() [3/3]

ListObjectsRequest& Aws::S3::Model::ListObjectsRequest::WithMarker ( const char *  value)
inline

Specifies the key to start with when listing objects in a bucket.

Definition at line 313 of file ListObjectsRequest.h.

◆ WithMaxKeys()

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

Sets the maximum number of keys returned in the response. By default the API returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

Definition at line 342 of file ListObjectsRequest.h.

◆ WithPrefix() [1/3]

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

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

Definition at line 373 of file ListObjectsRequest.h.

◆ WithPrefix() [2/3]

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

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

Definition at line 378 of file ListObjectsRequest.h.

◆ WithPrefix() [3/3]

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

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

Definition at line 383 of file ListObjectsRequest.h.

◆ WithRequestPayer() [1/2]

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

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

Definition at line 419 of file ListObjectsRequest.h.

◆ WithRequestPayer() [2/2]

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

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

Definition at line 426 of file ListObjectsRequest.h.


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