Actions, resources, and condition keys for Amazon SQS
Amazon SQS (service prefix: sqs
) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.
References:
-
Learn how to configure this service.
-
View a list of the API operations available for this service.
-
Learn how to secure this service and its resources by using IAM permission policies.
Topics
Actions defined by Amazon SQS
You can specify the following actions in the Action
element of an IAM policy statement. Use policies to grant permissions to perform an operation in AWS. When you use an action in a policy, you usually allow or deny access to the API operation or CLI command with the same name. However, in some cases, a single action controls access to more than one operation. Alternatively, some operations require several different actions.
The Resource types column of the Actions table indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") to which the policy applies in the Resource
element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. If the action has one or more required resources, the caller must have permission to use the action with those resources. Required resources are indicated in the table with an asterisk (*). If you limit resource access with the Resource
element in an IAM policy, you must include an ARN or pattern for each required resource type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one of the optional resource types.
The Condition keys column of the Actions table includes keys that you can specify in a policy statement's Condition
element. For more information on the condition keys that are associated with resources for the service, see the Condition keys column of the Resource types table.
Note
Resource condition keys are listed in the Resource types table. You can find a link to the resource type that applies to an action in the Resource types (*required) column of the Actions table. The resource type in the Resource types table includes the Condition keys column, which are the resource condition keys that apply to an action in the Actions table.
For details about the columns in the following table, see Actions table.
Actions | Description | Access level | Resource types (*required) | Condition keys | Dependent actions |
---|---|---|---|---|---|
AddPermission | Grants permission to a queue for a specific principal | Permissions management | |||
CancelMessageMoveTask | Grants permission to cancel an in progress message move task | Write | |||
ChangeMessageVisibility | Grants permission to change the visibility timeout of a specified message in a queue to a new value | Write | |||
CreateQueue | Grants permission to create a new queue, or returns the URL of an existing one | Write | |||
DeleteMessage | Grants permission to delete the specified message from the specified queue | Write | |||
DeleteQueue | Grants permission to delete the queue specified by the queue URL, regardless of whether the queue is empty | Write | |||
GetQueueAttributes | Grants permission to get attributes for the specified queue | Read | |||
GetQueueUrl | Grants permission to return the URL of an existing queue | Read | |||
ListDeadLetterSourceQueues | Grants permission to return a list of your queues that have the RedrivePolicy queue attribute configured with a dead letter queue | Read | |||
ListMessageMoveTasks | Grants permission to list message move tasks | Read | |||
ListQueueTags | Grants permission to list tags added to an SQS queue | Read | |||
ListQueues | Grants permission to return a list of your queues | Read | |||
PurgeQueue | Grants permission to delete the messages in a queue specified by the queue URL | Write | |||
ReceiveMessage | Grants permission to retrieve one or more messages, with a maximum limit of 10 messages, from the specified queue | Read | |||
RemovePermission | Grants permission to revoke any permissions in the queue policy that matches the specified Label parameter | Permissions management | |||
SendMessage | Grants permission to deliver a message to the specified queue | Write | |||
SetQueueAttributes | Grants permission to set the value of one or more queue attributes | Write | |||
StartMessageMoveTask | Grants permission to start a message move task | Write | |||
TagQueue | Grants permission to add tags to the specified SQS queue | Tagging | |||
UntagQueue | Grants permission to remove tags from the specified SQS queue | Tagging | |||
Resource types defined by Amazon SQS
The following resource types are defined by this service and can be used in the Resource
element of IAM permission policy statements. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the Resource types table. For details about the columns in the following table, see Resource types table.
Note
The ARN of the queue is used only in IAM permission policies. In API and CLI calls, you use the queue's URL instead.
Resource types | ARN | Condition keys |
---|---|---|
queue |
arn:${Partition}:sqs:${Region}:${Account}:${QueueName}
|
Condition keys for Amazon SQS
Amazon SQS defines the following condition keys that can be used in the Condition
element of an IAM policy. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see Condition keys table.
To view the global condition keys that are available to all services, see Available global condition keys.
Condition keys | Description | Type |
---|---|---|
aws:RequestTag/${TagKey} | Filters access by the tags that are passed in the request | String |
aws:ResourceTag/${TagKey} | Filters access by the tags associated with the resource | String |
aws:TagKeys | Filters access by the tag keys that are passed in the request | ArrayOfString |