Actions, resources, and condition keys for AWS Clean Rooms ML

AWS Clean Rooms ML (service prefix: cleanrooms-ml) 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 Clean Rooms ML
Resource types defined by AWS Clean Rooms ML
Condition keys for AWS Clean Rooms ML

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.

The Resource types column of the Actions table indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") to which the policy applies 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. If the action has one or more required resources, the caller must have permission to use the action with those resources. Required resources are indicated in the table with an asterisk (*). If you limit resource access with the Resource element in an IAM policy, you must include an ARN or pattern for each required resource type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one of the optional resource types.

The Condition keys column of the Actions table includes keys that you can specify in a policy statement's Condition element. For more information on the condition keys that are associated with resources for the service, see the Condition keys column of the Resource types table.

Note

Resource condition keys are listed in the Resource types table. You can find a link to the resource type that applies to an action in the Resource types (*required) column of the Actions table. The resource type in the Resource types table includes the Condition keys column, which are the resource condition keys that apply to an action in the Actions table.

For details about the columns in the following table, see Actions table.

Actions	Description	Access level	Resource types (*required)	Condition keys
CancelTrainedModel	Grants permission to cancel a trained model	Write	TrainedModel*
CancelTrainedModel	Grants permission to cancel a trained model	Write		aws:RequestTag/${TagKey} aws:TagKeys
CancelTrainedModelInferenceJob	Grants permission to cancel a trained model inference job	Write	TrainedModelInferenceJob*
CancelTrainedModelInferenceJob	Grants permission to cancel a trained model inference job	Write		aws:RequestTag/${TagKey} aws:TagKeys
CreateAudienceModel	Grants permission to create an audience model	Write	trainingdataset*
CreateAudienceModel	Grants permission to create an audience model	Write		aws:RequestTag/${TagKey} aws:TagKeys
CreateConfiguredAudienceModel	Grants permission to create a configured audience model	Write	audiencemodel*
CreateConfiguredAudienceModel	Grants permission to create a configured audience model	Write		aws:RequestTag/${TagKey} aws:TagKeys
CreateConfiguredModelAlgorithm	Grants permission to create a configured model algorithm	Write		aws:RequestTag/${TagKey} aws:TagKeys
CreateConfiguredModelAlgorithmAssociation	Grants permission to create a configured model algorithm association	Write	ConfiguredModelAlgorithm*
CreateConfiguredModelAlgorithmAssociation		Write		aws:RequestTag/${TagKey} aws:TagKeys
CreateMLInputChannel	Grants permission to create an ML input channel	Write	ConfiguredModelAlgorithmAssociation*
CreateMLInputChannel	Grants permission to create an ML input channel	Write		aws:RequestTag/${TagKey} aws:TagKeys
CreateTrainedModel	Grants permission to create a trained model	Write	ConfiguredModelAlgorithmAssociation*
CreateTrainedModel	Grants permission to create a trained model	Write		aws:RequestTag/${TagKey} aws:TagKeys
CreateTrainingDataset	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		aws:RequestTag/${TagKey} aws:TagKeys
DeleteAudienceGenerationJob	Grants permission to delete the specified audience generation job, and removes all data associated with the job	Write	audiencegenerationjob*
DeleteAudienceGenerationJob		Write		aws:RequestTag/${TagKey} aws:TagKeys
DeleteAudienceModel	Grants permission to delete the specified audience generation job, and removes all data associated with the job	Write	audiencemodel*
DeleteAudienceModel		Write		aws:RequestTag/${TagKey} aws:TagKeys
DeleteConfiguredAudienceModel	Grants permission to delete the specified configured audience model	Write	configuredaudiencemodel*
DeleteConfiguredAudienceModel		Write		aws:RequestTag/${TagKey} aws:TagKeys
DeleteConfiguredAudienceModelPolicy	Grants permission to delete the specified configured audience model policy	Write	configuredaudiencemodel*
DeleteConfiguredAudienceModelPolicy		Write		aws:RequestTag/${TagKey} aws:TagKeys
DeleteConfiguredModelAlgorithm	Grants permission to delete a configured model algorithm	Write	ConfiguredModelAlgorithm*
DeleteConfiguredModelAlgorithm	Grants permission to delete a configured model algorithm	Write		aws:RequestTag/${TagKey} aws:TagKeys
DeleteConfiguredModelAlgorithmAssociation	Grants permission to delete a configured model algorithm association	Write	ConfiguredModelAlgorithmAssociation*
DeleteConfiguredModelAlgorithmAssociation		Write		aws:RequestTag/${TagKey} aws:TagKeys
DeleteMLConfiguration	Grants permission to delete an ML configuration	Write		aws:RequestTag/${TagKey} aws:TagKeys
DeleteMLInputChannelData	Grants permission to delete all data associated with the ML input channel	Write	MLInputChannel*
DeleteMLInputChannelData		Write		aws:RequestTag/${TagKey} aws:TagKeys
DeleteTrainedModelOutput	Grants permission to delete all output associated with the trained model	Write	TrainedModel*
DeleteTrainedModelOutput		Write		aws:RequestTag/${TagKey} aws:TagKeys
DeleteTrainingDataset	Grants permission to delete a training dataset	Write	trainingdataset*
DeleteTrainingDataset	Grants permission to delete a training dataset	Write		aws:RequestTag/${TagKey} aws:TagKeys
GetAudienceGenerationJob	Grants permission to return information about an audience generation job	Read	audiencegenerationjob*
GetAudienceGenerationJob		Read		aws:RequestTag/${TagKey} aws:TagKeys
GetAudienceModel	Grants permission to return information about an audience model	Read	audiencemodel*
GetAudienceModel		Read		aws:RequestTag/${TagKey} aws:TagKeys
GetCollaborationConfiguredModelAlgorithmAssociation	Grants permission to return information about a configured model algorithm association created by any member in the collaboration	Read	ConfiguredModelAlgorithmAssociation*
GetCollaborationConfiguredModelAlgorithmAssociation		Read		aws:RequestTag/${TagKey} aws:TagKeys cleanrooms-ml:CollaborationId
GetCollaborationMLInputChannel	Grants permission to return information about an ML input channel created by any member in the collaboration	Read	MLInputChannel*
GetCollaborationMLInputChannel		Read		aws:RequestTag/${TagKey} aws:TagKeys cleanrooms-ml:CollaborationId
GetCollaborationTrainedModel	Grants permission to return information about a trained model created by any member in the collaboration	Read	TrainedModel*
GetCollaborationTrainedModel		Read		aws:RequestTag/${TagKey} aws:TagKeys cleanrooms-ml:CollaborationId
GetConfiguredAudienceModel	Grants permission to return information about a configured audience model	Read	configuredaudiencemodel*
GetConfiguredAudienceModel		Read		aws:RequestTag/${TagKey} aws:TagKeys
GetConfiguredAudienceModelPolicy	Grants permission to return information about a configured audience model policy	Read	configuredaudiencemodel*
GetConfiguredAudienceModelPolicy		Read		aws:RequestTag/${TagKey} aws:TagKeys
GetConfiguredModelAlgorithm	Grants permission to return information about a configured model algorithm	Read	ConfiguredModelAlgorithm*
GetConfiguredModelAlgorithm		Read		aws:RequestTag/${TagKey} aws:TagKeys
GetConfiguredModelAlgorithmAssociation	Grants permission to return information about a configured model algorithm association	Read	ConfiguredModelAlgorithmAssociation*
GetConfiguredModelAlgorithmAssociation		Read		aws:RequestTag/${TagKey} aws:TagKeys
GetMLConfiguration	Grants permission to return information about an ML configuration	Read		aws:RequestTag/${TagKey} aws:TagKeys
GetMLInputChannel	Grants permission to return information about an ML input channel	Read	MLInputChannel*
GetMLInputChannel		Read		aws:RequestTag/${TagKey} aws:TagKeys
GetTrainedModel	Grants permission to return information about a trained model	Read	TrainedModel*
GetTrainedModel		Read		aws:RequestTag/${TagKey} aws:TagKeys
GetTrainedModelInferenceJob	Grants permission to return information about a trained model inference job	Read	TrainedModelInferenceJob*
GetTrainedModelInferenceJob		Read		aws:RequestTag/${TagKey} aws:TagKeys
GetTrainingDataset	Grants permission to return information about a training dataset	Read	trainingdataset*
GetTrainingDataset		Read		aws:RequestTag/${TagKey} aws:TagKeys
ListAudienceExportJobs	Grants permission to return a list of the audience export jobs	List	audiencegenerationjob
ListAudienceExportJobs		List		aws:RequestTag/${TagKey} aws:TagKeys
ListAudienceGenerationJobs	Grants permission to return a list of audience generation jobs	List	configuredaudiencemodel
ListAudienceGenerationJobs		List		aws:RequestTag/${TagKey} aws:TagKeys
ListAudienceModels	Grants permission to return a list of audience models	List
ListCollaborationConfiguredModelAlgorithmAssociations	Grants permission to return a list of configured model algorithms created by any member in the collaboration	List		aws:RequestTag/${TagKey} aws:TagKeys cleanrooms-ml:CollaborationId
ListCollaborationMLInputChannels	Grants permission to return a list of ML input channels created by any member in the collaboration	List		aws:RequestTag/${TagKey} aws:TagKeys cleanrooms-ml:CollaborationId
ListCollaborationTrainedModelExportJobs	Grants permission to return a list of trained model export jobs started by any member in the collaboration	List	TrainedModel*
ListCollaborationTrainedModelExportJobs		List		aws:RequestTag/${TagKey} aws:TagKeys cleanrooms-ml:CollaborationId
ListCollaborationTrainedModelInferenceJobs	Grants permission to return a list of trained model inference jobs started by any member in the collaboration	List		aws:RequestTag/${TagKey} aws:TagKeys cleanrooms-ml:CollaborationId
ListCollaborationTrainedModels	Grants permission to return a list of trained models created by any member in the collaboration	List		aws:RequestTag/${TagKey} aws:TagKeys cleanrooms-ml:CollaborationId
ListConfiguredAudienceModels	Grants permission to return a list of configured audience models	List
ListConfiguredModelAlgorithmAssociations	Grants permission to return a list of configured model algorithm associations	List		aws:RequestTag/${TagKey} aws:TagKeys
ListConfiguredModelAlgorithms	Grants permission to return a list of configured model algorithms	List		aws:RequestTag/${TagKey} aws:TagKeys
ListMLInputChannels	Grants permission to return a list of ML input channels	List		aws:RequestTag/${TagKey} aws:TagKeys
ListTagsForResource	Grants permission to return a list of tags for a provided resource	List	audiencegenerationjob
			audiencemodel
			configuredaudiencemodel
			trainingdataset
				aws:TagKeys aws:ResourceTag/${TagKey}
ListTrainedModelInferenceJobs	Grants permission to return a list of trained model inference jobs	List		aws:RequestTag/${TagKey} aws:TagKeys
ListTrainedModels	Grants permission to return a list of trained models	List		aws:RequestTag/${TagKey} aws:TagKeys
ListTrainingDatasets	Grants permission to return a list of training datasets	List
PutConfiguredAudienceModelPolicy	Grants permission to create or update the resource policy for a configured audience model	Permissions management	configuredaudiencemodel*
PutMLConfiguration	Grants permission to put an ML configuration	Write		aws:RequestTag/${TagKey} aws:TagKeys
StartAudienceExportJob	Grants permission to export an audience of a specified size after you have generated an audience	Write	audiencegenerationjob*
StartAudienceExportJob		Write		aws:RequestTag/${TagKey} aws:TagKeys
StartAudienceGenerationJob	Grants permission to start the audience generation job	Write	configuredaudiencemodel*
StartAudienceGenerationJob	Grants permission to start the audience generation job	Write		aws:RequestTag/${TagKey} aws:TagKeys cleanrooms-ml:CollaborationId
StartTrainedModelExportJob	Grants permission to start a trained model export job	Write	TrainedModel*
StartTrainedModelExportJob	Grants permission to start a trained model export job	Write		aws:RequestTag/${TagKey} aws:TagKeys
StartTrainedModelInferenceJob	Grants permission to start a trained model inference job	Write	ConfiguredModelAlgorithmAssociation*
			MLInputChannel*
			TrainedModel*
				aws:RequestTag/${TagKey} aws:TagKeys
TagResource	Grants permission to tag a specific resource	Tagging	ConfiguredModelAlgorithm
			ConfiguredModelAlgorithmAssociation
			MLInputChannel
			TrainedModel
			TrainedModelInferenceJob
			audiencegenerationjob
			audiencemodel
			configuredaudiencemodel
			trainingdataset
				aws:TagKeys aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey}
UnTagResource	Grants permission to untag a specific resource	Tagging	ConfiguredModelAlgorithm
			ConfiguredModelAlgorithmAssociation
			MLInputChannel
			TrainedModel
			TrainedModelInferenceJob
			audiencegenerationjob
			audiencemodel
			configuredaudiencemodel
			trainingdataset
				aws:TagKeys aws:ResourceTag/${TagKey}
UpdateConfiguredAudienceModel	Grants permission to update a configured audience model.	Write	configuredaudiencemodel*
			audiencemodel
				aws:RequestTag/${TagKey} aws:TagKeys

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

Resource types	ARN	Condition keys
trainingdataset	`arn:${Partition}:cleanrooms-ml:${Region}:${Account}:training-dataset/${ResourceId}`	aws:ResourceTag/${TagKey}
audiencemodel	`arn:${Partition}:cleanrooms-ml:${Region}:${Account}:audience-model/${ResourceId}`	aws:ResourceTag/${TagKey}
configuredaudiencemodel	`arn:${Partition}:cleanrooms-ml:${Region}:${Account}:configured-audience-model/${ResourceId}`	aws:ResourceTag/${TagKey}
audiencegenerationjob	`arn:${Partition}:cleanrooms-ml:${Region}:${Account}:audience-generation-job/${ResourceId}`	aws:ResourceTag/${TagKey}
ConfiguredModelAlgorithm	`arn:${Partition}:cleanrooms-ml:${Region}:${Account}:configured-model-algorithm/${ResourceId}`	aws:ResourceTag/${TagKey}
ConfiguredModelAlgorithmAssociation	`arn:${Partition}:cleanrooms-ml:${Region}:${Account}:membership/${MembershipId}/configured-model-algorithm-association/${ResourceId}`	aws:ResourceTag/${TagKey}
MLInputChannel	`arn:${Partition}:cleanrooms-ml:${Region}:${Account}:membership/${MembershipId}/ml-input-channel/${ResourceId}`	aws:ResourceTag/${TagKey}
TrainedModel	`arn:${Partition}:cleanrooms-ml:${Region}:${Account}:membership/${MembershipId}/trained-model/${ResourceId}`	aws:ResourceTag/${TagKey}
TrainedModelInferenceJob	`arn:${Partition}:cleanrooms-ml:${Region}:${Account}:membership/${MembershipId}/trained-model-inference-job/${ResourceId}`	aws:ResourceTag/${TagKey}

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. 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 access by the presence of tag key-value pairs in the request	String
aws:ResourceTag/${TagKey}	Filters access by tag key-value pairs attached to the resource	String
aws:TagKeys	Filters access by the presence of tag keys in the request	ArrayOfString
cleanrooms-ml:CollaborationId	Filters access by Clean rooms collaboration id	String

Warning Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

AWS Clean Rooms

AWS Cloud Control API