| Copyright | (c) 2013-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.SQS.AddPermission
Description
Adds a permission to a queue for a specific principal. This allows for sharing access to the queue.
When you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue. For more information about these permissions, see Shared Queues in the Amazon SQS Developer Guide.
AddPermission writes an Amazon SQS-generated policy. If you want to
write your own policy, use SetQueueAttributes to upload your policy.
For more information about writing your own policy, see
Using The Access Policy Language
in the Amazon SQS Developer Guide.
Some API actions take lists of parameters. These lists are specified
using the 'param.n' notation. Values of n are integers starting from
1. For example, a parameter list with two elements looks like this:
'&Attribute.1=this'
'&Attribute.2=that'
Creating a Request
Arguments
| :: Text | |
| -> Text | |
| -> AddPermission |
Creates a value of AddPermission with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data AddPermission Source
See: addPermission smart constructor.
Instances
Request Lenses
apQueueURL :: Lens' AddPermission Text Source
The URL of the Amazon SQS queue to take action on.
apLabel :: Lens' AddPermission Text Source
The unique identification of the permission you're setting (e.g.,
AliceSendMessage). Constraints: Maximum 80 characters; alphanumeric
characters, hyphens (-), and underscores (_) are allowed.
apAWSAccountIds :: Lens' AddPermission [Text] Source
The AWS account number of the principal who will be given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon SQS Developer Guide.
apActions :: Lens' AddPermission [Text] Source
The action the client wants to allow for the specified principal. The following are valid values: '* | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl'. For more information about these actions, see Understanding Permissions in the Amazon SQS Developer Guide.
Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility
for the n also grants permissions for the corresponding
batch versions of those actions: SendMessageBatch,
DeleteMessageBatch, and ChangeMessageVisibilityBatch.
Destructuring the Response
addPermissionResponse :: AddPermissionResponse Source
Creates a value of AddPermissionResponse with the minimum fields required to make a request.
data AddPermissionResponse Source
See: addPermissionResponse smart constructor.