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

#include <RestoreObjectRequest.h>

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

Public Member Functions

 RestoreObjectRequest ()
 
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)
 
RestoreObjectRequestWithBucket (const Aws::String &value)
 
RestoreObjectRequestWithBucket (Aws::String &&value)
 
RestoreObjectRequestWithBucket (const char *value)
 
const Aws::StringGetKey () const
 
bool KeyHasBeenSet () const
 
void SetKey (const Aws::String &value)
 
void SetKey (Aws::String &&value)
 
void SetKey (const char *value)
 
RestoreObjectRequestWithKey (const Aws::String &value)
 
RestoreObjectRequestWithKey (Aws::String &&value)
 
RestoreObjectRequestWithKey (const char *value)
 
const Aws::StringGetVersionId () const
 
bool VersionIdHasBeenSet () const
 
void SetVersionId (const Aws::String &value)
 
void SetVersionId (Aws::String &&value)
 
void SetVersionId (const char *value)
 
RestoreObjectRequestWithVersionId (const Aws::String &value)
 
RestoreObjectRequestWithVersionId (Aws::String &&value)
 
RestoreObjectRequestWithVersionId (const char *value)
 
const RestoreRequestGetRestoreRequest () const
 
bool RestoreRequestHasBeenSet () const
 
void SetRestoreRequest (const RestoreRequest &value)
 
void SetRestoreRequest (RestoreRequest &&value)
 
RestoreObjectRequestWithRestoreRequest (const RestoreRequest &value)
 
RestoreObjectRequestWithRestoreRequest (RestoreRequest &&value)
 
const RequestPayerGetRequestPayer () const
 
bool RequestPayerHasBeenSet () const
 
void SetRequestPayer (const RequestPayer &value)
 
void SetRequestPayer (RequestPayer &&value)
 
RestoreObjectRequestWithRequestPayer (const RequestPayer &value)
 
RestoreObjectRequestWithRequestPayer (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)
 
RestoreObjectRequestWithExpectedBucketOwner (const Aws::String &value)
 
RestoreObjectRequestWithExpectedBucketOwner (Aws::String &&value)
 
RestoreObjectRequestWithExpectedBucketOwner (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)
 
RestoreObjectRequestWithCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
RestoreObjectRequestWithCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
RestoreObjectRequestAddCustomizedAccessLogTag (const Aws::String &key, const Aws::String &value)
 
RestoreObjectRequestAddCustomizedAccessLogTag (Aws::String &&key, const Aws::String &value)
 
RestoreObjectRequestAddCustomizedAccessLogTag (const Aws::String &key, Aws::String &&value)
 
RestoreObjectRequestAddCustomizedAccessLogTag (Aws::String &&key, Aws::String &&value)
 
RestoreObjectRequestAddCustomizedAccessLogTag (const char *key, Aws::String &&value)
 
RestoreObjectRequestAddCustomizedAccessLogTag (Aws::String &&key, const char *value)
 
RestoreObjectRequestAddCustomizedAccessLogTag (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 RestoreObjectRequest.h.

Constructor & Destructor Documentation

◆ RestoreObjectRequest()

Aws::S3::Model::RestoreObjectRequest::RestoreObjectRequest ( )

Member Function Documentation

◆ AddCustomizedAccessLogTag() [1/7]

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

Definition at line 411 of file RestoreObjectRequest.h.

◆ AddCustomizedAccessLogTag() [2/7]

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

Definition at line 414 of file RestoreObjectRequest.h.

◆ AddCustomizedAccessLogTag() [3/7]

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

Definition at line 417 of file RestoreObjectRequest.h.

◆ AddCustomizedAccessLogTag() [4/7]

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

Definition at line 420 of file RestoreObjectRequest.h.

◆ AddCustomizedAccessLogTag() [5/7]

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

Definition at line 423 of file RestoreObjectRequest.h.

◆ AddCustomizedAccessLogTag() [6/7]

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

Definition at line 426 of file RestoreObjectRequest.h.

◆ AddCustomizedAccessLogTag() [7/7]

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

Definition at line 429 of file RestoreObjectRequest.h.

◆ AddQueryStringParameters()

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

The bucket name or containing the object to restore.

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 RestoreObjectRequest.h.

◆ CustomizedAccessLogTagHasBeenSet()

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

Definition at line 396 of file RestoreObjectRequest.h.

◆ ExpectedBucketOwnerHasBeenSet()

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

◆ GetBucket()

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

The bucket name or containing the object to restore.

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 RestoreObjectRequest.h.

◆ GetCustomizedAccessLogTag()

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

Definition at line 393 of file RestoreObjectRequest.h.

◆ GetExpectedBucketOwner()

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

◆ GetKey()

const Aws::String& Aws::S3::Model::RestoreObjectRequest::GetKey ( ) const
inline

Object key for which the operation was initiated.

Definition at line 218 of file RestoreObjectRequest.h.

◆ GetRequestPayer()

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

Definition at line 317 of file RestoreObjectRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::S3::S3Request.

◆ GetRestoreRequest()

const RestoreRequest& Aws::S3::Model::RestoreObjectRequest::GetRestoreRequest ( ) const
inline

Definition at line 298 of file RestoreObjectRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file RestoreObjectRequest.h.

◆ GetVersionId()

const Aws::String& Aws::S3::Model::RestoreObjectRequest::GetVersionId ( ) const
inline

VersionId used to reference a specific version of the object.

Definition at line 259 of file RestoreObjectRequest.h.

◆ KeyHasBeenSet()

bool Aws::S3::Model::RestoreObjectRequest::KeyHasBeenSet ( ) const
inline

Object key for which the operation was initiated.

Definition at line 223 of file RestoreObjectRequest.h.

◆ RequestPayerHasBeenSet()

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

Definition at line 320 of file RestoreObjectRequest.h.

◆ RestoreRequestHasBeenSet()

bool Aws::S3::Model::RestoreObjectRequest::RestoreRequestHasBeenSet ( ) const
inline

Definition at line 301 of file RestoreObjectRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBucket() [1/3]

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

The bucket name or containing the object to restore.

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 RestoreObjectRequest.h.

◆ SetBucket() [2/3]

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

The bucket name or containing the object to restore.

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 RestoreObjectRequest.h.

◆ SetBucket() [3/3]

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

The bucket name or containing the object to restore.

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 RestoreObjectRequest.h.

◆ SetCustomizedAccessLogTag() [1/2]

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

Definition at line 399 of file RestoreObjectRequest.h.

◆ SetCustomizedAccessLogTag() [2/2]

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

Definition at line 402 of file RestoreObjectRequest.h.

◆ SetExpectedBucketOwner() [1/3]

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

◆ SetExpectedBucketOwner() [2/3]

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

◆ SetExpectedBucketOwner() [3/3]

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

◆ SetKey() [1/3]

void Aws::S3::Model::RestoreObjectRequest::SetKey ( const Aws::String value)
inline

Object key for which the operation was initiated.

Definition at line 228 of file RestoreObjectRequest.h.

◆ SetKey() [2/3]

void Aws::S3::Model::RestoreObjectRequest::SetKey ( Aws::String &&  value)
inline

Object key for which the operation was initiated.

Definition at line 233 of file RestoreObjectRequest.h.

◆ SetKey() [3/3]

void Aws::S3::Model::RestoreObjectRequest::SetKey ( const char *  value)
inline

Object key for which the operation was initiated.

Definition at line 238 of file RestoreObjectRequest.h.

◆ SetRequestPayer() [1/2]

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

Definition at line 323 of file RestoreObjectRequest.h.

◆ SetRequestPayer() [2/2]

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

Definition at line 326 of file RestoreObjectRequest.h.

◆ SetRestoreRequest() [1/2]

void Aws::S3::Model::RestoreObjectRequest::SetRestoreRequest ( const RestoreRequest value)
inline

Definition at line 304 of file RestoreObjectRequest.h.

◆ SetRestoreRequest() [2/2]

void Aws::S3::Model::RestoreObjectRequest::SetRestoreRequest ( RestoreRequest &&  value)
inline

Definition at line 307 of file RestoreObjectRequest.h.

◆ SetVersionId() [1/3]

void Aws::S3::Model::RestoreObjectRequest::SetVersionId ( const Aws::String value)
inline

VersionId used to reference a specific version of the object.

Definition at line 269 of file RestoreObjectRequest.h.

◆ SetVersionId() [2/3]

void Aws::S3::Model::RestoreObjectRequest::SetVersionId ( Aws::String &&  value)
inline

VersionId used to reference a specific version of the object.

Definition at line 274 of file RestoreObjectRequest.h.

◆ SetVersionId() [3/3]

void Aws::S3::Model::RestoreObjectRequest::SetVersionId ( const char *  value)
inline

VersionId used to reference a specific version of the object.

Definition at line 279 of file RestoreObjectRequest.h.

◆ VersionIdHasBeenSet()

bool Aws::S3::Model::RestoreObjectRequest::VersionIdHasBeenSet ( ) const
inline

VersionId used to reference a specific version of the object.

Definition at line 264 of file RestoreObjectRequest.h.

◆ WithBucket() [1/3]

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

The bucket name or containing the object to restore.

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 RestoreObjectRequest.h.

◆ WithBucket() [2/3]

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

The bucket name or containing the object to restore.

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 RestoreObjectRequest.h.

◆ WithBucket() [3/3]

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

The bucket name or containing the object to restore.

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 RestoreObjectRequest.h.

◆ WithCustomizedAccessLogTag() [1/2]

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

Definition at line 405 of file RestoreObjectRequest.h.

◆ WithCustomizedAccessLogTag() [2/2]

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

Definition at line 408 of file RestoreObjectRequest.h.

◆ WithExpectedBucketOwner() [1/3]

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

◆ WithExpectedBucketOwner() [2/3]

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

◆ WithExpectedBucketOwner() [3/3]

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

◆ WithKey() [1/3]

RestoreObjectRequest& Aws::S3::Model::RestoreObjectRequest::WithKey ( const Aws::String value)
inline

Object key for which the operation was initiated.

Definition at line 243 of file RestoreObjectRequest.h.

◆ WithKey() [2/3]

RestoreObjectRequest& Aws::S3::Model::RestoreObjectRequest::WithKey ( Aws::String &&  value)
inline

Object key for which the operation was initiated.

Definition at line 248 of file RestoreObjectRequest.h.

◆ WithKey() [3/3]

RestoreObjectRequest& Aws::S3::Model::RestoreObjectRequest::WithKey ( const char *  value)
inline

Object key for which the operation was initiated.

Definition at line 253 of file RestoreObjectRequest.h.

◆ WithRequestPayer() [1/2]

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

Definition at line 329 of file RestoreObjectRequest.h.

◆ WithRequestPayer() [2/2]

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

Definition at line 332 of file RestoreObjectRequest.h.

◆ WithRestoreRequest() [1/2]

RestoreObjectRequest& Aws::S3::Model::RestoreObjectRequest::WithRestoreRequest ( const RestoreRequest value)
inline

Definition at line 310 of file RestoreObjectRequest.h.

◆ WithRestoreRequest() [2/2]

RestoreObjectRequest& Aws::S3::Model::RestoreObjectRequest::WithRestoreRequest ( RestoreRequest &&  value)
inline

Definition at line 313 of file RestoreObjectRequest.h.

◆ WithVersionId() [1/3]

RestoreObjectRequest& Aws::S3::Model::RestoreObjectRequest::WithVersionId ( const Aws::String value)
inline

VersionId used to reference a specific version of the object.

Definition at line 284 of file RestoreObjectRequest.h.

◆ WithVersionId() [2/3]

RestoreObjectRequest& Aws::S3::Model::RestoreObjectRequest::WithVersionId ( Aws::String &&  value)
inline

VersionId used to reference a specific version of the object.

Definition at line 289 of file RestoreObjectRequest.h.

◆ WithVersionId() [3/3]

RestoreObjectRequest& Aws::S3::Model::RestoreObjectRequest::WithVersionId ( const char *  value)
inline

VersionId used to reference a specific version of the object.

Definition at line 294 of file RestoreObjectRequest.h.


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