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

#include <ListMultipartUploadsRequest.h>

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

Public Member Functions

 ListMultipartUploadsRequest ()
 
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)
 
ListMultipartUploadsRequestWithBucket (const Aws::String &value)
 
ListMultipartUploadsRequestWithBucket (Aws::String &&value)
 
ListMultipartUploadsRequestWithBucket (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)
 
ListMultipartUploadsRequestWithDelimiter (const Aws::String &value)
 
ListMultipartUploadsRequestWithDelimiter (Aws::String &&value)
 
ListMultipartUploadsRequestWithDelimiter (const char *value)
 
const EncodingTypeGetEncodingType () const
 
bool EncodingTypeHasBeenSet () const
 
void SetEncodingType (const EncodingType &value)
 
void SetEncodingType (EncodingType &&value)
 
ListMultipartUploadsRequestWithEncodingType (const EncodingType &value)
 
ListMultipartUploadsRequestWithEncodingType (EncodingType &&value)
 
const Aws::StringGetKeyMarker () const
 
bool KeyMarkerHasBeenSet () const
 
void SetKeyMarker (const Aws::String &value)
 
void SetKeyMarker (Aws::String &&value)
 
void SetKeyMarker (const char *value)
 
ListMultipartUploadsRequestWithKeyMarker (const Aws::String &value)
 
ListMultipartUploadsRequestWithKeyMarker (Aws::String &&value)
 
ListMultipartUploadsRequestWithKeyMarker (const char *value)
 
int GetMaxUploads () const
 
bool MaxUploadsHasBeenSet () const
 
void SetMaxUploads (int value)
 
ListMultipartUploadsRequestWithMaxUploads (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)
 
ListMultipartUploadsRequestWithPrefix (const Aws::String &value)
 
ListMultipartUploadsRequestWithPrefix (Aws::String &&value)
 
ListMultipartUploadsRequestWithPrefix (const char *value)
 
const Aws::StringGetUploadIdMarker () const
 
bool UploadIdMarkerHasBeenSet () const
 
void SetUploadIdMarker (const Aws::String &value)
 
void SetUploadIdMarker (Aws::String &&value)
 
void SetUploadIdMarker (const char *value)
 
ListMultipartUploadsRequestWithUploadIdMarker (const Aws::String &value)
 
ListMultipartUploadsRequestWithUploadIdMarker (Aws::String &&value)
 
ListMultipartUploadsRequestWithUploadIdMarker (const char *value)
 
const Aws::StringGetExpectedBucketOwner () const
 
bool ExpectedBucketOwnerHasBeenSet () const
 
void SetExpectedBucketOwner (const Aws::String &value)
 
void SetExpectedBucketOwner (Aws::String &&value)
 
void SetExpectedBucketOwner (const char *value)
 
ListMultipartUploadsRequestWithExpectedBucketOwner (const Aws::String &value)
 
ListMultipartUploadsRequestWithExpectedBucketOwner (Aws::String &&value)
 
ListMultipartUploadsRequestWithExpectedBucketOwner (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)
 
ListMultipartUploadsRequestWithCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
ListMultipartUploadsRequestWithCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
ListMultipartUploadsRequestAddCustomizedAccessLogTag (const Aws::String &key, const Aws::String &value)
 
ListMultipartUploadsRequestAddCustomizedAccessLogTag (Aws::String &&key, const Aws::String &value)
 
ListMultipartUploadsRequestAddCustomizedAccessLogTag (const Aws::String &key, Aws::String &&value)
 
ListMultipartUploadsRequestAddCustomizedAccessLogTag (Aws::String &&key, Aws::String &&value)
 
ListMultipartUploadsRequestAddCustomizedAccessLogTag (const char *key, Aws::String &&value)
 
ListMultipartUploadsRequestAddCustomizedAccessLogTag (Aws::String &&key, const char *value)
 
ListMultipartUploadsRequestAddCustomizedAccessLogTag (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 27 of file ListMultipartUploadsRequest.h.

Constructor & Destructor Documentation

◆ ListMultipartUploadsRequest()

Aws::S3::Model::ListMultipartUploadsRequest::ListMultipartUploadsRequest ( )

Member Function Documentation

◆ AddCustomizedAccessLogTag() [1/7]

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

Definition at line 671 of file ListMultipartUploadsRequest.h.

◆ AddCustomizedAccessLogTag() [2/7]

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

Definition at line 665 of file ListMultipartUploadsRequest.h.

◆ AddCustomizedAccessLogTag() [3/7]

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

Definition at line 677 of file ListMultipartUploadsRequest.h.

◆ AddCustomizedAccessLogTag() [4/7]

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

Definition at line 668 of file ListMultipartUploadsRequest.h.

◆ AddCustomizedAccessLogTag() [5/7]

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

Definition at line 662 of file ListMultipartUploadsRequest.h.

◆ AddCustomizedAccessLogTag() [6/7]

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

Definition at line 674 of file ListMultipartUploadsRequest.h.

◆ AddCustomizedAccessLogTag() [7/7]

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

Definition at line 680 of file ListMultipartUploadsRequest.h.

◆ AddQueryStringParameters()

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

The name of the bucket to which the multipart upload was initiated.

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 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 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 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 S3 User Guide.

Definition at line 85 of file ListMultipartUploadsRequest.h.

◆ CustomizedAccessLogTagHasBeenSet()

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

Definition at line 647 of file ListMultipartUploadsRequest.h.

◆ DelimiterHasBeenSet()

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

Character you use to group keys.

All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.

Definition at line 234 of file ListMultipartUploadsRequest.h.

◆ EncodingTypeHasBeenSet()

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

Definition at line 307 of file ListMultipartUploadsRequest.h.

◆ ExpectedBucketOwnerHasBeenSet()

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

◆ GetBucket()

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

The name of the bucket to which the multipart upload was initiated.

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 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 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 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 S3 User Guide.

Definition at line 64 of file ListMultipartUploadsRequest.h.

◆ GetCustomizedAccessLogTag()

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

Definition at line 644 of file ListMultipartUploadsRequest.h.

◆ GetDelimiter()

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

Character you use to group keys.

All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.

Definition at line 223 of file ListMultipartUploadsRequest.h.

◆ GetEncodingType()

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

Definition at line 304 of file ListMultipartUploadsRequest.h.

◆ GetExpectedBucketOwner()

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

◆ GetKeyMarker()

const Aws::String& Aws::S3::Model::ListMultipartUploadsRequest::GetKeyMarker ( ) const
inline

Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.

If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.

Definition at line 332 of file ListMultipartUploadsRequest.h.

◆ GetMaxUploads()

int Aws::S3::Model::ListMultipartUploadsRequest::GetMaxUploads ( ) const
inline

Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.

Definition at line 424 of file ListMultipartUploadsRequest.h.

◆ GetPrefix()

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

Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.)

Definition at line 454 of file ListMultipartUploadsRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::S3::S3Request.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file ListMultipartUploadsRequest.h.

◆ GetUploadIdMarker()

const Aws::String& Aws::S3::Model::ListMultipartUploadsRequest::GetUploadIdMarker ( ) const
inline

Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.

Definition at line 520 of file ListMultipartUploadsRequest.h.

◆ KeyMarkerHasBeenSet()

bool Aws::S3::Model::ListMultipartUploadsRequest::KeyMarkerHasBeenSet ( ) const
inline

Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.

If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.

Definition at line 344 of file ListMultipartUploadsRequest.h.

◆ MaxUploadsHasBeenSet()

bool Aws::S3::Model::ListMultipartUploadsRequest::MaxUploadsHasBeenSet ( ) const
inline

Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.

Definition at line 431 of file ListMultipartUploadsRequest.h.

◆ PrefixHasBeenSet()

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

Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.)

Definition at line 462 of file ListMultipartUploadsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBucket() [1/3]

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

The name of the bucket to which the multipart upload was initiated.

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 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 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 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 S3 User Guide.

Definition at line 127 of file ListMultipartUploadsRequest.h.

◆ SetBucket() [2/3]

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

The name of the bucket to which the multipart upload was initiated.

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 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 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 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 S3 User Guide.

Definition at line 106 of file ListMultipartUploadsRequest.h.

◆ SetBucket() [3/3]

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

The name of the bucket to which the multipart upload was initiated.

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 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 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 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 S3 User Guide.

Definition at line 148 of file ListMultipartUploadsRequest.h.

◆ SetCustomizedAccessLogTag() [1/2]

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

Definition at line 653 of file ListMultipartUploadsRequest.h.

◆ SetCustomizedAccessLogTag() [2/2]

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

Definition at line 650 of file ListMultipartUploadsRequest.h.

◆ SetDelimiter() [1/3]

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

Character you use to group keys.

All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.

Definition at line 256 of file ListMultipartUploadsRequest.h.

◆ SetDelimiter() [2/3]

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

Character you use to group keys.

All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.

Definition at line 245 of file ListMultipartUploadsRequest.h.

◆ SetDelimiter() [3/3]

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

Character you use to group keys.

All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.

Definition at line 267 of file ListMultipartUploadsRequest.h.

◆ SetEncodingType() [1/2]

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

Definition at line 310 of file ListMultipartUploadsRequest.h.

◆ SetEncodingType() [2/2]

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

Definition at line 313 of file ListMultipartUploadsRequest.h.

◆ SetExpectedBucketOwner() [1/3]

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

◆ SetExpectedBucketOwner() [2/3]

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

◆ SetExpectedBucketOwner() [3/3]

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

◆ SetKeyMarker() [1/3]

void Aws::S3::Model::ListMultipartUploadsRequest::SetKeyMarker ( Aws::String &&  value)
inline

Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.

If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.

Definition at line 368 of file ListMultipartUploadsRequest.h.

◆ SetKeyMarker() [2/3]

void Aws::S3::Model::ListMultipartUploadsRequest::SetKeyMarker ( const Aws::String value)
inline

Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.

If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.

Definition at line 356 of file ListMultipartUploadsRequest.h.

◆ SetKeyMarker() [3/3]

void Aws::S3::Model::ListMultipartUploadsRequest::SetKeyMarker ( const char *  value)
inline

Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.

If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.

Definition at line 380 of file ListMultipartUploadsRequest.h.

◆ SetMaxUploads()

void Aws::S3::Model::ListMultipartUploadsRequest::SetMaxUploads ( int  value)
inline

Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.

Definition at line 438 of file ListMultipartUploadsRequest.h.

◆ SetPrefix() [1/3]

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

Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.)

Definition at line 478 of file ListMultipartUploadsRequest.h.

◆ SetPrefix() [2/3]

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

Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.)

Definition at line 470 of file ListMultipartUploadsRequest.h.

◆ SetPrefix() [3/3]

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

Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.)

Definition at line 486 of file ListMultipartUploadsRequest.h.

◆ SetUploadIdMarker() [1/3]

void Aws::S3::Model::ListMultipartUploadsRequest::SetUploadIdMarker ( Aws::String &&  value)
inline

Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.

Definition at line 547 of file ListMultipartUploadsRequest.h.

◆ SetUploadIdMarker() [2/3]

void Aws::S3::Model::ListMultipartUploadsRequest::SetUploadIdMarker ( const Aws::String value)
inline

Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.

Definition at line 538 of file ListMultipartUploadsRequest.h.

◆ SetUploadIdMarker() [3/3]

void Aws::S3::Model::ListMultipartUploadsRequest::SetUploadIdMarker ( const char *  value)
inline

Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.

Definition at line 556 of file ListMultipartUploadsRequest.h.

◆ UploadIdMarkerHasBeenSet()

bool Aws::S3::Model::ListMultipartUploadsRequest::UploadIdMarkerHasBeenSet ( ) const
inline

Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.

Definition at line 529 of file ListMultipartUploadsRequest.h.

◆ WithBucket() [1/3]

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

The name of the bucket to which the multipart upload was initiated.

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 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 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 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 S3 User Guide.

Definition at line 190 of file ListMultipartUploadsRequest.h.

◆ WithBucket() [2/3]

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

The name of the bucket to which the multipart upload was initiated.

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 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 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 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 S3 User Guide.

Definition at line 169 of file ListMultipartUploadsRequest.h.

◆ WithBucket() [3/3]

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

The name of the bucket to which the multipart upload was initiated.

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 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 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 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 S3 User Guide.

Definition at line 211 of file ListMultipartUploadsRequest.h.

◆ WithCustomizedAccessLogTag() [1/2]

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

Definition at line 659 of file ListMultipartUploadsRequest.h.

◆ WithCustomizedAccessLogTag() [2/2]

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

Definition at line 656 of file ListMultipartUploadsRequest.h.

◆ WithDelimiter() [1/3]

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

Character you use to group keys.

All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.

Definition at line 289 of file ListMultipartUploadsRequest.h.

◆ WithDelimiter() [2/3]

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

Character you use to group keys.

All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.

Definition at line 278 of file ListMultipartUploadsRequest.h.

◆ WithDelimiter() [3/3]

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

Character you use to group keys.

All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.

Definition at line 300 of file ListMultipartUploadsRequest.h.

◆ WithEncodingType() [1/2]

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

Definition at line 316 of file ListMultipartUploadsRequest.h.

◆ WithEncodingType() [2/2]

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

Definition at line 319 of file ListMultipartUploadsRequest.h.

◆ WithExpectedBucketOwner() [1/3]

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

◆ WithExpectedBucketOwner() [2/3]

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

◆ WithExpectedBucketOwner() [3/3]

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

◆ WithKeyMarker() [1/3]

ListMultipartUploadsRequest& Aws::S3::Model::ListMultipartUploadsRequest::WithKeyMarker ( Aws::String &&  value)
inline

Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.

If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.

Definition at line 404 of file ListMultipartUploadsRequest.h.

◆ WithKeyMarker() [2/3]

ListMultipartUploadsRequest& Aws::S3::Model::ListMultipartUploadsRequest::WithKeyMarker ( const Aws::String value)
inline

Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.

If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.

Definition at line 392 of file ListMultipartUploadsRequest.h.

◆ WithKeyMarker() [3/3]

ListMultipartUploadsRequest& Aws::S3::Model::ListMultipartUploadsRequest::WithKeyMarker ( const char *  value)
inline

Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.

If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.

Definition at line 416 of file ListMultipartUploadsRequest.h.

◆ WithMaxUploads()

ListMultipartUploadsRequest& Aws::S3::Model::ListMultipartUploadsRequest::WithMaxUploads ( int  value)
inline

Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.

Definition at line 445 of file ListMultipartUploadsRequest.h.

◆ WithPrefix() [1/3]

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

Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.)

Definition at line 502 of file ListMultipartUploadsRequest.h.

◆ WithPrefix() [2/3]

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

Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.)

Definition at line 494 of file ListMultipartUploadsRequest.h.

◆ WithPrefix() [3/3]

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

Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.)

Definition at line 510 of file ListMultipartUploadsRequest.h.

◆ WithUploadIdMarker() [1/3]

ListMultipartUploadsRequest& Aws::S3::Model::ListMultipartUploadsRequest::WithUploadIdMarker ( Aws::String &&  value)
inline

Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.

Definition at line 574 of file ListMultipartUploadsRequest.h.

◆ WithUploadIdMarker() [2/3]

ListMultipartUploadsRequest& Aws::S3::Model::ListMultipartUploadsRequest::WithUploadIdMarker ( const Aws::String value)
inline

Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.

Definition at line 565 of file ListMultipartUploadsRequest.h.

◆ WithUploadIdMarker() [3/3]

ListMultipartUploadsRequest& Aws::S3::Model::ListMultipartUploadsRequest::WithUploadIdMarker ( const char *  value)
inline

Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.

Definition at line 583 of file ListMultipartUploadsRequest.h.


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