Actions, resources, and condition keys for AWS Clean Rooms ML
AWS Clean Rooms ML (service prefix: cleanrooms-ml) 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 Clean Rooms ML
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 |
|---|---|---|---|---|
|
CancelTrainedModel |
Write |
|||
|
CancelTrainedModelInferenceJob |
Write |
|||
|
CreateAudienceModel |
Write |
|||
Tagging, Write |
||||
|
CreateConfiguredAudienceModel |
Write |
|||
Tagging, Write |
||||
iam:PassedToService |
cleanrooms-ml.amazonaws.com |
Write |
||
|
CreateConfiguredModelAlgorithm |
Write |
|||
Tagging, Write |
||||
iam:PassedToService |
cleanrooms-ml.amazonaws.com |
Write |
||
|
CreateConfiguredModelAlgorithmAssociation |
Write |
|||
Tagging, Write |
||||
|
CreateMLInputChannel |
Write |
|||
Tagging, Write |
||||
iam:PassedToService |
cleanrooms-ml.amazonaws.com |
Write |
||
|
CreateTrainedModel |
Write |
|||
Tagging, Write |
||||
|
CreateTrainingDataset |
Write |
|||
Tagging, Write |
||||
iam:PassedToService |
cleanrooms-ml.amazonaws.com |
Write |
||
|
DeleteAudienceGenerationJob |
Write |
|||
|
DeleteAudienceModel |
Write |
|||
|
DeleteConfiguredAudienceModel |
Write |
|||
|
DeleteConfiguredAudienceModelPolicy |
Write |
|||
|
DeleteConfiguredModelAlgorithm |
Write |
|||
|
DeleteConfiguredModelAlgorithmAssociation |
Write |
|||
|
DeleteMLConfiguration |
Write |
|||
|
DeleteMLInputChannelData |
Write |
|||
|
DeleteTrainedModelOutput |
Write |
|||
|
DeleteTrainingDataset |
Write |
|||
|
GetAudienceGenerationJob |
Read |
|||
|
GetAudienceModel |
Read |
|||
|
GetCollaborationConfiguredModelAlgorithmAssociation |
cleanrooms-ml:GetCollaborationConfiguredModelAlgorithmAssociation |
Read |
||
|
GetCollaborationMLInputChannel |
Read |
|||
|
GetCollaborationTrainedModel |
Read |
|||
|
GetConfiguredAudienceModel |
Read |
|||
|
GetConfiguredAudienceModelPolicy |
Read |
|||
|
GetConfiguredModelAlgorithm |
Read |
|||
|
GetConfiguredModelAlgorithmAssociation |
Read |
|||
|
GetMLConfiguration |
Read |
|||
|
GetMLInputChannel |
Read |
|||
|
GetTrainedModel |
Read |
|||
|
GetTrainedModelInferenceJob |
Read |
|||
|
GetTrainingDataset |
Read |
|||
|
ListAudienceExportJobs |
List |
|||
|
ListAudienceGenerationJobs |
List |
|||
|
ListAudienceModels |
List |
|||
|
ListCollaborationConfiguredModelAlgorithmAssociations |
cleanrooms-ml:ListCollaborationConfiguredModelAlgorithmAssociations |
List |
||
|
ListCollaborationMLInputChannels |
List |
|||
|
ListCollaborationTrainedModelExportJobs |
List |
|||
|
ListCollaborationTrainedModelInferenceJobs |
List |
|||
|
ListCollaborationTrainedModels |
List |
|||
|
ListConfiguredAudienceModels |
List |
|||
|
ListConfiguredModelAlgorithmAssociations |
List |
|||
|
ListConfiguredModelAlgorithms |
List |
|||
|
ListMLInputChannels |
List |
|||
|
ListTagsForResource |
List |
|||
|
ListTrainedModelInferenceJobs |
List |
|||
|
ListTrainedModelVersions |
List |
|||
|
ListTrainedModels |
List |
|||
|
ListTrainingDatasets |
List |
|||
|
PutConfiguredAudienceModelPolicy |
Permissions management, Write |
|||
|
PutMLConfiguration |
Write |
|||
iam:PassedToService |
cleanrooms-ml.amazonaws.com |
Write |
||
|
StartAudienceExportJob |
Write |
|||
|
StartAudienceGenerationJob |
Write |
|||
Tagging, Write |
||||
iam:PassedToService |
cleanrooms-ml.amazonaws.com |
Write |
||
|
StartTrainedModelExportJob |
Write |
|||
|
StartTrainedModelInferenceJob |
Write |
|||
Tagging, Write |
||||
|
TagResource |
Tagging, Write |
|||
|
UntagResource |
Tagging, Write |
|||
|
UpdateConfiguredAudienceModel |
Write |
|||
iam:PassedToService |
cleanrooms-ml.amazonaws.com |
Write |
Actions defined by AWS Clean Rooms ML
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 cancel a trained model |
Write |
|||
Grants permission to cancel a trained model inference job |
Write |
|||
Grants permission to create an audience model |
Write |
|||
Grants permission to create a configured audience model |
Write |
|||
Grants permission to create a configured model algorithm |
Write |
|||
Grants permission to create a configured model algorithm association |
Write |
|||
Grants permission to create an ML input channel |
Write |
|||
Grants permission to create a trained model |
Write |
|||
Grants permission to create a training dataset, or seed audience. In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation |
Write |
|||
Grants permission to delete the specified audience generation job, and removes all data associated with the job |
Write |
|||
Grants permission to delete the specified audience generation job, and removes all data associated with the job |
Write |
|||
Grants permission to delete the specified configured audience model |
Write |
|||
Grants permission to delete the specified configured audience model policy |
Write |
|||
Grants permission to delete a configured model algorithm |
Write |
|||
Grants permission to delete a configured model algorithm association |
Write |
|||
Grants permission to delete an ML configuration |
Write |
|||
Grants permission to delete all data associated with the ML input channel |
Write |
|||
Grants permission to delete all output associated with the trained model |
Write |
|||
Grants permission to delete a training dataset |
Write |
|||
Grants permission to return information about an audience generation job |
Read |
|||
Grants permission to return information about an audience model |
Read |
|||
Grants permission to return information about a configured model algorithm association created by any member in the collaboration |
Read |
|||
Grants permission to return information about an ML input channel created by any member in the collaboration |
Read |
|||
Grants permission to return information about a trained model created by any member in the collaboration |
Read |
|||
Grants permission to return information about a configured audience model |
Read |
|||
Grants permission to return information about a configured audience model policy |
Read |
|||
Grants permission to return information about a configured model algorithm |
Read |
|||
Grants permission to return information about a configured model algorithm association |
Read |
|||
Grants permission to return information about an ML configuration |
Read |
|||
Grants permission to return information about an ML input channel |
Read |
|||
Grants permission to return information about a trained model |
Read |
|||
Grants permission to return information about a trained model inference job |
Read |
|||
Grants permission to return information about a training dataset |
Read |
|||
Grants permission to return a list of the audience export jobs |
List |
|||
Grants permission to return a list of audience generation jobs |
List |
|||
Grants permission to return a list of audience models |
List |
|||
Grants permission to return a list of configured model algorithms created by any member in the collaboration |
List |
|||
Grants permission to return a list of ML input channels created by any member in the collaboration |
List |
|||
Grants permission to return a list of trained model export jobs started by any member in the collaboration |
List |
|||
Grants permission to return a list of trained model inference jobs started by any member in the collaboration |
List |
|||
Grants permission to return a list of trained models created by any member in the collaboration |
List |
|||
Grants permission to return a list of configured audience models |
List |
|||
Grants permission to return a list of configured model algorithm associations |
List |
|||
Grants permission to return a list of configured model algorithms |
List |
|||
Grants permission to return a list of ML input channels |
List |
|||
Grants permission to return a list of tags for a provided resource |
List |
|||
Grants permission to return a list of trained model inference jobs |
List |
|||
Grants permission to return a list of trained model versions |
List |
|||
Grants permission to return a list of trained models |
List |
|||
Grants permission to return a list of training datasets |
List |
|||
Grants permission to create or update the resource policy for a configured audience model |
Permissions management, Write |
|||
Grants permission to put an ML configuration |
Write |
|||
Grants permission to export an audience of a specified size after you have generated an audience |
Write |
|||
Grants permission to start the audience generation job |
Write |
|||
Grants permission to start a trained model export job |
Write |
|||
Grants permission to start a trained model inference job |
Write |
|||
Grants permission to tag a specific resource |
Tagging, Write |
|||
Grants permission to untag a specific resource |
Tagging, Write |
|||
Grants permission to update a configured audience model. |
Write |
|||
Resource types defined by AWS Clean Rooms ML
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}:cleanrooms-ml:${Region}:${Account}:configured-model-algorithm/${ResourceId} |
||
arn:${Partition}:cleanrooms-ml:${Region}:${Account}:membership/${MembershipId}/configured-model-algorithm-association/${ResourceId} |
||
arn:${Partition}:cleanrooms-ml:${Region}:${Account}:membership/${MembershipId}/ml-input-channel/${ResourceId} |
||
arn:${Partition}:cleanrooms-ml:${Region}:${Account}:membership/${MembershipId}/trained-model/${ResourceId} |
||
arn:${Partition}:cleanrooms-ml:${Region}:${Account}:membership/${MembershipId}/trained-model-inference-job/${ResourceId} |
||
arn:${Partition}:cleanrooms-ml:${Region}:${Account}:audience-generation-job/${ResourceId} |
||
arn:${Partition}:cleanrooms-ml:${Region}:${Account}:audience-model/${ResourceId} |
||
arn:${Partition}:cleanrooms-ml:${Region}:${Account}:configured-audience-model/${ResourceId} |
||
arn:${Partition}:cleanrooms-ml:${Region}:${Account}:training-dataset/${ResourceId} |
Condition keys for AWS Clean Rooms ML
AWS Clean Rooms ML 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 presence of tag key-value pairs in the request |
String |
|
Filters access by tag key-value pairs attached to the resource |
String |
|
Filters access by the presence of tag keys in the request |
ArrayOfString |
|
Filters access by Clean rooms collaboration id |
String |