Cleanrooms

This page documents function available when using the Cleanrooms module, created with @service Cleanrooms.

Index

Documentation

Main.Cleanrooms.batch_get_schemaMethod
batch_get_schema(collaboration_identifier, names)
batch_get_schema(collaboration_identifier, names, params::Dict{String,<:Any})

Retrieves multiple schemas by their identifiers.

Arguments

  • collaboration_identifier: A unique identifier for the collaboration that the schemas belong to. Currently accepts collaboration ID.
  • names: The names for the schema objects to retrieve.&gt;
Main.Cleanrooms.create_collaborationMethod
create_collaboration(creator_display_name, creator_member_abilities, description, members, name, query_log_status)
create_collaboration(creator_display_name, creator_member_abilities, description, members, name, query_log_status, params::Dict{String,<:Any})

Creates a new collaboration.

Arguments

  • creator_display_name: The display name of the collaboration creator.
  • creator_member_abilities: The abilities granted to the collaboration creator.
  • description: A description of the collaboration provided by the collaboration owner.
  • members: A list of initial members, not including the creator. This list is immutable.
  • name: The display name for a collaboration.
  • query_log_status: An indicator as to whether query logging has been enabled or disabled for the collaboration.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "dataEncryptionMetadata": The settings for client-side encryption with Cryptographic Computing for Clean Rooms.
  • "tags": An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
Main.Cleanrooms.create_configured_tableMethod
create_configured_table(allowed_columns, analysis_method, name, table_reference)
create_configured_table(allowed_columns, analysis_method, name, table_reference, params::Dict{String,<:Any})

Creates a new configured table resource.

Arguments

  • allowed_columns: The columns of the underlying table that can be used by collaborations or analysis rules.
  • analysis_method: The analysis method for the configured tables. The only valid value is currently DIRECT_QUERY.
  • name: The name of the configured table.
  • table_reference: A reference to the AWS Glue table being configured.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A description for the configured table.
  • "tags": An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
Main.Cleanrooms.create_configured_table_analysis_ruleMethod
create_configured_table_analysis_rule(analysis_rule_policy, analysis_rule_type, configured_table_identifier)
create_configured_table_analysis_rule(analysis_rule_policy, analysis_rule_type, configured_table_identifier, params::Dict{String,<:Any})

Creates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a given configured table.

Arguments

  • analysis_rule_policy: The entire created configured table analysis rule object.
  • analysis_rule_type: The type of analysis rule. Valid values are AGGREGATION and LIST.
  • configured_table_identifier: The identifier for the configured table to create the analysis rule for. Currently accepts the configured table ID.
Main.Cleanrooms.create_configured_table_associationMethod
create_configured_table_association(configured_table_identifier, membership_identifier, name, role_arn)
create_configured_table_association(configured_table_identifier, membership_identifier, name, role_arn, params::Dict{String,<:Any})

Creates a configured table association. A configured table association links a configured table with a collaboration.

Arguments

  • configured_table_identifier: A unique identifier for the configured table to be associated to. Currently accepts a configured table ID.
  • membership_identifier: A unique identifier for one of your memberships for a collaboration. The configured table is associated to the collaboration that this membership belongs to. Currently accepts a membership ID.
  • name: The name of the configured table association. This name is used to query the underlying configured table.
  • role_arn: The service will assume this role to access catalog metadata and query the table.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A description for the configured table association.
  • "tags": An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
Main.Cleanrooms.create_membershipMethod
create_membership(collaboration_identifier, query_log_status)
create_membership(collaboration_identifier, query_log_status, params::Dict{String,<:Any})

Creates a membership for a specific collaboration identifier and joins the collaboration.

Arguments

  • collaboration_identifier: The unique ID for the associated collaboration.
  • query_log_status: An indicator as to whether query logging has been enabled or disabled for the collaboration.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "tags": An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
Main.Cleanrooms.delete_collaborationMethod
delete_collaboration(collaboration_identifier)
delete_collaboration(collaboration_identifier, params::Dict{String,<:Any})

Deletes a collaboration. It can only be called by the collaboration owner.

Arguments

  • collaboration_identifier: The identifier for the collaboration.
Main.Cleanrooms.delete_configured_tableMethod
delete_configured_table(configured_table_identifier)
delete_configured_table(configured_table_identifier, params::Dict{String,<:Any})

Deletes a configured table.

Arguments

  • configured_table_identifier: The unique ID for the configured table to delete.
Main.Cleanrooms.delete_configured_table_analysis_ruleMethod
delete_configured_table_analysis_rule(analysis_rule_type, configured_table_identifier)
delete_configured_table_analysis_rule(analysis_rule_type, configured_table_identifier, params::Dict{String,<:Any})

Deletes a configured table analysis rule.

Arguments

  • analysis_rule_type: The analysis rule type to be deleted. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.
  • configured_table_identifier: The unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID.
Main.Cleanrooms.delete_configured_table_associationMethod
delete_configured_table_association(configured_table_association_identifier, membership_identifier)
delete_configured_table_association(configured_table_association_identifier, membership_identifier, params::Dict{String,<:Any})

Deletes a configured table association.

Arguments

  • configured_table_association_identifier: The unique ID for the configured table association to be deleted. Currently accepts the configured table ID.
  • membership_identifier: A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
Main.Cleanrooms.delete_memberMethod
delete_member(account_id, collaboration_identifier)
delete_member(account_id, collaboration_identifier, params::Dict{String,<:Any})

Removes the specified member from a collaboration. The removed member is placed in the Removed status and can't interact with the collaboration. The removed member's data is inaccessible to active members of the collaboration.

Arguments

  • account_id: The account ID of the member to remove.
  • collaboration_identifier: The unique identifier for the associated collaboration.
Main.Cleanrooms.delete_membershipMethod
delete_membership(membership_identifier)
delete_membership(membership_identifier, params::Dict{String,<:Any})

Deletes a specified membership. All resources under a membership must be deleted.

Arguments

  • membership_identifier: The identifier for a membership resource.
Main.Cleanrooms.get_collaborationMethod
get_collaboration(collaboration_identifier)
get_collaboration(collaboration_identifier, params::Dict{String,<:Any})

Returns metadata about a collaboration.

Arguments

  • collaboration_identifier: The identifier for the collaboration.
Main.Cleanrooms.get_configured_tableMethod
get_configured_table(configured_table_identifier)
get_configured_table(configured_table_identifier, params::Dict{String,<:Any})

Retrieves a configured table.

Arguments

  • configured_table_identifier: The unique ID for the configured table to retrieve.
Main.Cleanrooms.get_configured_table_analysis_ruleMethod
get_configured_table_analysis_rule(analysis_rule_type, configured_table_identifier)
get_configured_table_analysis_rule(analysis_rule_type, configured_table_identifier, params::Dict{String,<:Any})

Retrieves a configured table analysis rule.

Arguments

  • analysis_rule_type: The analysis rule to be retrieved. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.
  • configured_table_identifier: The unique identifier for the configured table to retrieve. Currently accepts the configured table ID.
Main.Cleanrooms.get_configured_table_associationMethod
get_configured_table_association(configured_table_association_identifier, membership_identifier)
get_configured_table_association(configured_table_association_identifier, membership_identifier, params::Dict{String,<:Any})

Retrieves a configured table association.

Arguments

  • configured_table_association_identifier: The unique ID for the configured table association to retrieve. Currently accepts the configured table ID.
  • membership_identifier: A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
Main.Cleanrooms.get_membershipMethod
get_membership(membership_identifier)
get_membership(membership_identifier, params::Dict{String,<:Any})

Retrieves a specified membership for an identifier.

Arguments

  • membership_identifier: The identifier for a membership resource.
Main.Cleanrooms.get_protected_queryMethod
get_protected_query(membership_identifier, protected_query_identifier)
get_protected_query(membership_identifier, protected_query_identifier, params::Dict{String,<:Any})

Returns query processing metadata.

Arguments

  • membership_identifier: The identifier for a membership in a protected query instance.
  • protected_query_identifier: The identifier for a protected query instance.
Main.Cleanrooms.get_schemaMethod
get_schema(collaboration_identifier, name)
get_schema(collaboration_identifier, name, params::Dict{String,<:Any})

Retrieves the schema for a relation within a collaboration.

Arguments

  • collaboration_identifier: A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
  • name: The name of the relation to retrieve the schema for.
Main.Cleanrooms.get_schema_analysis_ruleMethod
get_schema_analysis_rule(collaboration_identifier, name, type)
get_schema_analysis_rule(collaboration_identifier, name, type, params::Dict{String,<:Any})

Retrieves a schema analysis rule.

Arguments

  • collaboration_identifier: A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
  • name: The name of the schema to retrieve the analysis rule for.
  • type: The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely identified by a combination of the collaboration, the schema name, and their type.
Main.Cleanrooms.list_collaborationsMethod
list_collaborations()
list_collaborations(params::Dict{String,<:Any})

Lists collaborations the caller owns, is active in, or has been invited to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
  • "memberStatus": The caller's status in a collaboration.
  • "nextToken": The token value retrieved from a previous call to access the next page of results.
Main.Cleanrooms.list_configured_table_associationsMethod
list_configured_table_associations(membership_identifier)
list_configured_table_associations(membership_identifier, params::Dict{String,<:Any})

Lists configured table associations for a membership.

Arguments

  • membership_identifier: A unique identifier for the membership to list configured table associations for. Currently accepts the membership ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum size of the results that is returned per call.
  • "nextToken": The token value retrieved from a previous call to access the next page of results.
Main.Cleanrooms.list_configured_tablesMethod
list_configured_tables()
list_configured_tables(params::Dict{String,<:Any})

Lists configured tables.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum size of the results that is returned per call.
  • "nextToken": The token value retrieved from a previous call to access the next page of results.
Main.Cleanrooms.list_membersMethod
list_members(collaboration_identifier)
list_members(collaboration_identifier, params::Dict{String,<:Any})

Lists all members within a collaboration.

Arguments

  • collaboration_identifier: The identifier of the collaboration in which the members are listed.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum size of the results that is returned per call.
  • "nextToken": The token value retrieved from a previous call to access the next page of results.
Main.Cleanrooms.list_membershipsMethod
list_memberships()
list_memberships(params::Dict{String,<:Any})

Lists all memberships resources within the caller's account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum size of the results that is returned per call.
  • "nextToken": The token value retrieved from a previous call to access the next page of results.
  • "status": A filter which will return only memberships in the specified status.
Main.Cleanrooms.list_protected_queriesMethod
list_protected_queries(membership_identifier)
list_protected_queries(membership_identifier, params::Dict{String,<:Any})

Lists protected queries, sorted by the most recent query.

Arguments

  • membership_identifier: The identifier for the membership in the collaboration.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service can return a nextToken even if the maximum results has not been met.
  • "nextToken": The token value retrieved from a previous call to access the next page of results.
  • "status": A filter on the status of the protected query.
Main.Cleanrooms.list_schemasMethod
list_schemas(collaboration_identifier)
list_schemas(collaboration_identifier, params::Dict{String,<:Any})

Lists the schemas for relations within a collaboration.

Arguments

  • collaboration_identifier: A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum size of the results that is returned per call.
  • "nextToken": The token value retrieved from a previous call to access the next page of results.
  • "schemaType": If present, filter schemas by schema type. The only valid schema type is currently TABLE.
Main.Cleanrooms.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Lists all of the tags that have been added to a resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) associated with the resource you want to list tags on.
Main.Cleanrooms.start_protected_queryMethod
start_protected_query(membership_identifier, result_configuration, sql_parameters, type)
start_protected_query(membership_identifier, result_configuration, sql_parameters, type, params::Dict{String,<:Any})

Creates a protected query that is started by AWS Clean Rooms.

Arguments

  • membership_identifier: A unique identifier for the membership to run this query against. Currently accepts a membership ID.
  • result_configuration: The details needed to write the query results.
  • sql_parameters: The protected SQL query parameters.
  • type: The type of the protected query to be started.
Main.Cleanrooms.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Tags a resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) associated with the resource you want to tag.
  • tags: A map of objects specifying each key name and value.
Main.Cleanrooms.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes a tag or list of tags from a resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from.
  • tag_keys: A list of key names of tags to be removed.
Main.Cleanrooms.update_collaborationMethod
update_collaboration(collaboration_identifier)
update_collaboration(collaboration_identifier, params::Dict{String,<:Any})

Updates collaboration metadata and can only be called by the collaboration owner.

Arguments

  • collaboration_identifier: The identifier for the collaboration.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A description of the collaboration.
  • "name": A human-readable identifier provided by the collaboration owner. Display names are not unique.
Main.Cleanrooms.update_configured_tableMethod
update_configured_table(configured_table_identifier)
update_configured_table(configured_table_identifier, params::Dict{String,<:Any})

Updates a configured table.

Arguments

  • configured_table_identifier: The identifier for the configured table to update. Currently accepts the configured table ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A new description for the configured table.
  • "name": A new name for the configured table.
Main.Cleanrooms.update_configured_table_analysis_ruleMethod
update_configured_table_analysis_rule(analysis_rule_policy, analysis_rule_type, configured_table_identifier)
update_configured_table_analysis_rule(analysis_rule_policy, analysis_rule_type, configured_table_identifier, params::Dict{String,<:Any})

Updates a configured table analysis rule.

Arguments

  • analysis_rule_policy: The new analysis rule policy for the configured table analysis rule.
  • analysis_rule_type: The analysis rule type to be updated. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.
  • configured_table_identifier: The unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID.
Main.Cleanrooms.update_configured_table_associationMethod
update_configured_table_association(configured_table_association_identifier, membership_identifier)
update_configured_table_association(configured_table_association_identifier, membership_identifier, params::Dict{String,<:Any})

Updates a configured table association.

Arguments

  • configured_table_association_identifier: The unique identifier for the configured table association to update. Currently accepts the configured table association ID.
  • membership_identifier: The unique ID for the membership that the configured table association belongs to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A new description for the configured table association.
  • "roleArn": The service will assume this role to access catalog metadata and query the table.
Main.Cleanrooms.update_membershipMethod
update_membership(membership_identifier)
update_membership(membership_identifier, params::Dict{String,<:Any})

Updates a membership.

Arguments

  • membership_identifier: The unique identifier of the membership.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "queryLogStatus": An indicator as to whether query logging has been enabled or disabled for the collaboration.
Main.Cleanrooms.update_protected_queryMethod
update_protected_query(membership_identifier, protected_query_identifier, target_status)
update_protected_query(membership_identifier, protected_query_identifier, target_status, params::Dict{String,<:Any})

Updates the processing of a currently running query.

Arguments

  • membership_identifier: The identifier for a member of a protected query instance.
  • protected_query_identifier: The identifier for a protected query instance.
  • target_status: The target status of a query. Used to update the execution status of a currently running query.