Aws::S3::Model::ListObjectsRequest Class Reference

#include <ListObjectsRequest.h>

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

Public Member Functions
AWS_S3_API	ListObjectsRequest ()
virtual const char *	GetServiceRequestName () const override
AWS_S3_API Aws::String	SerializePayload () const override
AWS_S3_API void	AddQueryStringParameters (Aws::Http::URI &uri) const override
AWS_S3_API Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override
AWS_S3_API EndpointParameters	GetEndpointContextParams () const override
const Aws::String &	GetBucket () const
bool	BucketHasBeenSet () const
void	SetBucket (const Aws::String &value)
void	SetBucket (Aws::String &&value)
void	SetBucket (const char *value)
ListObjectsRequest &	WithBucket (const Aws::String &value)
ListObjectsRequest &	WithBucket (Aws::String &&value)
ListObjectsRequest &	WithBucket (const char *value)
const Aws::String &	GetDelimiter () const
bool	DelimiterHasBeenSet () const
void	SetDelimiter (const Aws::String &value)
void	SetDelimiter (Aws::String &&value)
void	SetDelimiter (const char *value)
ListObjectsRequest &	WithDelimiter (const Aws::String &value)
ListObjectsRequest &	WithDelimiter (Aws::String &&value)
ListObjectsRequest &	WithDelimiter (const char *value)
const EncodingType &	GetEncodingType () const
bool	EncodingTypeHasBeenSet () const
void	SetEncodingType (const EncodingType &value)
void	SetEncodingType (EncodingType &&value)
ListObjectsRequest &	WithEncodingType (const EncodingType &value)
ListObjectsRequest &	WithEncodingType (EncodingType &&value)
const Aws::String &	GetMarker () const
bool	MarkerHasBeenSet () const
void	SetMarker (const Aws::String &value)
void	SetMarker (Aws::String &&value)
void	SetMarker (const char *value)
ListObjectsRequest &	WithMarker (const Aws::String &value)
ListObjectsRequest &	WithMarker (Aws::String &&value)
ListObjectsRequest &	WithMarker (const char *value)
int	GetMaxKeys () const
bool	MaxKeysHasBeenSet () const
void	SetMaxKeys (int value)
ListObjectsRequest &	WithMaxKeys (int value)
const Aws::String &	GetPrefix () const
bool	PrefixHasBeenSet () const
void	SetPrefix (const Aws::String &value)
void	SetPrefix (Aws::String &&value)
void	SetPrefix (const char *value)
ListObjectsRequest &	WithPrefix (const Aws::String &value)
ListObjectsRequest &	WithPrefix (Aws::String &&value)
ListObjectsRequest &	WithPrefix (const char *value)
const RequestPayer &	GetRequestPayer () const
bool	RequestPayerHasBeenSet () const
void	SetRequestPayer (const RequestPayer &value)
void	SetRequestPayer (RequestPayer &&value)
ListObjectsRequest &	WithRequestPayer (const RequestPayer &value)
ListObjectsRequest &	WithRequestPayer (RequestPayer &&value)
const Aws::String &	GetExpectedBucketOwner () const
bool	ExpectedBucketOwnerHasBeenSet () const
void	SetExpectedBucketOwner (const Aws::String &value)
void	SetExpectedBucketOwner (Aws::String &&value)
void	SetExpectedBucketOwner (const char *value)
ListObjectsRequest &	WithExpectedBucketOwner (const Aws::String &value)
ListObjectsRequest &	WithExpectedBucketOwner (Aws::String &&value)
ListObjectsRequest &	WithExpectedBucketOwner (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)
ListObjectsRequest &	WithCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
ListObjectsRequest &	WithCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
ListObjectsRequest &	AddCustomizedAccessLogTag (const Aws::String &key, const Aws::String &value)
ListObjectsRequest &	AddCustomizedAccessLogTag (Aws::String &&key, const Aws::String &value)
ListObjectsRequest &	AddCustomizedAccessLogTag (const Aws::String &key, Aws::String &&value)
ListObjectsRequest &	AddCustomizedAccessLogTag (Aws::String &&key, Aws::String &&value)
ListObjectsRequest &	AddCustomizedAccessLogTag (const char *key, Aws::String &&value)
ListObjectsRequest &	AddCustomizedAccessLogTag (Aws::String &&key, const char *value)
ListObjectsRequest &	AddCustomizedAccessLogTag (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 ()
virtual Aws::String	SerializePayload () const=0
std::shared_ptr< Aws::IOStream >	GetBody () const override
Public Member Functions inherited from Aws::AmazonWebServiceRequest
	AmazonWebServiceRequest ()
virtual	~AmazonWebServiceRequest ()=default
virtual std::shared_ptr< Aws::IOStream >	GetBody () const=0
virtual Aws::Http::HeaderValueCollection	GetHeaders () const=0
virtual const Aws::Http::HeaderValueCollection &	GetAdditionalCustomHeaders () const
virtual void	SetAdditionalCustomHeaderValue (const Aws::String &headerName, const Aws::String &headerValue)
virtual void	AddQueryStringParameters (Aws::Http::URI &uri) const
virtual void	PutToPresignedUrl (Aws::Http::URI &uri) const
virtual bool	IsStreaming () const
virtual bool	IsEventStreamRequest () const
virtual bool	SignBody () const
virtual bool	HasEmbeddedError (Aws::IOStream &body, const Aws::Http::HeaderValueCollection &header) const
virtual bool	IsChunked () const
virtual void	SetRequestSignedHandler (const RequestSignedHandler &handler)
virtual const RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () 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::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () const
virtual bool	ShouldComputeContentMd5 () const
virtual bool	ShouldValidateResponseChecksum () const
virtual Aws::Vector< Aws::String >	GetResponseChecksumAlgorithmNames () const
virtual Aws::String	GetChecksumAlgorithmName () const
virtual const char *	GetServiceRequestName () const=0
virtual EndpointParameters	GetEndpointContextParams () const

Additional Inherited Members
Public Types inherited from Aws::S3::S3Request
using	EndpointParameter = Aws::Endpoint::EndpointParameter
using	EndpointParameters = Aws::Endpoint::EndpointParameters
Public Types inherited from Aws::AmazonWebServiceRequest
typedef Aws::Vector< Aws::Endpoint::EndpointParameter >	EndpointParameters
virtual Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const
Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void	DumpBodyToUrl (Aws::Http::URI &uri) const
Protected Attributes inherited from Aws::AmazonWebServiceRequest
Aws::Http::HeaderValueCollection	m_additionalCustomHeaders

Detailed Description

Definition at line 28 of file ListObjectsRequest.h.

Constructor & Destructor Documentation

ListObjectsRequest()

AWS_S3_API Aws::S3::Model::ListObjectsRequest::ListObjectsRequest

(

)

Member Function Documentation

AddCustomizedAccessLogTag() [1/7]

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

inline

Definition at line 526 of file ListObjectsRequest.h.

AddCustomizedAccessLogTag() [2/7]

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

inline

Definition at line 520 of file ListObjectsRequest.h.

AddCustomizedAccessLogTag() [3/7]

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

inline

Definition at line 532 of file ListObjectsRequest.h.

AddCustomizedAccessLogTag() [4/7]

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

inline

Definition at line 523 of file ListObjectsRequest.h.

AddCustomizedAccessLogTag() [5/7]

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

inline

Definition at line 517 of file ListObjectsRequest.h.

AddCustomizedAccessLogTag() [6/7]

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

inline

Definition at line 529 of file ListObjectsRequest.h.

AddCustomizedAccessLogTag() [7/7]

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

inline

Definition at line 535 of file ListObjectsRequest.h.

AddQueryStringParameters()

AWS_S3_API void Aws::S3::Model::ListObjectsRequest::AddQueryStringParameters ( Aws::Http::URI &  uri ) const

overridevirtual

Reimplemented from Aws::AmazonWebServiceRequest.

BucketHasBeenSet()

bool Aws::S3::Model::ListObjectsRequest::BucketHasBeenSet ( ) const

inline

The name of the bucket containing the objects.

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 with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.

Definition at line 90 of file ListObjectsRequest.h.

CustomizedAccessLogTagHasBeenSet()

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

inline

Definition at line 502 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 227 of file ListObjectsRequest.h.

EncodingTypeHasBeenSet()

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

inline

Definition at line 264 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 fails with the HTTP status code 403 Forbidden (access denied).

Definition at line 453 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 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 with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.

Definition at line 69 of file ListObjectsRequest.h.

GetCustomizedAccessLogTag()

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

inline

Definition at line 499 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 222 of file ListObjectsRequest.h.

GetEncodingType()

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

inline

Definition at line 261 of file ListObjectsRequest.h.

GetEndpointContextParams()

AWS_S3_API EndpointParameters Aws::S3::Model::ListObjectsRequest::GetEndpointContextParams ( ) const

overridevirtual

Helper function to collect parameters (configurable and static hardcoded) required for endpoint computation.

Reimplemented from Aws::AmazonWebServiceRequest.

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 fails with the HTTP status code 403 Forbidden (access denied).

Definition at line 446 of file ListObjectsRequest.h.

GetMarker()

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

inline

Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.

Definition at line 283 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 action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

Definition at line 333 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 360 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 403 of file ListObjectsRequest.h.

GetRequestSpecificHeaders()

AWS_S3_API 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

Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.

Definition at line 289 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 action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

Definition at line 340 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 365 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 410 of file ListObjectsRequest.h.

SerializePayload()

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

overridevirtual

Implements Aws::AmazonSerializableWebServiceRequest.

SetBucket() [1/3]

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

inline

The name of the bucket containing the objects.

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 with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.

Definition at line 132 of file ListObjectsRequest.h.

SetBucket() [2/3]

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

inline

The name of the bucket containing the objects.

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 with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.

Definition at line 111 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 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 with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.

Definition at line 153 of file ListObjectsRequest.h.

SetCustomizedAccessLogTag() [1/2]

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

inline

Definition at line 508 of file ListObjectsRequest.h.

SetCustomizedAccessLogTag() [2/2]

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

inline

Definition at line 505 of file ListObjectsRequest.h.

SetDelimiter() [1/3]

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

inline

A delimiter is a character you use to group keys.

Definition at line 237 of file ListObjectsRequest.h.

SetDelimiter() [2/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 232 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 242 of file ListObjectsRequest.h.

SetEncodingType() [1/2]

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

inline

Definition at line 267 of file ListObjectsRequest.h.

SetEncodingType() [2/2]

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

inline

Definition at line 270 of file ListObjectsRequest.h.

SetExpectedBucketOwner() [1/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 fails with the HTTP status code 403 Forbidden (access denied).

Definition at line 467 of file ListObjectsRequest.h.

SetExpectedBucketOwner() [2/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 fails with the HTTP status code 403 Forbidden (access denied).

Definition at line 460 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 fails with the HTTP status code 403 Forbidden (access denied).

Definition at line 474 of file ListObjectsRequest.h.

SetMarker() [1/3]

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

inline

Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.

Definition at line 301 of file ListObjectsRequest.h.

SetMarker() [2/3]

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

inline

Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.

Definition at line 295 of file ListObjectsRequest.h.

SetMarker() [3/3]

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

inline

Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.

Definition at line 307 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 action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

Definition at line 347 of file ListObjectsRequest.h.

SetPrefix() [1/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 375 of file ListObjectsRequest.h.

SetPrefix() [2/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 370 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 380 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 417 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 424 of file ListObjectsRequest.h.

WithBucket() [1/3]

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

inline

The name of the bucket containing the objects.

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 with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.

Definition at line 195 of file ListObjectsRequest.h.

WithBucket() [2/3]

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

inline

The name of the bucket containing the objects.

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 with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.

Definition at line 174 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 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 with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.

Definition at line 216 of file ListObjectsRequest.h.

WithCustomizedAccessLogTag() [1/2]

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

inline

Definition at line 514 of file ListObjectsRequest.h.

WithCustomizedAccessLogTag() [2/2]

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

inline

Definition at line 511 of file ListObjectsRequest.h.

WithDelimiter() [1/3]

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

inline

A delimiter is a character you use to group keys.

Definition at line 252 of file ListObjectsRequest.h.

WithDelimiter() [2/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 247 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 257 of file ListObjectsRequest.h.

WithEncodingType() [1/2]

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

inline

Definition at line 273 of file ListObjectsRequest.h.

WithEncodingType() [2/2]

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

inline

Definition at line 276 of file ListObjectsRequest.h.

WithExpectedBucketOwner() [1/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 fails with the HTTP status code 403 Forbidden (access denied).

Definition at line 488 of file ListObjectsRequest.h.

WithExpectedBucketOwner() [2/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 fails with the HTTP status code 403 Forbidden (access denied).

Definition at line 481 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 fails with the HTTP status code 403 Forbidden (access denied).

Definition at line 495 of file ListObjectsRequest.h.

WithMarker() [1/3]

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

inline

Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.

Definition at line 319 of file ListObjectsRequest.h.

WithMarker() [2/3]

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

inline

Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.

Definition at line 313 of file ListObjectsRequest.h.

WithMarker() [3/3]

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

inline

Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.

Definition at line 325 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 action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

Definition at line 354 of file ListObjectsRequest.h.

WithPrefix() [1/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 390 of file ListObjectsRequest.h.

WithPrefix() [2/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 385 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 395 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 431 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 438 of file ListObjectsRequest.h.

---

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

• aws-cpp-sdk-s3/include/aws/s3/model/ListObjectsRequest.h