#include <GetBucketPolicyRequest.h>

Inheritance diagram for Aws::S3Control::Model::GetBucketPolicyRequest:

Public Member Functions
	GetBucketPolicyRequest ()

virtual const char *	GetServiceRequestName () const override

Aws::String	SerializePayload () const override

Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override

const Aws::String &	GetAccountId () const

bool	AccountIdHasBeenSet () const

void	SetAccountId (const Aws::String &value)

void	SetAccountId (Aws::String &&value)

void	SetAccountId (const char *value)

GetBucketPolicyRequest &	WithAccountId (const Aws::String &value)

GetBucketPolicyRequest &	WithAccountId (Aws::String &&value)

GetBucketPolicyRequest &	WithAccountId (const char *value)

const Aws::String &	GetBucket () const

bool	BucketHasBeenSet () const

void	SetBucket (const Aws::String &value)

void	SetBucket (Aws::String &&value)

void	SetBucket (const char *value)

GetBucketPolicyRequest &	WithBucket (const Aws::String &value)

GetBucketPolicyRequest &	WithBucket (Aws::String &&value)

GetBucketPolicyRequest &	WithBucket (const char *value)

Public Member Functions inherited from Aws::S3Control::S3ControlRequest
virtual	~S3ControlRequest ()

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::IOStream >	GetBody () const override

Public Member Functions inherited from Aws::AmazonWebServiceRequest
	AmazonWebServiceRequest ()

virtual	~AmazonWebServiceRequest ()=default

virtual void	AddQueryStringParameters (Aws::Http::URI &uri) const

virtual void	PutToPresignedUrl (Aws::Http::URI &uri) const

virtual bool	IsStreaming () const

virtual bool	IsEventStreamRequest () const

virtual bool	SignBody () const

virtual bool	IsChunked () const

virtual void	SetRequestSignedHandler (const RequestSignedHandler &handler)

virtual const RequestSignedHandler &	GetRequestSignedHandler () const

const Aws::IOStreamFactory &	GetResponseStreamFactory () const

void	SetResponseStreamFactory (const Aws::IOStreamFactory &factory)

virtual void	SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

virtual void	SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

virtual void	SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

virtual void	SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

virtual void	SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

virtual void	SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

virtual void	SetRequestRetryHandler (const RequestRetryHandler &handler)

virtual void	SetRequestRetryHandler (RequestRetryHandler &&handler)

virtual const Aws::Http::DataReceivedEventHandler &	GetDataReceivedEventHandler () const

virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const

virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const

virtual const RequestRetryHandler &	GetRequestRetryHandler () const

virtual bool	ShouldComputeContentMd5 () const

Additional Inherited Members
Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void	DumpBodyToUrl (Aws::Http::URI &uri) const

Detailed Description

Definition at line 21 of file GetBucketPolicyRequest.h.

Constructor & Destructor Documentation

◆ GetBucketPolicyRequest()

Aws::S3Control::Model::GetBucketPolicyRequest::GetBucketPolicyRequest ( )

Member Function Documentation

◆ AccountIdHasBeenSet()

bool Aws::S3Control::Model::GetBucketPolicyRequest::AccountIdHasBeenSet ( ) const

inline

The Amazon Web Services account ID of the Outposts bucket.

Definition at line 45 of file GetBucketPolicyRequest.h.

◆ BucketHasBeenSet()

bool Aws::S3Control::Model::GetBucketPolicyRequest::BucketHasBeenSet ( ) const

inline

Specifies the bucket.

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

Definition at line 106 of file GetBucketPolicyRequest.h.

◆ GetAccountId()

const Aws::String& Aws::S3Control::Model::GetBucketPolicyRequest::GetAccountId ( ) const

inline

The Amazon Web Services account ID of the Outposts bucket.

Definition at line 40 of file GetBucketPolicyRequest.h.

◆ GetBucket()

const Aws::String& Aws::S3Control::Model::GetBucketPolicyRequest::GetBucket ( ) const

inline

Specifies the bucket.

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

Definition at line 91 of file GetBucketPolicyRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::S3Control::Model::GetBucketPolicyRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::S3Control::S3ControlRequest.

◆ GetServiceRequestName()

virtual const char* Aws::S3Control::Model::GetBucketPolicyRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file GetBucketPolicyRequest.h.

◆ SerializePayload()

Aws::String Aws::S3Control::Model::GetBucketPolicyRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAccountId() [1/3]

void Aws::S3Control::Model::GetBucketPolicyRequest::SetAccountId ( Aws::String && value )

inline

The Amazon Web Services account ID of the Outposts bucket.

Definition at line 55 of file GetBucketPolicyRequest.h.

◆ SetAccountId() [2/3]

void Aws::S3Control::Model::GetBucketPolicyRequest::SetAccountId ( const Aws::String & value )

inline

The Amazon Web Services account ID of the Outposts bucket.

Definition at line 50 of file GetBucketPolicyRequest.h.

◆ SetAccountId() [3/3]

void Aws::S3Control::Model::GetBucketPolicyRequest::SetAccountId ( const char * value )

inline

The Amazon Web Services account ID of the Outposts bucket.

Definition at line 60 of file GetBucketPolicyRequest.h.

◆ SetBucket() [1/3]

void Aws::S3Control::Model::GetBucketPolicyRequest::SetBucket ( Aws::String && value )

inline

Specifies the bucket.

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

Definition at line 136 of file GetBucketPolicyRequest.h.

◆ SetBucket() [2/3]

void Aws::S3Control::Model::GetBucketPolicyRequest::SetBucket ( const Aws::String & value )

inline

Specifies the bucket.

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

Definition at line 121 of file GetBucketPolicyRequest.h.

◆ SetBucket() [3/3]

void Aws::S3Control::Model::GetBucketPolicyRequest::SetBucket ( const char * value )

inline

Specifies the bucket.

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

Definition at line 151 of file GetBucketPolicyRequest.h.

◆ WithAccountId() [1/3]

GetBucketPolicyRequest& Aws::S3Control::Model::GetBucketPolicyRequest::WithAccountId ( Aws::String && value )

inline

The Amazon Web Services account ID of the Outposts bucket.

Definition at line 70 of file GetBucketPolicyRequest.h.

◆ WithAccountId() [2/3]

GetBucketPolicyRequest& Aws::S3Control::Model::GetBucketPolicyRequest::WithAccountId ( const Aws::String & value )

inline

The Amazon Web Services account ID of the Outposts bucket.

Definition at line 65 of file GetBucketPolicyRequest.h.

◆ WithAccountId() [3/3]

GetBucketPolicyRequest& Aws::S3Control::Model::GetBucketPolicyRequest::WithAccountId ( const char * value )

inline

The Amazon Web Services account ID of the Outposts bucket.

Definition at line 75 of file GetBucketPolicyRequest.h.

◆ WithBucket() [1/3]

GetBucketPolicyRequest& Aws::S3Control::Model::GetBucketPolicyRequest::WithBucket ( Aws::String && value )

inline

Specifies the bucket.

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

Definition at line 181 of file GetBucketPolicyRequest.h.

◆ WithBucket() [2/3]

GetBucketPolicyRequest& Aws::S3Control::Model::GetBucketPolicyRequest::WithBucket ( const Aws::String & value )

inline

Specifies the bucket.

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

Definition at line 166 of file GetBucketPolicyRequest.h.

◆ WithBucket() [3/3]

GetBucketPolicyRequest& Aws::S3Control::Model::GetBucketPolicyRequest::WithBucket ( const char * value )

inline

Specifies the bucket.

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

Definition at line 196 of file GetBucketPolicyRequest.h.

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

aws-cpp-sdk-s3control/include/aws/s3control/model/GetBucketPolicyRequest.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GetBucketPolicyRequest()

Member Function Documentation

◆ AccountIdHasBeenSet()

◆ BucketHasBeenSet()

◆ GetAccountId()

◆ GetBucket()

◆ GetRequestSpecificHeaders()

◆ GetServiceRequestName()

◆ SerializePayload()

◆ SetAccountId() [1/3]

◆ SetAccountId() [2/3]

◆ SetAccountId() [3/3]

◆ SetBucket() [1/3]

◆ SetBucket() [2/3]

◆ SetBucket() [3/3]

◆ WithAccountId() [1/3]

◆ WithAccountId() [2/3]

◆ WithAccountId() [3/3]

◆ WithBucket() [1/3]

◆ WithBucket() [2/3]

◆ WithBucket() [3/3]