AWS SDK for C++  1.9.72
AWS SDK for C++
Public Member Functions | List of all members
Aws::S3Crt::Model::PutObjectRetentionRequest Class Reference

#include <PutObjectRetentionRequest.h>

+ Inheritance diagram for Aws::S3Crt::Model::PutObjectRetentionRequest:

Public Member Functions

 PutObjectRetentionRequest ()
 
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
 
bool ShouldComputeContentMd5 () 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)
 
PutObjectRetentionRequestWithBucket (const Aws::String &value)
 
PutObjectRetentionRequestWithBucket (Aws::String &&value)
 
PutObjectRetentionRequestWithBucket (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)
 
PutObjectRetentionRequestWithKey (const Aws::String &value)
 
PutObjectRetentionRequestWithKey (Aws::String &&value)
 
PutObjectRetentionRequestWithKey (const char *value)
 
const ObjectLockRetentionGetRetention () const
 
bool RetentionHasBeenSet () const
 
void SetRetention (const ObjectLockRetention &value)
 
void SetRetention (ObjectLockRetention &&value)
 
PutObjectRetentionRequestWithRetention (const ObjectLockRetention &value)
 
PutObjectRetentionRequestWithRetention (ObjectLockRetention &&value)
 
const RequestPayerGetRequestPayer () const
 
bool RequestPayerHasBeenSet () const
 
void SetRequestPayer (const RequestPayer &value)
 
void SetRequestPayer (RequestPayer &&value)
 
PutObjectRetentionRequestWithRequestPayer (const RequestPayer &value)
 
PutObjectRetentionRequestWithRequestPayer (RequestPayer &&value)
 
const Aws::StringGetVersionId () const
 
bool VersionIdHasBeenSet () const
 
void SetVersionId (const Aws::String &value)
 
void SetVersionId (Aws::String &&value)
 
void SetVersionId (const char *value)
 
PutObjectRetentionRequestWithVersionId (const Aws::String &value)
 
PutObjectRetentionRequestWithVersionId (Aws::String &&value)
 
PutObjectRetentionRequestWithVersionId (const char *value)
 
bool GetBypassGovernanceRetention () const
 
bool BypassGovernanceRetentionHasBeenSet () const
 
void SetBypassGovernanceRetention (bool value)
 
PutObjectRetentionRequestWithBypassGovernanceRetention (bool value)
 
const Aws::StringGetContentMD5 () const
 
bool ContentMD5HasBeenSet () const
 
void SetContentMD5 (const Aws::String &value)
 
void SetContentMD5 (Aws::String &&value)
 
void SetContentMD5 (const char *value)
 
PutObjectRetentionRequestWithContentMD5 (const Aws::String &value)
 
PutObjectRetentionRequestWithContentMD5 (Aws::String &&value)
 
PutObjectRetentionRequestWithContentMD5 (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)
 
PutObjectRetentionRequestWithExpectedBucketOwner (const Aws::String &value)
 
PutObjectRetentionRequestWithExpectedBucketOwner (Aws::String &&value)
 
PutObjectRetentionRequestWithExpectedBucketOwner (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)
 
PutObjectRetentionRequestWithCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
PutObjectRetentionRequestWithCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
PutObjectRetentionRequestAddCustomizedAccessLogTag (const Aws::String &key, const Aws::String &value)
 
PutObjectRetentionRequestAddCustomizedAccessLogTag (Aws::String &&key, const Aws::String &value)
 
PutObjectRetentionRequestAddCustomizedAccessLogTag (const Aws::String &key, Aws::String &&value)
 
PutObjectRetentionRequestAddCustomizedAccessLogTag (Aws::String &&key, Aws::String &&value)
 
PutObjectRetentionRequestAddCustomizedAccessLogTag (const char *key, Aws::String &&value)
 
PutObjectRetentionRequestAddCustomizedAccessLogTag (Aws::String &&key, const char *value)
 
PutObjectRetentionRequestAddCustomizedAccessLogTag (const char *key, const char *value)
 
- Public Member Functions inherited from Aws::S3Crt::S3CrtRequest
virtual ~S3CrtRequest ()
 
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
 

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

Constructor & Destructor Documentation

◆ PutObjectRetentionRequest()

Aws::S3Crt::Model::PutObjectRetentionRequest::PutObjectRetentionRequest ( )

Member Function Documentation

◆ AddCustomizedAccessLogTag() [1/7]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::AddCustomizedAccessLogTag ( Aws::String &&  key,
Aws::String &&  value 
)
inline

Definition at line 472 of file PutObjectRetentionRequest.h.

◆ AddCustomizedAccessLogTag() [2/7]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::AddCustomizedAccessLogTag ( Aws::String &&  key,
const Aws::String value 
)
inline

Definition at line 466 of file PutObjectRetentionRequest.h.

◆ AddCustomizedAccessLogTag() [3/7]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::AddCustomizedAccessLogTag ( Aws::String &&  key,
const char *  value 
)
inline

Definition at line 478 of file PutObjectRetentionRequest.h.

◆ AddCustomizedAccessLogTag() [4/7]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::AddCustomizedAccessLogTag ( const Aws::String key,
Aws::String &&  value 
)
inline

Definition at line 469 of file PutObjectRetentionRequest.h.

◆ AddCustomizedAccessLogTag() [5/7]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::AddCustomizedAccessLogTag ( const Aws::String key,
const Aws::String value 
)
inline

Definition at line 463 of file PutObjectRetentionRequest.h.

◆ AddCustomizedAccessLogTag() [6/7]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::AddCustomizedAccessLogTag ( const char *  key,
Aws::String &&  value 
)
inline

Definition at line 475 of file PutObjectRetentionRequest.h.

◆ AddCustomizedAccessLogTag() [7/7]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::AddCustomizedAccessLogTag ( const char *  key,
const char *  value 
)
inline

Definition at line 481 of file PutObjectRetentionRequest.h.

◆ AddQueryStringParameters()

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

The bucket name that contains the object you want to apply this Object Retention configuration to.

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.

Definition at line 74 of file PutObjectRetentionRequest.h.

◆ BypassGovernanceRetentionHasBeenSet()

bool Aws::S3Crt::Model::PutObjectRetentionRequest::BypassGovernanceRetentionHasBeenSet ( ) const
inline

Indicates whether this action should bypass Governance-mode restrictions.

Definition at line 317 of file PutObjectRetentionRequest.h.

◆ ContentMD5HasBeenSet()

bool Aws::S3Crt::Model::PutObjectRetentionRequest::ContentMD5HasBeenSet ( ) const
inline

The MD5 hash for the request body.

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

Definition at line 342 of file PutObjectRetentionRequest.h.

◆ CustomizedAccessLogTagHasBeenSet()

bool Aws::S3Crt::Model::PutObjectRetentionRequest::CustomizedAccessLogTagHasBeenSet ( ) const
inline

Definition at line 448 of file PutObjectRetentionRequest.h.

◆ ExpectedBucketOwnerHasBeenSet()

bool Aws::S3Crt::Model::PutObjectRetentionRequest::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 399 of file PutObjectRetentionRequest.h.

◆ GetBucket()

const Aws::String& Aws::S3Crt::Model::PutObjectRetentionRequest::GetBucket ( ) const
inline

The bucket name that contains the object you want to apply this Object Retention configuration to.

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.

Definition at line 60 of file PutObjectRetentionRequest.h.

◆ GetBypassGovernanceRetention()

bool Aws::S3Crt::Model::PutObjectRetentionRequest::GetBypassGovernanceRetention ( ) const
inline

Indicates whether this action should bypass Governance-mode restrictions.

Definition at line 312 of file PutObjectRetentionRequest.h.

◆ GetContentMD5()

const Aws::String& Aws::S3Crt::Model::PutObjectRetentionRequest::GetContentMD5 ( ) const
inline

The MD5 hash for the request body.

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

Definition at line 335 of file PutObjectRetentionRequest.h.

◆ GetCustomizedAccessLogTag()

const Aws::Map<Aws::String, Aws::String>& Aws::S3Crt::Model::PutObjectRetentionRequest::GetCustomizedAccessLogTag ( ) const
inline

Definition at line 445 of file PutObjectRetentionRequest.h.

◆ GetExpectedBucketOwner()

const Aws::String& Aws::S3Crt::Model::PutObjectRetentionRequest::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 392 of file PutObjectRetentionRequest.h.

◆ GetKey()

const Aws::String& Aws::S3Crt::Model::PutObjectRetentionRequest::GetKey ( ) const
inline

The key name for the object that you want to apply this Object Retention configuration to.

Definition at line 165 of file PutObjectRetentionRequest.h.

◆ GetRequestPayer()

const RequestPayer& Aws::S3Crt::Model::PutObjectRetentionRequest::GetRequestPayer ( ) const
inline

Definition at line 242 of file PutObjectRetentionRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::S3Crt::Model::PutObjectRetentionRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::S3Crt::S3CrtRequest.

◆ GetRetention()

const ObjectLockRetention& Aws::S3Crt::Model::PutObjectRetentionRequest::GetRetention ( ) const
inline

The container element for the Object Retention configuration.

Definition at line 213 of file PutObjectRetentionRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::S3Crt::Model::PutObjectRetentionRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file PutObjectRetentionRequest.h.

◆ GetVersionId()

const Aws::String& Aws::S3Crt::Model::PutObjectRetentionRequest::GetVersionId ( ) const
inline

The version ID for the object that you want to apply this Object Retention configuration to.

Definition at line 264 of file PutObjectRetentionRequest.h.

◆ KeyHasBeenSet()

bool Aws::S3Crt::Model::PutObjectRetentionRequest::KeyHasBeenSet ( ) const
inline

The key name for the object that you want to apply this Object Retention configuration to.

Definition at line 171 of file PutObjectRetentionRequest.h.

◆ RequestPayerHasBeenSet()

bool Aws::S3Crt::Model::PutObjectRetentionRequest::RequestPayerHasBeenSet ( ) const
inline

Definition at line 245 of file PutObjectRetentionRequest.h.

◆ RetentionHasBeenSet()

bool Aws::S3Crt::Model::PutObjectRetentionRequest::RetentionHasBeenSet ( ) const
inline

The container element for the Object Retention configuration.

Definition at line 218 of file PutObjectRetentionRequest.h.

◆ SerializePayload()

Aws::String Aws::S3Crt::Model::PutObjectRetentionRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBucket() [1/3]

void Aws::S3Crt::Model::PutObjectRetentionRequest::SetBucket ( Aws::String &&  value)
inline

The bucket name that contains the object you want to apply this Object Retention configuration to.

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.

Definition at line 102 of file PutObjectRetentionRequest.h.

◆ SetBucket() [2/3]

void Aws::S3Crt::Model::PutObjectRetentionRequest::SetBucket ( const Aws::String value)
inline

The bucket name that contains the object you want to apply this Object Retention configuration to.

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.

Definition at line 88 of file PutObjectRetentionRequest.h.

◆ SetBucket() [3/3]

void Aws::S3Crt::Model::PutObjectRetentionRequest::SetBucket ( const char *  value)
inline

The bucket name that contains the object you want to apply this Object Retention configuration to.

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.

Definition at line 116 of file PutObjectRetentionRequest.h.

◆ SetBypassGovernanceRetention()

void Aws::S3Crt::Model::PutObjectRetentionRequest::SetBypassGovernanceRetention ( bool  value)
inline

Indicates whether this action should bypass Governance-mode restrictions.

Definition at line 322 of file PutObjectRetentionRequest.h.

◆ SetContentMD5() [1/3]

void Aws::S3Crt::Model::PutObjectRetentionRequest::SetContentMD5 ( Aws::String &&  value)
inline

The MD5 hash for the request body.

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

Definition at line 356 of file PutObjectRetentionRequest.h.

◆ SetContentMD5() [2/3]

void Aws::S3Crt::Model::PutObjectRetentionRequest::SetContentMD5 ( const Aws::String value)
inline

The MD5 hash for the request body.

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

Definition at line 349 of file PutObjectRetentionRequest.h.

◆ SetContentMD5() [3/3]

void Aws::S3Crt::Model::PutObjectRetentionRequest::SetContentMD5 ( const char *  value)
inline

The MD5 hash for the request body.

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

Definition at line 363 of file PutObjectRetentionRequest.h.

◆ SetCustomizedAccessLogTag() [1/2]

void Aws::S3Crt::Model::PutObjectRetentionRequest::SetCustomizedAccessLogTag ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Definition at line 454 of file PutObjectRetentionRequest.h.

◆ SetCustomizedAccessLogTag() [2/2]

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

Definition at line 451 of file PutObjectRetentionRequest.h.

◆ SetExpectedBucketOwner() [1/3]

void Aws::S3Crt::Model::PutObjectRetentionRequest::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 413 of file PutObjectRetentionRequest.h.

◆ SetExpectedBucketOwner() [2/3]

void Aws::S3Crt::Model::PutObjectRetentionRequest::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 406 of file PutObjectRetentionRequest.h.

◆ SetExpectedBucketOwner() [3/3]

void Aws::S3Crt::Model::PutObjectRetentionRequest::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 420 of file PutObjectRetentionRequest.h.

◆ SetKey() [1/3]

void Aws::S3Crt::Model::PutObjectRetentionRequest::SetKey ( Aws::String &&  value)
inline

The key name for the object that you want to apply this Object Retention configuration to.

Definition at line 183 of file PutObjectRetentionRequest.h.

◆ SetKey() [2/3]

void Aws::S3Crt::Model::PutObjectRetentionRequest::SetKey ( const Aws::String value)
inline

The key name for the object that you want to apply this Object Retention configuration to.

Definition at line 177 of file PutObjectRetentionRequest.h.

◆ SetKey() [3/3]

void Aws::S3Crt::Model::PutObjectRetentionRequest::SetKey ( const char *  value)
inline

The key name for the object that you want to apply this Object Retention configuration to.

Definition at line 189 of file PutObjectRetentionRequest.h.

◆ SetRequestPayer() [1/2]

void Aws::S3Crt::Model::PutObjectRetentionRequest::SetRequestPayer ( const RequestPayer value)
inline

Definition at line 248 of file PutObjectRetentionRequest.h.

◆ SetRequestPayer() [2/2]

void Aws::S3Crt::Model::PutObjectRetentionRequest::SetRequestPayer ( RequestPayer &&  value)
inline

Definition at line 251 of file PutObjectRetentionRequest.h.

◆ SetRetention() [1/2]

void Aws::S3Crt::Model::PutObjectRetentionRequest::SetRetention ( const ObjectLockRetention value)
inline

The container element for the Object Retention configuration.

Definition at line 223 of file PutObjectRetentionRequest.h.

◆ SetRetention() [2/2]

void Aws::S3Crt::Model::PutObjectRetentionRequest::SetRetention ( ObjectLockRetention &&  value)
inline

The container element for the Object Retention configuration.

Definition at line 228 of file PutObjectRetentionRequest.h.

◆ SetVersionId() [1/3]

void Aws::S3Crt::Model::PutObjectRetentionRequest::SetVersionId ( Aws::String &&  value)
inline

The version ID for the object that you want to apply this Object Retention configuration to.

Definition at line 282 of file PutObjectRetentionRequest.h.

◆ SetVersionId() [2/3]

void Aws::S3Crt::Model::PutObjectRetentionRequest::SetVersionId ( const Aws::String value)
inline

The version ID for the object that you want to apply this Object Retention configuration to.

Definition at line 276 of file PutObjectRetentionRequest.h.

◆ SetVersionId() [3/3]

void Aws::S3Crt::Model::PutObjectRetentionRequest::SetVersionId ( const char *  value)
inline

The version ID for the object that you want to apply this Object Retention configuration to.

Definition at line 288 of file PutObjectRetentionRequest.h.

◆ ShouldComputeContentMd5()

bool Aws::S3Crt::Model::PutObjectRetentionRequest::ShouldComputeContentMd5 ( ) const
inlineoverridevirtual

If this is set to true, content-md5 needs to be computed and set on the request

Reimplemented from Aws::AmazonWebServiceRequest.

Definition at line 45 of file PutObjectRetentionRequest.h.

◆ VersionIdHasBeenSet()

bool Aws::S3Crt::Model::PutObjectRetentionRequest::VersionIdHasBeenSet ( ) const
inline

The version ID for the object that you want to apply this Object Retention configuration to.

Definition at line 270 of file PutObjectRetentionRequest.h.

◆ WithBucket() [1/3]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::WithBucket ( Aws::String &&  value)
inline

The bucket name that contains the object you want to apply this Object Retention configuration to.

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.

Definition at line 144 of file PutObjectRetentionRequest.h.

◆ WithBucket() [2/3]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::WithBucket ( const Aws::String value)
inline

The bucket name that contains the object you want to apply this Object Retention configuration to.

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.

Definition at line 130 of file PutObjectRetentionRequest.h.

◆ WithBucket() [3/3]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::WithBucket ( const char *  value)
inline

The bucket name that contains the object you want to apply this Object Retention configuration to.

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.

Definition at line 158 of file PutObjectRetentionRequest.h.

◆ WithBypassGovernanceRetention()

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::WithBypassGovernanceRetention ( bool  value)
inline

Indicates whether this action should bypass Governance-mode restrictions.

Definition at line 327 of file PutObjectRetentionRequest.h.

◆ WithContentMD5() [1/3]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::WithContentMD5 ( Aws::String &&  value)
inline

The MD5 hash for the request body.

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

Definition at line 377 of file PutObjectRetentionRequest.h.

◆ WithContentMD5() [2/3]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::WithContentMD5 ( const Aws::String value)
inline

The MD5 hash for the request body.

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

Definition at line 370 of file PutObjectRetentionRequest.h.

◆ WithContentMD5() [3/3]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::WithContentMD5 ( const char *  value)
inline

The MD5 hash for the request body.

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

Definition at line 384 of file PutObjectRetentionRequest.h.

◆ WithCustomizedAccessLogTag() [1/2]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::WithCustomizedAccessLogTag ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Definition at line 460 of file PutObjectRetentionRequest.h.

◆ WithCustomizedAccessLogTag() [2/2]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::WithCustomizedAccessLogTag ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Definition at line 457 of file PutObjectRetentionRequest.h.

◆ WithExpectedBucketOwner() [1/3]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::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 434 of file PutObjectRetentionRequest.h.

◆ WithExpectedBucketOwner() [2/3]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::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 427 of file PutObjectRetentionRequest.h.

◆ WithExpectedBucketOwner() [3/3]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::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 441 of file PutObjectRetentionRequest.h.

◆ WithKey() [1/3]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::WithKey ( Aws::String &&  value)
inline

The key name for the object that you want to apply this Object Retention configuration to.

Definition at line 201 of file PutObjectRetentionRequest.h.

◆ WithKey() [2/3]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::WithKey ( const Aws::String value)
inline

The key name for the object that you want to apply this Object Retention configuration to.

Definition at line 195 of file PutObjectRetentionRequest.h.

◆ WithKey() [3/3]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::WithKey ( const char *  value)
inline

The key name for the object that you want to apply this Object Retention configuration to.

Definition at line 207 of file PutObjectRetentionRequest.h.

◆ WithRequestPayer() [1/2]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::WithRequestPayer ( const RequestPayer value)
inline

Definition at line 254 of file PutObjectRetentionRequest.h.

◆ WithRequestPayer() [2/2]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::WithRequestPayer ( RequestPayer &&  value)
inline

Definition at line 257 of file PutObjectRetentionRequest.h.

◆ WithRetention() [1/2]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::WithRetention ( const ObjectLockRetention value)
inline

The container element for the Object Retention configuration.

Definition at line 233 of file PutObjectRetentionRequest.h.

◆ WithRetention() [2/2]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::WithRetention ( ObjectLockRetention &&  value)
inline

The container element for the Object Retention configuration.

Definition at line 238 of file PutObjectRetentionRequest.h.

◆ WithVersionId() [1/3]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::WithVersionId ( Aws::String &&  value)
inline

The version ID for the object that you want to apply this Object Retention configuration to.

Definition at line 300 of file PutObjectRetentionRequest.h.

◆ WithVersionId() [2/3]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::WithVersionId ( const Aws::String value)
inline

The version ID for the object that you want to apply this Object Retention configuration to.

Definition at line 294 of file PutObjectRetentionRequest.h.

◆ WithVersionId() [3/3]

PutObjectRetentionRequest& Aws::S3Crt::Model::PutObjectRetentionRequest::WithVersionId ( const char *  value)
inline

The version ID for the object that you want to apply this Object Retention configuration to.

Definition at line 306 of file PutObjectRetentionRequest.h.


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