AWS SDK for C++  1.8.100
AWS SDK for C++
Public Member Functions | List of all members
Aws::S3Control::Model::ListAccessPointsRequest Class Reference

#include <ListAccessPointsRequest.h>

+ Inheritance diagram for Aws::S3Control::Model::ListAccessPointsRequest:

Public Member Functions

 ListAccessPointsRequest ()
 
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::StringGetAccountId () const
 
bool AccountIdHasBeenSet () const
 
void SetAccountId (const Aws::String &value)
 
void SetAccountId (Aws::String &&value)
 
void SetAccountId (const char *value)
 
ListAccessPointsRequestWithAccountId (const Aws::String &value)
 
ListAccessPointsRequestWithAccountId (Aws::String &&value)
 
ListAccessPointsRequestWithAccountId (const char *value)
 
const Aws::StringGetBucket () const
 
bool BucketHasBeenSet () const
 
void SetBucket (const Aws::String &value)
 
void SetBucket (Aws::String &&value)
 
void SetBucket (const char *value)
 
ListAccessPointsRequestWithBucket (const Aws::String &value)
 
ListAccessPointsRequestWithBucket (Aws::String &&value)
 
ListAccessPointsRequestWithBucket (const char *value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListAccessPointsRequestWithNextToken (const Aws::String &value)
 
ListAccessPointsRequestWithNextToken (Aws::String &&value)
 
ListAccessPointsRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListAccessPointsRequestWithMaxResults (int 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::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 25 of file ListAccessPointsRequest.h.

Constructor & Destructor Documentation

◆ ListAccessPointsRequest()

Aws::S3Control::Model::ListAccessPointsRequest::ListAccessPointsRequest ( )

Member Function Documentation

◆ AccountIdHasBeenSet()

bool Aws::S3Control::Model::ListAccessPointsRequest::AccountIdHasBeenSet ( ) const
inline

The AWS account ID for owner of the bucket whose access points you want to list.

Definition at line 53 of file ListAccessPointsRequest.h.

◆ AddQueryStringParameters()

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

The name of the bucket whose associated access points you want to list.

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 AWS 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 120 of file ListAccessPointsRequest.h.

◆ GetAccountId()

const Aws::String& Aws::S3Control::Model::ListAccessPointsRequest::GetAccountId ( ) const
inline

The AWS account ID for owner of the bucket whose access points you want to list.

Definition at line 47 of file ListAccessPointsRequest.h.

◆ GetBucket()

const Aws::String& Aws::S3Control::Model::ListAccessPointsRequest::GetBucket ( ) const
inline

The name of the bucket whose associated access points you want to list.

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 AWS 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 105 of file ListAccessPointsRequest.h.

◆ GetMaxResults()

int Aws::S3Control::Model::ListAccessPointsRequest::GetMaxResults ( ) const
inline

The maximum number of access points that you want to include in the list. If the specified bucket has more than this number of access points, then the response will include a continuation token in the NextToken field that you can use to retrieve the next page of access points.

Definition at line 284 of file ListAccessPointsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::S3Control::Model::ListAccessPointsRequest::GetNextToken ( ) const
inline

A continuation token. If a previous call to ListAccessPoints returned a continuation token in the NextToken field, then providing that value here causes Amazon S3 to retrieve the next page of results.

Definition at line 219 of file ListAccessPointsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::S3Control::Model::ListAccessPointsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::S3Control::S3ControlRequest.

◆ GetServiceRequestName()

virtual const char* Aws::S3Control::Model::ListAccessPointsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file ListAccessPointsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::S3Control::Model::ListAccessPointsRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of access points that you want to include in the list. If the specified bucket has more than this number of access points, then the response will include a continuation token in the NextToken field that you can use to retrieve the next page of access points.

Definition at line 292 of file ListAccessPointsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::S3Control::Model::ListAccessPointsRequest::NextTokenHasBeenSet ( ) const
inline

A continuation token. If a previous call to ListAccessPoints returned a continuation token in the NextToken field, then providing that value here causes Amazon S3 to retrieve the next page of results.

Definition at line 227 of file ListAccessPointsRequest.h.

◆ SerializePayload()

Aws::String Aws::S3Control::Model::ListAccessPointsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAccountId() [1/3]

void Aws::S3Control::Model::ListAccessPointsRequest::SetAccountId ( const Aws::String value)
inline

The AWS account ID for owner of the bucket whose access points you want to list.

Definition at line 59 of file ListAccessPointsRequest.h.

◆ SetAccountId() [2/3]

void Aws::S3Control::Model::ListAccessPointsRequest::SetAccountId ( Aws::String &&  value)
inline

The AWS account ID for owner of the bucket whose access points you want to list.

Definition at line 65 of file ListAccessPointsRequest.h.

◆ SetAccountId() [3/3]

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

The AWS account ID for owner of the bucket whose access points you want to list.

Definition at line 71 of file ListAccessPointsRequest.h.

◆ SetBucket() [1/3]

void Aws::S3Control::Model::ListAccessPointsRequest::SetBucket ( const Aws::String value)
inline

The name of the bucket whose associated access points you want to list.

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 AWS 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 135 of file ListAccessPointsRequest.h.

◆ SetBucket() [2/3]

void Aws::S3Control::Model::ListAccessPointsRequest::SetBucket ( Aws::String &&  value)
inline

The name of the bucket whose associated access points you want to list.

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 AWS 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 150 of file ListAccessPointsRequest.h.

◆ SetBucket() [3/3]

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

The name of the bucket whose associated access points you want to list.

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 AWS 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 165 of file ListAccessPointsRequest.h.

◆ SetMaxResults()

void Aws::S3Control::Model::ListAccessPointsRequest::SetMaxResults ( int  value)
inline

The maximum number of access points that you want to include in the list. If the specified bucket has more than this number of access points, then the response will include a continuation token in the NextToken field that you can use to retrieve the next page of access points.

Definition at line 300 of file ListAccessPointsRequest.h.

◆ SetNextToken() [1/3]

void Aws::S3Control::Model::ListAccessPointsRequest::SetNextToken ( const Aws::String value)
inline

A continuation token. If a previous call to ListAccessPoints returned a continuation token in the NextToken field, then providing that value here causes Amazon S3 to retrieve the next page of results.

Definition at line 235 of file ListAccessPointsRequest.h.

◆ SetNextToken() [2/3]

void Aws::S3Control::Model::ListAccessPointsRequest::SetNextToken ( Aws::String &&  value)
inline

A continuation token. If a previous call to ListAccessPoints returned a continuation token in the NextToken field, then providing that value here causes Amazon S3 to retrieve the next page of results.

Definition at line 243 of file ListAccessPointsRequest.h.

◆ SetNextToken() [3/3]

void Aws::S3Control::Model::ListAccessPointsRequest::SetNextToken ( const char *  value)
inline

A continuation token. If a previous call to ListAccessPoints returned a continuation token in the NextToken field, then providing that value here causes Amazon S3 to retrieve the next page of results.

Definition at line 251 of file ListAccessPointsRequest.h.

◆ WithAccountId() [1/3]

ListAccessPointsRequest& Aws::S3Control::Model::ListAccessPointsRequest::WithAccountId ( const Aws::String value)
inline

The AWS account ID for owner of the bucket whose access points you want to list.

Definition at line 77 of file ListAccessPointsRequest.h.

◆ WithAccountId() [2/3]

ListAccessPointsRequest& Aws::S3Control::Model::ListAccessPointsRequest::WithAccountId ( Aws::String &&  value)
inline

The AWS account ID for owner of the bucket whose access points you want to list.

Definition at line 83 of file ListAccessPointsRequest.h.

◆ WithAccountId() [3/3]

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

The AWS account ID for owner of the bucket whose access points you want to list.

Definition at line 89 of file ListAccessPointsRequest.h.

◆ WithBucket() [1/3]

ListAccessPointsRequest& Aws::S3Control::Model::ListAccessPointsRequest::WithBucket ( const Aws::String value)
inline

The name of the bucket whose associated access points you want to list.

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 AWS 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 180 of file ListAccessPointsRequest.h.

◆ WithBucket() [2/3]

ListAccessPointsRequest& Aws::S3Control::Model::ListAccessPointsRequest::WithBucket ( Aws::String &&  value)
inline

The name of the bucket whose associated access points you want to list.

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 AWS 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 195 of file ListAccessPointsRequest.h.

◆ WithBucket() [3/3]

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

The name of the bucket whose associated access points you want to list.

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 AWS 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 210 of file ListAccessPointsRequest.h.

◆ WithMaxResults()

ListAccessPointsRequest& Aws::S3Control::Model::ListAccessPointsRequest::WithMaxResults ( int  value)
inline

The maximum number of access points that you want to include in the list. If the specified bucket has more than this number of access points, then the response will include a continuation token in the NextToken field that you can use to retrieve the next page of access points.

Definition at line 308 of file ListAccessPointsRequest.h.

◆ WithNextToken() [1/3]

ListAccessPointsRequest& Aws::S3Control::Model::ListAccessPointsRequest::WithNextToken ( const Aws::String value)
inline

A continuation token. If a previous call to ListAccessPoints returned a continuation token in the NextToken field, then providing that value here causes Amazon S3 to retrieve the next page of results.

Definition at line 259 of file ListAccessPointsRequest.h.

◆ WithNextToken() [2/3]

ListAccessPointsRequest& Aws::S3Control::Model::ListAccessPointsRequest::WithNextToken ( Aws::String &&  value)
inline

A continuation token. If a previous call to ListAccessPoints returned a continuation token in the NextToken field, then providing that value here causes Amazon S3 to retrieve the next page of results.

Definition at line 267 of file ListAccessPointsRequest.h.

◆ WithNextToken() [3/3]

ListAccessPointsRequest& Aws::S3Control::Model::ListAccessPointsRequest::WithNextToken ( const char *  value)
inline

A continuation token. If a previous call to ListAccessPoints returned a continuation token in the NextToken field, then providing that value here causes Amazon S3 to retrieve the next page of results.

Definition at line 275 of file ListAccessPointsRequest.h.


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