Actions, resources, and condition keys for AWS Backup Search
AWS Backup Search (service prefix: backup-search) provides the following
service-specific operations, resources, actions, and condition 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.
-
View the programmatic service authorization reference
for this service.
Topics
API operations defined by AWS Backup Search
The following table maps API operations to the IAM actions they authorize. Only condition keys that have static values for the given API and action are listed; for the full set of condition keys supported by each action, see the Actions table.
| Operation | IAM action | Condition key | Possible value(s) | Access level |
|---|---|---|---|---|
|
GetSearchJob |
Read |
|||
|
GetSearchResultExportJob |
Read |
|||
|
ListSearchJobBackups |
Read |
|||
|
ListSearchJobResults |
Read |
|||
|
ListSearchJobs |
List |
|||
|
ListSearchResultExportJobs |
List |
|||
|
ListTagsForResource |
Read |
|||
|
StartSearchJob |
Write |
|||
Tagging, Write |
||||
|
StartSearchResultExportJob |
Write |
|||
|
StopSearchJob |
Write |
|||
|
TagResource |
Tagging, Write |
Actions defined by AWS Backup Search
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.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to get details of a search job |
Read |
|||
Grants permission to get details of a search result export job |
Read |
|||
Grants permission to list backups in scope of a search job |
Read |
|||
Grants permission to list results of a search job |
Read |
|||
Grants permission to list search jobs |
List |
|||
Grants permission to list search result export jobs |
List |
|||
Grants permission to list tags for a resource |
Read |
|||
Grants permission to create a search job |
Write |
|||
Grants permission to start an export job for an existing search job |
Write |
|||
Grants permission to stop an in-progress search job |
Write |
|||
Grants permission to tag a resource |
Tagging, Write |
|||
Grants permission to untag a resource |
Tagging, Write |
|||
Resource types defined by AWS Backup Search
The following resource types are defined by this service and can be used in the
Resource element of IAM permission policy statements.
| Resource types | ARN | Condition keys |
|---|---|---|
arn:${Partition}:backup-search:${Region}:${Account}:search-export-job/${ResourceId} |
||
arn:${Partition}:backup-search:${Region}:${Account}:search-job/${ResourceId} |
Condition keys for AWS Backup Search
AWS Backup Search defines the following condition keys that can be used in the
Condition element of an IAM policy.
| Condition keys | Description | Type |
|---|---|---|
Filters access by the allowed set of values for each of the tags |
String |
|
Filters access by the tags associated with the resource |
String |
|
Filters access by the presence of mandatory tags in the request |
ArrayOfString |
