Actions, resources, and condition keys for AWS Clean Rooms
AWS Clean Rooms (service prefix: cleanrooms) 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
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 |
|---|---|---|---|---|
|
BatchGetCollaborationAnalysisTemplate |
Read |
|||
|
BatchGetSchema |
Read |
|||
|
BatchGetSchemaAnalysisRule |
Read |
|||
|
CreateAnalysisTemplate |
Write |
|||
Tagging, Write |
||||
iam:PassedToService |
cleanrooms.amazonaws.com |
Write |
||
|
CreateCollaboration |
Write |
|||
Tagging, Write |
||||
|
CreateCollaborationChangeRequest |
Write |
|||
|
CreateConfiguredAudienceModelAssociation |
Write |
|||
Tagging, Write |
||||
|
CreateConfiguredTable |
Write |
|||
Tagging, Write |
||||
|
CreateConfiguredTableAnalysisRule |
Write |
|||
|
CreateConfiguredTableAssociation |
Write |
|||
Tagging, Write |
||||
iam:PassedToService |
cleanrooms.amazonaws.com |
Write |
||
|
CreateConfiguredTableAssociationAnalysisRule |
Write |
|||
|
CreateIdMappingTable |
Write |
|||
Tagging, Write |
||||
|
CreateIdNamespaceAssociation |
Write |
|||
Tagging, Write |
||||
|
CreateIntermediateTable |
Write |
|||
Tagging, Write |
||||
|
CreateIntermediateTableAnalysisRule |
Write |
|||
|
CreateMembership |
Write |
|||
Tagging, Write |
||||
iam:PassedToService |
cleanrooms.amazonaws.com |
Write |
||
|
CreatePrivacyBudgetTemplate |
Write |
|||
Tagging, Write |
||||
|
DeleteAnalysisTemplate |
Write |
|||
|
DeleteCollaboration |
Write |
|||
|
DeleteConfiguredAudienceModelAssociation |
Write |
|||
|
DeleteConfiguredTable |
Write |
|||
|
DeleteConfiguredTableAnalysisRule |
Write |
|||
|
DeleteConfiguredTableAssociation |
Write |
|||
|
DeleteConfiguredTableAssociationAnalysisRule |
Write |
|||
|
DeleteIdMappingTable |
Write |
|||
|
DeleteIdNamespaceAssociation |
Write |
|||
|
DeleteIntermediateTable |
Write |
|||
|
DeleteMember |
Write |
|||
|
DeleteMembership |
Write |
|||
|
DeletePrivacyBudgetTemplate |
Write |
|||
|
GetAnalysisTemplate |
Read |
|||
|
GetCollaboration |
Read |
|||
|
GetCollaborationAnalysisTemplate |
Read |
|||
|
GetCollaborationChangeRequest |
Read |
|||
|
GetCollaborationConfiguredAudienceModelAssociation |
cleanrooms:GetCollaborationConfiguredAudienceModelAssociation |
Read |
||
|
GetCollaborationIdNamespaceAssociation |
Read |
|||
|
GetCollaborationPrivacyBudgetTemplate |
Read |
|||
|
GetConfiguredAudienceModelAssociation |
Read |
|||
|
GetConfiguredTable |
Read |
|||
|
GetConfiguredTableAnalysisRule |
Read |
|||
|
GetConfiguredTableAssociation |
Read |
|||
|
GetConfiguredTableAssociationAnalysisRule |
Read |
|||
|
GetIdMappingTable |
Read |
|||
|
GetIdNamespaceAssociation |
Read |
|||
|
GetIntermediateTable |
Read |
|||
|
GetIntermediateTableAnalysisRule |
Read |
|||
|
GetMembership |
Read |
|||
|
GetPrivacyBudgetTemplate |
Read |
|||
|
GetProtectedJob |
Read |
|||
|
GetProtectedQuery |
Read |
|||
|
GetSchema |
Read |
|||
|
GetSchemaAnalysisRule |
Read |
|||
|
ListAnalysisTemplates |
List |
|||
|
ListCollaborationAnalysisTemplates |
List |
|||
|
ListCollaborationChangeRequests |
List |
|||
|
ListCollaborationConfiguredAudienceModelAssociations |
cleanrooms:ListCollaborationConfiguredAudienceModelAssociations |
List |
||
|
ListCollaborationIdNamespaceAssociations |
List |
|||
|
ListCollaborationPrivacyBudgetTemplates |
List |
|||
|
ListCollaborationPrivacyBudgets |
List |
|||
|
ListCollaborations |
List |
|||
|
ListConfiguredAudienceModelAssociations |
List |
|||
|
ListConfiguredTableAssociations |
List |
|||
|
ListConfiguredTables |
List |
|||
|
ListIdMappingTables |
List |
|||
|
ListIdNamespaceAssociations |
List |
|||
|
ListIntermediateTableVersions |
List |
|||
|
ListIntermediateTables |
List |
|||
|
ListMembers |
List |
|||
|
ListMemberships |
List |
|||
|
ListPrivacyBudgetTemplates |
List |
|||
|
ListPrivacyBudgets |
List |
|||
|
ListProtectedJobs |
List |
|||
|
ListProtectedQueries |
List |
|||
|
ListSchemas |
List |
|||
|
ListTagsForResource |
List |
|||
|
PopulateIdMappingTable |
Write |
|||
|
PopulateIntermediateTable |
Write |
|||
|
PreviewPrivacyImpact |
Read |
|||
|
StartProtectedJob |
Write |
|||
|
StartProtectedQuery |
Write |
|||
|
TagResource |
Tagging, Write |
|||
|
UntagResource |
Tagging, Write |
|||
|
UpdateAnalysisTemplate |
Write |
|||
|
UpdateCollaboration |
Write |
|||
|
UpdateCollaborationChangeRequest |
Write |
|||
|
UpdateConfiguredAudienceModelAssociation |
Write |
|||
|
UpdateConfiguredTable |
Write |
|||
Write |
||||
Write |
||||
|
UpdateConfiguredTableAnalysisRule |
Write |
|||
|
UpdateConfiguredTableAssociation |
Write |
|||
iam:PassedToService |
cleanrooms.amazonaws.com |
Write |
||
|
UpdateConfiguredTableAssociationAnalysisRule |
Write |
|||
|
UpdateIdMappingTable |
Write |
|||
|
UpdateIdNamespaceAssociation |
Write |
|||
|
UpdateIntermediateTable |
Write |
|||
|
UpdateMembership |
Write |
|||
iam:PassedToService |
cleanrooms.amazonaws.com |
Write |
||
|
UpdatePrivacyBudgetTemplate |
Write |
|||
|
UpdateProtectedJob |
Write |
|||
|
UpdateProtectedQuery |
Write |
Actions defined by AWS Clean Rooms
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 view details of analysisTemplates associated to the collaboration |
Read |
|||
Grants permission to view details for schemas |
Read |
|||
Grants permission to view analysis rules associated with schemas |
Read |
|||
Grants permission to create a new analysis template |
Write |
|||
Grants permission to create a new collaboration, a shared data collaboration environment |
Write |
|||
Grants permission to create a change request in a collaboration |
Write |
|||
Grants permission to link a Cleanrooms ML configured audience model with a collaboration by creating a new association |
Write |
|||
Grants permission to create a new configured table |
Write |
|||
Grants permission to create a analysis rule for a configured table |
Write |
|||
Grants permission to link a configured table with a collaboration by creating a new association |
Write |
|||
Grants permission to create an analysis rule for a configured table association |
Write |
|||
Grants permission to link an id mapping workflow with a collaboration by creating a new id mapping table |
Write |
|||
Grants permission to link an AWS Entity Resolution Id Namespace with a collaboration by creating a new association |
Write |
|||
Grants permission to create a new intermediate table in a membership |
Write |
|||
Grants permission to create an analysis rule for an intermediate table |
Write |
|||
Grants permission to join collaborations by creating a membership |
Write |
|||
Grants permission to create a new privacy budget template |
Write |
|||
Grants permission to delete an existing analysis template |
Write |
|||
Grants permission to delete an existing collaboration |
Write |
|||
Grants permission to delete an existing configured audience model association |
Write |
|||
Grants permission to delete a configured table |
Write |
|||
Grants permission to delete an existing analysis rule |
Write |
|||
Grants permission to remove a configured table association from a collaboration |
Write |
|||
Grants permission to delete an existing configured table association analysis rule |
Write |
|||
Grants permission to remove an id mapping table from a collaboration |
Write |
|||
Grants permission to remove an Id Namespace Association from a collaboration |
Write |
|||
Grants permission to remove an intermediate table from a collaboration |
Write |
|||
Grants permission to delete an existing analysis rule for an intermediate table |
Write |
|||
Grants permission to delete members from a collaboration |
Write |
|||
Grants permission to leave collaborations by deleting a membership |
Write |
|||
Grants permission to delete an existing privacy budget template |
Write |
|||
Grants permission to invalidate an intermediate table |
Write |
|||
Grants permission to view details for an analysis template |
Read |
|||
Grants permission to view details for a collaboration |
Read |
|||
Grants permission to view details for an analysis template within a collaboration |
Read |
|||
Grants permission to get a change request in a collaboration |
Read |
|||
Grants permission to view details for a configured audience model association within a collaboration |
Read |
|||
Grants permission to get id namespace association within a collaboration |
Read |
|||
Grants permission to view details for a privacy budget template within a collaboration |
Read |
|||
Grants permission to view details for a configured audience model association |
Read |
|||
Grants permission to view details for a configured table |
Read |
|||
Grants permission to view analysis rules for a configured table |
Read |
|||
Grants permission to view details for a configured table association |
Read |
|||
Grants permission to view analysis rules for a configured table association |
Read |
|||
Grants permission to view details of an id mapping table |
Read |
|||
Grants permission to view details of an id namespace association |
Read |
|||
Grants permission to view details of an intermediate table |
Read |
|||
Grants permission to view analysis rules for an intermediate table |
Read |
|||
Grants permission to view details about a membership |
Read |
|||
Grants permission to view details for a privacy budget template |
Read |
|||
Grants permission to view a protected job |
Read |
|||
Grants permission to view a protected query |
Read |
|||
Grants permission to view details for a schema |
Read |
|||
Grants permission to view analysis rules associated with a schema |
Read |
|||
Grants permission to list available analysis templates |
List |
|||
Grants permission to list available analysis templates within a collaboration |
List |
|||
Grants permission to list change requests in a collaboration |
List |
|||
Grants permission to list available configured audience model association within a collaboration |
List |
|||
Grants permission to list id namespace within a collaboration |
List |
|||
Grants permission to list available privacy budget templates within a collaboration |
List |
|||
Grants permission to list privacy budgets within a collaboration |
List |
|||
Grants permission to list available collaborations |
List |
|||
Grants permission to list available configured audience model associations for a membership |
List |
|||
Grants permission to list available configured table associations for a membership |
List |
|||
Grants permission to list available configured tables |
List |
|||
Grants permission to list available id mapping tables for a membership |
List |
|||
Grants permission to list entity resolution data associations for a membership |
List |
|||
Grants permission to list versions of an intermediate table |
List |
|||
Grants permission to list intermediate tables for a membership |
List |
|||
Grants permission to list the members of a collaboration |
List |
|||
Grants permission to list available memberships |
List |
|||
Grants permission to list available privacy budget templates |
List |
|||
Grants permission to list available privacy budgets |
List |
|||
Grants permission to list protected jobs |
List |
|||
Grants permission to list protected queries |
List |
|||
Grants permission to view available schemas for a collaboration |
List |
|||
Grants permission to list tags for a resource |
List |
|||
Grants permission to start an Id Mapping Job in AWS Entity Resolution to generate id mapping results in cleanrooms collaboration. |
Write |
|||
Grants permission to populate an intermediate table by executing its stored analysis |
Write |
|||
Grants permission to preview privacy budget template settings |
Read |
|||
Grants permission to start protected jobs |
Write |
|||
Grants permission to start protected queries |
Write |
|||
Grants permission to tag a resource |
Tagging, Write |
|||
Grants permission to untag a resource |
Tagging, Write |
|||
Grants permission to update details of the analysis template |
Write |
|||
Grants permission to update details of the collaboration |
Write |
|||
Grants permission to update a change request in a collaboration |
Write |
|||
Grants permission to update a configured audience model association |
Write |
|||
Grants permission to update an existing configured table |
Write |
|||
Grants permission to update analysis rules for a configured table |
Write |
|||
Grants permission to update a configured table association |
Write |
|||
Grants permission to update analysis rules for a configured table association |
Write |
|||
Grants permission to update an id mapping table |
Write |
|||
Grants permission to update a entity resolution input association |
Write |
|||
Grants permission to update an intermediate table |
Write |
|||
Grants permission to update an analysis rule for an intermediate table |
Write |
|||
Grants permission to update details of a membership |
Write |
|||
Grants permission to update details of the privacy budget template |
Write |
|||
Grants permission to update protected jobs |
Write |
|||
Grants permission to update protected queries |
Write |
Permission-only actions for AWS Clean Rooms
The following actions are defined by AWS Clean Rooms but are not directly invocable through any API operation. They can only be used in IAM policy statements to grant or deny permissions.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to access a collaboration in the context of Clean Rooms ML custom models |
Read |
|||
Grants permission to access a membership in the context of Clean Rooms ML custom models |
Read |
|||
Grants permission to update the allowed columns of an existing configured table |
Write |
|||
Grants permission to update the table reference of an existing configured table |
Write |
Resource types defined by AWS Clean Rooms
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:${Region}:${Account}:membership/${MembershipId}/analysistemplate/${AnalysisTemplateId} |
||
arn:${Partition}:cleanrooms:${Region}:${Account}:collaboration/${CollaborationId} |
||
arn:${Partition}:cleanrooms:${Region}:${Account}:membership/${MembershipId}/configuredaudiencemodelassociation/${ConfiguredAudienceModelAssociationId} |
||
arn:${Partition}:cleanrooms:${Region}:${Account}:configuredtable/${ConfiguredTableId} |
||
arn:${Partition}:cleanrooms:${Region}:${Account}:membership/${MembershipId}/configuredtableassociation/${ConfiguredTableAssociationId} |
||
arn:${Partition}:cleanrooms:${Region}:${Account}:membership/${MembershipId}/idmappingtable/${IdMappingTableId} |
||
arn:${Partition}:cleanrooms:${Region}:${Account}:membership/${MembershipId}/idnamespaceassociation/${IdNamespaceAssociationId} |
||
arn:${Partition}:cleanrooms:${Region}:${Account}:membership/${MembershipId}/intermediatetable/${IntermediateTableId} |
||
arn:${Partition}:cleanrooms:${Region}:${Account}:membership/${MembershipId} |
||
arn:${Partition}:cleanrooms:${Region}:${Account}:membership/${MembershipId}/privacybudgettemplate/${PrivacyBudgetTemplateId} |
Condition keys for AWS Clean Rooms
AWS Clean Rooms 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 tags that are passed in the request |
String |
|
Filters access by the tags associated with the resource |
String |
|
Filters access by the tag keys that are passed in the request |
ArrayOfString |