AWS SDK for C++  1.9.68
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::SQS::Model::AddPermissionRequest Class Reference

#include <AddPermissionRequest.h>

+ Inheritance diagram for Aws::SQS::Model::AddPermissionRequest:

Public Member Functions

 AddPermissionRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetQueueUrl () const
 
bool QueueUrlHasBeenSet () const
 
void SetQueueUrl (const Aws::String &value)
 
void SetQueueUrl (Aws::String &&value)
 
void SetQueueUrl (const char *value)
 
AddPermissionRequestWithQueueUrl (const Aws::String &value)
 
AddPermissionRequestWithQueueUrl (Aws::String &&value)
 
AddPermissionRequestWithQueueUrl (const char *value)
 
const Aws::StringGetLabel () const
 
bool LabelHasBeenSet () const
 
void SetLabel (const Aws::String &value)
 
void SetLabel (Aws::String &&value)
 
void SetLabel (const char *value)
 
AddPermissionRequestWithLabel (const Aws::String &value)
 
AddPermissionRequestWithLabel (Aws::String &&value)
 
AddPermissionRequestWithLabel (const char *value)
 
const Aws::Vector< Aws::String > & GetAWSAccountIds () const
 
bool AWSAccountIdsHasBeenSet () const
 
void SetAWSAccountIds (const Aws::Vector< Aws::String > &value)
 
void SetAWSAccountIds (Aws::Vector< Aws::String > &&value)
 
AddPermissionRequestWithAWSAccountIds (const Aws::Vector< Aws::String > &value)
 
AddPermissionRequestWithAWSAccountIds (Aws::Vector< Aws::String > &&value)
 
AddPermissionRequestAddAWSAccountIds (const Aws::String &value)
 
AddPermissionRequestAddAWSAccountIds (Aws::String &&value)
 
AddPermissionRequestAddAWSAccountIds (const char *value)
 
const Aws::Vector< Aws::String > & GetActions () const
 
bool ActionsHasBeenSet () const
 
void SetActions (const Aws::Vector< Aws::String > &value)
 
void SetActions (Aws::Vector< Aws::String > &&value)
 
AddPermissionRequestWithActions (const Aws::Vector< Aws::String > &value)
 
AddPermissionRequestWithActions (Aws::Vector< Aws::String > &&value)
 
AddPermissionRequestAddActions (const Aws::String &value)
 
AddPermissionRequestAddActions (Aws::String &&value)
 
AddPermissionRequestAddActions (const char *value)
 
- Public Member Functions inherited from Aws::SQS::SQSRequest
virtual ~SQSRequest ()
 
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 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 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
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::SQS::SQSRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

See Also:

AWS API Reference

Definition at line 25 of file AddPermissionRequest.h.

Constructor & Destructor Documentation

◆ AddPermissionRequest()

Aws::SQS::Model::AddPermissionRequest::AddPermissionRequest ( )

Member Function Documentation

◆ ActionsHasBeenSet()

bool Aws::SQS::Model::AddPermissionRequest::ActionsHasBeenSet ( ) const
inline

The action the client wants to allow for the specified principal. Valid values: the name of any action or *.

For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon SQS Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

Definition at line 285 of file AddPermissionRequest.h.

◆ AddActions() [1/3]

AddPermissionRequest& Aws::SQS::Model::AddPermissionRequest::AddActions ( Aws::String &&  value)
inline

The action the client wants to allow for the specified principal. Valid values: the name of any action or *.

For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon SQS Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

Definition at line 375 of file AddPermissionRequest.h.

◆ AddActions() [2/3]

AddPermissionRequest& Aws::SQS::Model::AddPermissionRequest::AddActions ( const Aws::String value)
inline

The action the client wants to allow for the specified principal. Valid values: the name of any action or *.

For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon SQS Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

Definition at line 360 of file AddPermissionRequest.h.

◆ AddActions() [3/3]

AddPermissionRequest& Aws::SQS::Model::AddPermissionRequest::AddActions ( const char *  value)
inline

The action the client wants to allow for the specified principal. Valid values: the name of any action or *.

For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon SQS Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

Definition at line 390 of file AddPermissionRequest.h.

◆ AddAWSAccountIds() [1/3]

AddPermissionRequest& Aws::SQS::Model::AddPermissionRequest::AddAWSAccountIds ( Aws::String &&  value)
inline

The account numbers of the principals who are to receive permission. For information about locating the account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.

Definition at line 243 of file AddPermissionRequest.h.

◆ AddAWSAccountIds() [2/3]

AddPermissionRequest& Aws::SQS::Model::AddPermissionRequest::AddAWSAccountIds ( const Aws::String value)
inline

The account numbers of the principals who are to receive permission. For information about locating the account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.

Definition at line 232 of file AddPermissionRequest.h.

◆ AddAWSAccountIds() [3/3]

AddPermissionRequest& Aws::SQS::Model::AddPermissionRequest::AddAWSAccountIds ( const char *  value)
inline

The account numbers of the principals who are to receive permission. For information about locating the account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.

Definition at line 254 of file AddPermissionRequest.h.

◆ AWSAccountIdsHasBeenSet()

bool Aws::SQS::Model::AddPermissionRequest::AWSAccountIdsHasBeenSet ( ) const
inline

The account numbers of the principals who are to receive permission. For information about locating the account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.

Definition at line 177 of file AddPermissionRequest.h.

◆ DumpBodyToUrl()

void Aws::SQS::Model::AddPermissionRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetActions()

const Aws::Vector<Aws::String>& Aws::SQS::Model::AddPermissionRequest::GetActions ( ) const
inline

The action the client wants to allow for the specified principal. Valid values: the name of any action or *.

For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon SQS Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

Definition at line 270 of file AddPermissionRequest.h.

◆ GetAWSAccountIds()

const Aws::Vector<Aws::String>& Aws::SQS::Model::AddPermissionRequest::GetAWSAccountIds ( ) const
inline

The account numbers of the principals who are to receive permission. For information about locating the account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.

Definition at line 166 of file AddPermissionRequest.h.

◆ GetLabel()

const Aws::String& Aws::SQS::Model::AddPermissionRequest::GetLabel ( ) const
inline

The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).

Definition at line 98 of file AddPermissionRequest.h.

◆ GetQueueUrl()

const Aws::String& Aws::SQS::Model::AddPermissionRequest::GetQueueUrl ( ) const
inline

The URL of the Amazon SQS queue to which permissions are added.

Queue URLs and names are case-sensitive.

Definition at line 47 of file AddPermissionRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::SQS::Model::AddPermissionRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file AddPermissionRequest.h.

◆ LabelHasBeenSet()

bool Aws::SQS::Model::AddPermissionRequest::LabelHasBeenSet ( ) const
inline

The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).

Definition at line 106 of file AddPermissionRequest.h.

◆ QueueUrlHasBeenSet()

bool Aws::SQS::Model::AddPermissionRequest::QueueUrlHasBeenSet ( ) const
inline

The URL of the Amazon SQS queue to which permissions are added.

Queue URLs and names are case-sensitive.

Definition at line 53 of file AddPermissionRequest.h.

◆ SerializePayload()

Aws::String Aws::SQS::Model::AddPermissionRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetActions() [1/2]

void Aws::SQS::Model::AddPermissionRequest::SetActions ( Aws::Vector< Aws::String > &&  value)
inline

The action the client wants to allow for the specified principal. Valid values: the name of any action or *.

For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon SQS Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

Definition at line 315 of file AddPermissionRequest.h.

◆ SetActions() [2/2]

void Aws::SQS::Model::AddPermissionRequest::SetActions ( const Aws::Vector< Aws::String > &  value)
inline

The action the client wants to allow for the specified principal. Valid values: the name of any action or *.

For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon SQS Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

Definition at line 300 of file AddPermissionRequest.h.

◆ SetAWSAccountIds() [1/2]

void Aws::SQS::Model::AddPermissionRequest::SetAWSAccountIds ( Aws::Vector< Aws::String > &&  value)
inline

The account numbers of the principals who are to receive permission. For information about locating the account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.

Definition at line 199 of file AddPermissionRequest.h.

◆ SetAWSAccountIds() [2/2]

void Aws::SQS::Model::AddPermissionRequest::SetAWSAccountIds ( const Aws::Vector< Aws::String > &  value)
inline

The account numbers of the principals who are to receive permission. For information about locating the account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.

Definition at line 188 of file AddPermissionRequest.h.

◆ SetLabel() [1/3]

void Aws::SQS::Model::AddPermissionRequest::SetLabel ( Aws::String &&  value)
inline

The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).

Definition at line 122 of file AddPermissionRequest.h.

◆ SetLabel() [2/3]

void Aws::SQS::Model::AddPermissionRequest::SetLabel ( const Aws::String value)
inline

The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).

Definition at line 114 of file AddPermissionRequest.h.

◆ SetLabel() [3/3]

void Aws::SQS::Model::AddPermissionRequest::SetLabel ( const char *  value)
inline

The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).

Definition at line 130 of file AddPermissionRequest.h.

◆ SetQueueUrl() [1/3]

void Aws::SQS::Model::AddPermissionRequest::SetQueueUrl ( Aws::String &&  value)
inline

The URL of the Amazon SQS queue to which permissions are added.

Queue URLs and names are case-sensitive.

Definition at line 65 of file AddPermissionRequest.h.

◆ SetQueueUrl() [2/3]

void Aws::SQS::Model::AddPermissionRequest::SetQueueUrl ( const Aws::String value)
inline

The URL of the Amazon SQS queue to which permissions are added.

Queue URLs and names are case-sensitive.

Definition at line 59 of file AddPermissionRequest.h.

◆ SetQueueUrl() [3/3]

void Aws::SQS::Model::AddPermissionRequest::SetQueueUrl ( const char *  value)
inline

The URL of the Amazon SQS queue to which permissions are added.

Queue URLs and names are case-sensitive.

Definition at line 71 of file AddPermissionRequest.h.

◆ WithActions() [1/2]

AddPermissionRequest& Aws::SQS::Model::AddPermissionRequest::WithActions ( Aws::Vector< Aws::String > &&  value)
inline

The action the client wants to allow for the specified principal. Valid values: the name of any action or *.

For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon SQS Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

Definition at line 345 of file AddPermissionRequest.h.

◆ WithActions() [2/2]

AddPermissionRequest& Aws::SQS::Model::AddPermissionRequest::WithActions ( const Aws::Vector< Aws::String > &  value)
inline

The action the client wants to allow for the specified principal. Valid values: the name of any action or *.

For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon SQS Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

Definition at line 330 of file AddPermissionRequest.h.

◆ WithAWSAccountIds() [1/2]

AddPermissionRequest& Aws::SQS::Model::AddPermissionRequest::WithAWSAccountIds ( Aws::Vector< Aws::String > &&  value)
inline

The account numbers of the principals who are to receive permission. For information about locating the account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.

Definition at line 221 of file AddPermissionRequest.h.

◆ WithAWSAccountIds() [2/2]

AddPermissionRequest& Aws::SQS::Model::AddPermissionRequest::WithAWSAccountIds ( const Aws::Vector< Aws::String > &  value)
inline

The account numbers of the principals who are to receive permission. For information about locating the account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.

Definition at line 210 of file AddPermissionRequest.h.

◆ WithLabel() [1/3]

AddPermissionRequest& Aws::SQS::Model::AddPermissionRequest::WithLabel ( Aws::String &&  value)
inline

The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).

Definition at line 146 of file AddPermissionRequest.h.

◆ WithLabel() [2/3]

AddPermissionRequest& Aws::SQS::Model::AddPermissionRequest::WithLabel ( const Aws::String value)
inline

The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).

Definition at line 138 of file AddPermissionRequest.h.

◆ WithLabel() [3/3]

AddPermissionRequest& Aws::SQS::Model::AddPermissionRequest::WithLabel ( const char *  value)
inline

The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).

Definition at line 154 of file AddPermissionRequest.h.

◆ WithQueueUrl() [1/3]

AddPermissionRequest& Aws::SQS::Model::AddPermissionRequest::WithQueueUrl ( Aws::String &&  value)
inline

The URL of the Amazon SQS queue to which permissions are added.

Queue URLs and names are case-sensitive.

Definition at line 83 of file AddPermissionRequest.h.

◆ WithQueueUrl() [2/3]

AddPermissionRequest& Aws::SQS::Model::AddPermissionRequest::WithQueueUrl ( const Aws::String value)
inline

The URL of the Amazon SQS queue to which permissions are added.

Queue URLs and names are case-sensitive.

Definition at line 77 of file AddPermissionRequest.h.

◆ WithQueueUrl() [3/3]

AddPermissionRequest& Aws::SQS::Model::AddPermissionRequest::WithQueueUrl ( const char *  value)
inline

The URL of the Amazon SQS queue to which permissions are added.

Queue URLs and names are case-sensitive.

Definition at line 89 of file AddPermissionRequest.h.


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