Actions, resources, and condition keys for AWS Batch - AWS Identity and Access Management

Actions, resources, and condition keys for AWS Batch

Tip

This page is moving to a new location on November 16, 2020. Please update your bookmark to use the new page at https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsbatch.html.

AWS Batch (service prefix: batch) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.

References:

Actions defined by AWS Batch

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 indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") 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. Required resources are indicated in the table with an asterisk (*). If you specify a resource-level permission ARN in a statement using this action, then it must be of this type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one but not the other.

For details about the columns in the following table, see The actions table.

Actions Description Access level Resource types (*required) Condition keys Dependent actions
CancelJob Cancels a job in an AWS Batch job queue. Write

job*

CreateComputeEnvironment Creates an AWS Batch compute environment. Write

aws:RequestTag/${TagKey}

aws:TagKeys

CreateJobQueue Creates an AWS Batch job queue. Write

compute-environment*

aws:RequestTag/${TagKey}

aws:TagKeys

DeleteComputeEnvironment Deletes an AWS Batch compute environment. Write

compute-environment*

DeleteJobQueue Deletes the specified job queue. Write

job-queue*

DeregisterJobDefinition Deregisters an AWS Batch job definition. Write

job-definition*

DescribeComputeEnvironments Describes one or more of your compute environments. Read
DescribeJobDefinitions Describes a list of job definitions. Read
DescribeJobQueues Describes one or more of your job queues. Read
DescribeJobs Describes a list of AWS Batch jobs. Read
ListJobs Returns a list of task jobs for a specified job queue. List
ListTagsForResource List tags for the specified resource. List

compute-environment

job

job-definition

job-queue

RegisterJobDefinition Registers an AWS Batch job definition. Write

batch:User

batch:Privileged

batch:Image

batch:LogDriver

batch:AWSLogsGroup

batch:AWSLogsRegion

batch:AWSLogsStreamPrefix

batch:AWSLogsCreateGroup

aws:RequestTag/${TagKey}

aws:TagKeys

SubmitJob Submits an AWS Batch job from a job definition. Write

job-definition*

job-queue*

aws:RequestTag/${TagKey}

aws:TagKeys

TagResource Tags the specified resource. Tagging

compute-environment

job

job-definition

job-queue

aws:RequestTag/${TagKey}

aws:TagKeys

TerminateJob Terminates a job in an AWS Batch job queue. Write

job*

UntagResource Untags the specified resource. Tagging

compute-environment

job

job-definition

job-queue

aws:TagKeys

UpdateComputeEnvironment Updates an AWS Batch compute environment. Write

compute-environment*

UpdateJobQueue Updates a job queue. Write

job-queue*

Resource types defined by AWS Batch

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 table. For details about the columns in the following table, see The resource types table.

Resource types ARN Condition keys
compute-environment arn:${Partition}:batch:${Region}:${Account}:compute-environment/${ComputeEnvironmentName}

aws:ResourceTag/${TagKey}

job-queue arn:${Partition}:batch:${Region}:${Account}:job-queue/${JobQueueName}

aws:ResourceTag/${TagKey}

job-definition arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}

aws:ResourceTag/${TagKey}

job arn:${Partition}:batch:${Region}:${Account}:job/${jobId}

aws:ResourceTag/${TagKey}

Condition keys for AWS Batch

AWS Batch 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 The 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 actions based on the tags that are passed in the request. String
aws:ResourceTag/${TagKey} Filters actions based on the tags associated with the resource. String
aws:TagKeys Filters actions based on the tag keys that are passed in the request. String
batch:AWSLogsCreateGroup When this parameter is true, the awslogs-group will be created for the logs. Boolean
batch:AWSLogsGroup The awslogs group where the logs are located. String
batch:AWSLogsRegion The region where the logs are sent to. String
batch:AWSLogsStreamPrefix The awslogs log stream prefix. String
batch:Image The image used to start a container. String
batch:LogDriver The log driver used for the container. String
batch:Privileged When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). Boolean
batch:User The user name or numeric uid to use inside the container. String