Actions, resources, and condition keys for AWS CodeBuild - Service Authorization Reference

# Actions, resources, and condition keys for AWS CodeBuild

AWS CodeBuild (service prefix: `codebuild` ) 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 AWS CodeBuild
- Resource types defined by AWS CodeBuild
- Condition keys for AWS CodeBuild

## Actions defined by AWS CodeBuild

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
--- | --- | --- | --- | --- | ---
BatchDeleteBuilds | Deletes one or more builds. | Write | project* |  |
BatchGetBuildBatches | Gets information about one or more build batches. | Read | project* |  |
BatchGetBuilds | Gets information about one or more builds. | Read | project* |  |
BatchGetProjects | Gets information about one or more build projects. | Read | project* |  |
BatchGetReportGroups | Returns an array of ReportGroup objects that are specified by the input reportGroupArns parameter. | Read | report-group* |  |
BatchGetReports | Returns an array of the Report objects specified by the input reportArns parameter. | Read | report-group* |  |
BatchPutCodeCoverages [permission only] | Adds or updates information about a report. | Write | report-group* |  |
BatchPutTestCases [permission only] | Adds or updates information about a report. | Write | report-group* |  |
CreateProject | Creates a build project. | Write | project* |  |
| aws:RequestTag/${TagKey} aws:TagKeys |
CreateReport [permission only] | Creates a report. A report is created when tests specified in the buildspec file for a report groups run during the build of a project. | Write | report-group* |  |
CreateReportGroup | Creates a report group. | Write | report-group* |  |
| aws:RequestTag/${TagKey} aws:TagKeys |
CreateWebhook | For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables AWS CodeBuild to start rebuilding the source code every time a code change is pushed to the repository. | Write | project* |  |
DeleteBuildBatch | Deletes a build batch. | Write | project* |  |
DeleteOAuthToken [permission only] | Deletes an OAuth token from a connected third-party OAuth provider. Only used in the AWS CodeBuild console. | Write |  |  |
DeleteProject | Deletes a build project. | Write | project* |  |
DeleteReport | Deletes a report. | Write | report-group* |  |
DeleteReportGroup | Deletes a report group. | Write | report-group* |  |
DeleteResourcePolicy | Deletes a resource policy for the associated project or report group. | Permissions management | project |  |
report-group |  |
DeleteSourceCredentials | Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials. | Write |  |  |
DeleteWebhook | For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops AWS CodeBuild from rebuilding the source code every time a code change is pushed to the repository. | Write | project* |  |
DescribeCodeCoverages | Returns an array of CodeCoverage objects. | Read | report-group* |  |
DescribeTestCases | Returns an array of TestCase objects. | Read | report-group* |  |
GetReportGroupTrend | Analyzes and accumulates test report values for the test reports in the specified report group. | Read | report-group* |  |
GetResourcePolicy | Returns a resource policy for the specified project or report group. | Read | project |  |
report-group |  |
ImportSourceCredentials | Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository. | Write |  |  |
InvalidateProjectCache | Resets the cache for a project. | Write | project* |  |
ListBuildBatches | Gets a list of build batch IDs, with each build batch ID representing a single build batch. | List |  |  |
ListBuildBatchesForProject | Gets a list of build batch IDs for the specified build project, with each build batch ID representing a single build batch. | List | project* |  |
ListBuilds | Gets a list of build IDs, with each build ID representing a single build. | List |  |  |
ListBuildsForProject | Gets a list of build IDs for the specified build project, with each build ID representing a single build. | List | project* |  |
ListConnectedOAuthAccounts [permission only] | Lists connected third-party OAuth providers. Only used in the AWS CodeBuild console. | List |  |  |
ListCuratedEnvironmentImages | Gets information about Docker images that are managed by AWS CodeBuild. | List |  |  |
ListProjects | Gets a list of build project names, with each build project name representing a single build project. | List |  |  |
ListReportGroups | Returns a list of report group ARNs. Each report group ARN represents one report group. | List |  |  |
ListReports | Returns a list of report ARNs. Each report ARN representing one report. | List |  |  |
ListReportsForReportGroup | Returns a list of report ARNs that belong to the specified report group. Each report ARN represents one report. | List | report-group* |  |
ListRepositories [permission only] | Lists source code repositories from a connected third-party OAuth provider. Only used in the AWS CodeBuild console. | List |  |  |
ListSharedProjects | Returns a list of project ARNs that have been shared with the requester. Each project ARN represents one project. | List |  |  |
ListSharedReportGroups | Returns a list of report group ARNs that have been shared with the requester. Each report group ARN represents one report group. | List |  |  |
ListSourceCredentials | Returns a list of SourceCredentialsInfo objects. | List |  |  |
PersistOAuthToken [permission only] | Saves an OAuth token from a connected third-party OAuth provider. Only used in the AWS CodeBuild console. | Write |  |  |
PutResourcePolicy | Creates a resource policy for the associated project or report group. | Permissions management | project |  |
report-group |  |
RetryBuild | Retries a build. | Write | project* |  |
RetryBuildBatch | Retries a build batch. | Write | project* |  |
StartBuild | Starts running a build. | Write | project* |  |
StartBuildBatch | Starts running a build batch. | Write | project* |  |
StopBuild | Attempts to stop running a build. | Write | project* |  |
StopBuildBatch | Attempts to stop running a build batch. | Write | project* |  |
UpdateProject | Changes the settings of an existing build project. | Write | project* |  |
| aws:RequestTag/${TagKey} aws:TagKeys |
UpdateReport [permission only] | Updates information about a report. | Write | report-group* |  |
UpdateReportGroup | Changes the settings of an existing report group. | Write | report-group* |  |
| aws:RequestTag/${TagKey} aws:TagKeys |
UpdateWebhook | Updates the webhook associated with an AWS CodeBuild build project. | Write | project* |  |

## Resource types defined by AWS CodeBuild

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
--- | --- | ---
build | `arn:$ { Partition}:codebuild:$ { Region}:$ { Account}:build/$ { BuildId}` |
build-batch | `arn:$ { Partition}:codebuild:$ { Region}:$ { Account}:build-batch/$ { BuildBatchId}` |
project | `arn:$ { Partition}:codebuild:$ { Region}:$ { Account}:project/$ { ProjectName}` | aws:ResourceTag/${TagKey}
report-group | `arn:$ { Partition}:codebuild:$ { Region}:$ { Account}:report-group/$ { ReportGroupName}` | aws:ResourceTag/${TagKey}
report | `arn:$ { Partition}:codebuild:$ { Region}:$ { Account}:report/$ { ReportGroupName}:$ { ReportId}` |

## Condition keys for AWS CodeBuild

AWS CodeBuild 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 presence of tag key-value pairs in the request | String
aws:ResourceTag/${TagKey} | Filters actions based on tag key-value pairs attached to the resource | String
aws:TagKeys | Filters actions based on the presence of tag keys in the request | String

Did this page help you? - Yes

Thanks for letting us know we're doing a good job!

If you've got a moment, please tell us what we did right so we can do more of it.

Did this page help you? - No

Thanks for letting us know this page needs work. We're sorry we let you down.

If you've got a moment, please tell us how we can make the documentation better.