Actions, resources, and condition keys for AWS DeepRacer
AWS DeepRacer (service prefix: deepracer) 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 DeepRacer
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 Actions table.
| Actions | Description | Access level | Resource types (*required) | Condition keys | Dependent actions |
|---|---|---|---|---|---|
| AddLeaderboardAccessPermission [permission only] | Grants permission to add access for a private leaderboard | Write | |||
| AdminGetAccountConfig [permission only] | Grants permission to get current admin multiuser configuration for this account | Read | |||
| AdminListAssociatedResources [permission only] | Grants permission to list all deepracer users with their associated resources created under this account | Read | |||
| AdminListAssociatedUsers [permission only] | Grants permission to list user data for all users associated with this account | Read | |||
| AdminManageUser [permission only] | Grants permission to manage a user associated with this account | Write | |||
| AdminSetAccountConfig [permission only] | Grants permission to set configuration options for this account | Write | |||
| CloneReinforcementLearningModel [permission only] | Grants permission to clone an existing DeepRacer model | Write | |||
| CreateCar [permission only] | Grants permission to create a DeepRacer car in your garage | Write | |||
| CreateLeaderboard [permission only] | Grants permission to create a leaderboard | Write | |||
| CreateLeaderboardAccessToken [permission only] | Grants permission to create an access token for a private leaderboard | Write | |||
| CreateLeaderboardSubmission [permission only] | Grants permission to submit a DeepRacer model to be evaluated for leaderboards | Write | |||
| CreateReinforcementLearningModel [permission only] | Grants permission to create ra einforcement learning model for DeepRacer | Write | |||
| DeleteLeaderboard [permission only] | Grants permission to delete a leaderboard | Write | |||
| DeleteModel [permission only] | Grants permission to delete a DeepRacer model | Write | |||
| EditLeaderboard [permission only] | Grants permission to edit a leaderboard | Write | |||
| GetAccountConfig [permission only] | Grants permission to get current multiuser configuration for this account | Read | |||
| GetAlias [permission only] | Grants permission to retrieve the user's alias for submitting a DeepRacer model to leaderboards | Read | |||
| GetAssetUrl [permission only] | Grants permission to download artifacts for an existing DeepRacer model | Read | |||
| GetCar [permission only] | Grants permission to retrieve a specific DeepRacer car from your garage | Read | |||
| GetCars [permission only] | Grants permission to view all the DeepRacer cars in your garage | Read | |||
| GetEvaluation [permission only] | Grants permission to retrieve information about an existing DeepRacer model's evaluation jobs | Read | |||
| GetLatestUserSubmission [permission only] | Grants permission to retrieve information about how the latest submitted DeepRacer model for a user performed on a leaderboard | Read | |||
| GetLeaderboard [permission only] | Grants permission to retrieve information about leaderboards | Read | |||
| GetModel [permission only] | Grants permission to retrieve information about an existing DeepRacer model | Read | |||
| GetPrivateLeaderboard [permission only] | Grants permission to retrieve information about private leaderboards | Read | |||
| GetRankedUserSubmission [permission only] | Grants permission to retrieve information about the performance of a user's DeepRacer model that got placed on a leaderboard | Read | |||
| GetTrack [permission only] | Grants permission to retrieve information about DeepRacer tracks | Read | |||
| GetTrainingJob [permission only] | Grants permission to retrieve information about an existing DeepRacer model's training job | Read | |||
| ImportModel [permission only] | Grants permission to import a reinforcement learning model for DeepRacer | Write | |||
| ListEvaluations [permission only] | Grants permission to list a DeepRacer model's evaluation jobs | Read | |||
| ListLeaderboardSubmissions [permission only] | Grants permission to list all the DeepRacer model submissions of a user on a leaderboard | Read | |||
| ListLeaderboards [permission only] | Grants permission to list all the available leaderboards | Read | |||
| ListModels [permission only] | Grants permission to list all existing DeepRacer models | Read | |||
| ListPrivateLeaderboardParticipants [permission only] | Grants permission to retrieve participant information about private leaderboards | Read | |||
| ListPrivateLeaderboards [permission only] | Grants permission to list all the available private leaderboards | Read | |||
| ListSubscribedPrivateLeaderboards [permission only] | Grants permission to list all the subscribed private leaderboards | Read | |||
| ListTagsForResource | Grants permission to lists tag for a resource | Read | |||
| ListTracks [permission only] | Grants permission to list all DeepRacer tracks | Read | |||
| ListTrainingJobs [permission only] | Grants permission to list a DeepRacer model's training jobs | Read | |||
| MigrateModels [permission only] | Grants permission to migrate previous reinforcement learning models for DeepRacer | Write | |||
| PerformLeaderboardOperation [permission only] | Grants permission to performs the leaderboard operation mentioned in the operation attribute | Write | |||
| RemoveLeaderboardAccessPermission [permission only] | Grants permission to remove access for a private leaderboard | Write | |||
| SetAlias [permission only] | Grants permission to set the user's alias for submitting a DeepRacer model to leaderboards | Write | |||
| StartEvaluation [permission only] | Grants permission to evaluate a DeepRacer model in a simulated environment | Write | |||
| StopEvaluation [permission only] | Grants permission to stop DeepRacer model evaluations | Write | |||
| StopTrainingReinforcementLearningModel [permission only] | Grants permission to stop training a DeepRacer model | Write | |||
| TagResource | Grants permission to tag a resource | Tagging | |||
| TestRewardFunction [permission only] | Grants permission to test reward functions for correctness | Write | |||
| UntagResource | Grants permission to untag a resource | Tagging | |||
| UpdateCar [permission only] | Grants permission to update a DeepRacer car in your garage | Write | |||
Resource types defined by AWS DeepRacer
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 Resource types table.
| Resource types | ARN | Condition keys |
|---|---|---|
| car |
arn:${Partition}:deepracer:${Region}:${Account}:car/${ResourceId}
|
|
| evaluation_job |
arn:${Partition}:deepracer:${Region}:${Account}: evaluation_job/${ResourceId}
|
|
| leaderboard |
arn:${Partition}:deepracer:${Region}::leaderboard/${ResourceId}
|
|
| leaderboard_evaluation_job |
arn:${Partition}:deepracer:${Region}:${Account}:leaderboard_evaluation_job/${ResourceId}
|
|
| reinforcement_learning_model |
arn:${Partition}:deepracer:${Region}:${Account}:model/reinforcement_learning/${ResourceId}
|
|
| track |
arn:${Partition}:deepracer:${Region}::track/${ResourceId}
|
|
| training_job |
arn:${Partition}:deepracer:${Region}:${Account}:training_job/${ResourceId}
|
Condition keys for AWS DeepRacer
AWS DeepRacer 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 actions by tag key-value pairs in the request | String |
| aws:ResourceTag/${TagKey} | Filters actions by tag key-value pairs attached to the resource | String |
| aws:TagKeys | Filters actions by tag keys in the request | ArrayOfString |
| deepracer:MultiUser | Filters access by multiuser flag | Bool |
| deepracer:UserToken | Filters access by user token in the request | String |
