Cleanrooms
This page documents function available when using the Cleanrooms
module, created with @service Cleanrooms
.
Index
Main.Cleanrooms.batch_get_collaboration_analysis_template
Main.Cleanrooms.batch_get_schema
Main.Cleanrooms.batch_get_schema_analysis_rule
Main.Cleanrooms.create_analysis_template
Main.Cleanrooms.create_collaboration
Main.Cleanrooms.create_configured_audience_model_association
Main.Cleanrooms.create_configured_table
Main.Cleanrooms.create_configured_table_analysis_rule
Main.Cleanrooms.create_configured_table_association
Main.Cleanrooms.create_membership
Main.Cleanrooms.create_privacy_budget_template
Main.Cleanrooms.delete_analysis_template
Main.Cleanrooms.delete_collaboration
Main.Cleanrooms.delete_configured_audience_model_association
Main.Cleanrooms.delete_configured_table
Main.Cleanrooms.delete_configured_table_analysis_rule
Main.Cleanrooms.delete_configured_table_association
Main.Cleanrooms.delete_member
Main.Cleanrooms.delete_membership
Main.Cleanrooms.delete_privacy_budget_template
Main.Cleanrooms.get_analysis_template
Main.Cleanrooms.get_collaboration
Main.Cleanrooms.get_collaboration_analysis_template
Main.Cleanrooms.get_collaboration_configured_audience_model_association
Main.Cleanrooms.get_collaboration_privacy_budget_template
Main.Cleanrooms.get_configured_audience_model_association
Main.Cleanrooms.get_configured_table
Main.Cleanrooms.get_configured_table_analysis_rule
Main.Cleanrooms.get_configured_table_association
Main.Cleanrooms.get_membership
Main.Cleanrooms.get_privacy_budget_template
Main.Cleanrooms.get_protected_query
Main.Cleanrooms.get_schema
Main.Cleanrooms.get_schema_analysis_rule
Main.Cleanrooms.list_analysis_templates
Main.Cleanrooms.list_collaboration_analysis_templates
Main.Cleanrooms.list_collaboration_configured_audience_model_associations
Main.Cleanrooms.list_collaboration_privacy_budget_templates
Main.Cleanrooms.list_collaboration_privacy_budgets
Main.Cleanrooms.list_collaborations
Main.Cleanrooms.list_configured_audience_model_associations
Main.Cleanrooms.list_configured_table_associations
Main.Cleanrooms.list_configured_tables
Main.Cleanrooms.list_members
Main.Cleanrooms.list_memberships
Main.Cleanrooms.list_privacy_budget_templates
Main.Cleanrooms.list_privacy_budgets
Main.Cleanrooms.list_protected_queries
Main.Cleanrooms.list_schemas
Main.Cleanrooms.list_tags_for_resource
Main.Cleanrooms.preview_privacy_impact
Main.Cleanrooms.start_protected_query
Main.Cleanrooms.tag_resource
Main.Cleanrooms.untag_resource
Main.Cleanrooms.update_analysis_template
Main.Cleanrooms.update_collaboration
Main.Cleanrooms.update_configured_audience_model_association
Main.Cleanrooms.update_configured_table
Main.Cleanrooms.update_configured_table_analysis_rule
Main.Cleanrooms.update_configured_table_association
Main.Cleanrooms.update_membership
Main.Cleanrooms.update_privacy_budget_template
Main.Cleanrooms.update_protected_query
Documentation
Main.Cleanrooms.batch_get_collaboration_analysis_template
— Methodbatch_get_collaboration_analysis_template(analysis_template_arns, collaboration_identifier)
batch_get_collaboration_analysis_template(analysis_template_arns, collaboration_identifier, params::Dict{String,<:Any})
Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).
Arguments
analysis_template_arns
: The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.collaboration_identifier
: A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
Main.Cleanrooms.batch_get_schema
— Methodbatch_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.
Main.Cleanrooms.batch_get_schema_analysis_rule
— Methodbatch_get_schema_analysis_rule(collaboration_identifier, schema_analysis_rule_requests)
batch_get_schema_analysis_rule(collaboration_identifier, schema_analysis_rule_requests, params::Dict{String,<:Any})
Retrieves multiple analysis rule schemas.
Arguments
collaboration_identifier
: The unique identifier of the collaboration that contains the schema analysis rule.schema_analysis_rule_requests
: The information that's necessary to retrieve a schema analysis rule.
Main.Cleanrooms.create_analysis_template
— Methodcreate_analysis_template(format, membership_identifier, name, source)
create_analysis_template(format, membership_identifier, name, source, params::Dict{String,<:Any})
Creates a new analysis template.
Arguments
format
: The format of the analysis template.membership_identifier
: The identifier for a membership resource.name
: The name of the analysis template.source
: The information in the analysis template. Currently supports text, the query text for the analysis template.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"analysisParameters"
: The parameters of the analysis template."description"
: The description of the analysis template."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_collaboration
— Methodcreate_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:
"creatorPaymentConfiguration"
: The collaboration creator's payment responsibilities set by the collaboration creator. If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer."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_audience_model_association
— Methodcreate_configured_audience_model_association(configured_audience_model_arn, configured_audience_model_association_name, manage_resource_policies, membership_identifier)
create_configured_audience_model_association(configured_audience_model_arn, configured_audience_model_association_name, manage_resource_policies, membership_identifier, params::Dict{String,<:Any})
Provides the details necessary to create a configured audience model association.
Arguments
configured_audience_model_arn
: A unique identifier for the configured audience model that you want to associate.configured_audience_model_association_name
: The name of the configured audience model association.manage_resource_policies
: When TRUE, indicates that the resource policy for the configured audience model resource being associated is configured for Clean Rooms to manage permissions related to the given collaboration. When FALSE, indicates that the configured audience model resource owner will manage permissions related to the given collaboration. Setting this to TRUE requires you to have permissions to create, update, and delete the resource policy for the cleanrooms-ml resource when you call the DeleteConfiguredAudienceModelAssociation resource. In addition, if you are the collaboration creator and specify TRUE, you must have the same permissions when you call the DeleteMember and DeleteCollaboration APIs.membership_identifier
: A unique identifier for one of your memberships for a collaboration. The configured audience model is associated to the collaboration that this membership belongs to. Accepts a membership ID.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"description"
: A description of the configured audience model 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_configured_table
— Methodcreate_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 currentlyDIRECT_QUERY
.name
: The name of the configured table.table_reference
: A reference to the 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_rule
— Methodcreate_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.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_association
— Methodcreate_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_membership
— Methodcreate_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 membership.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"defaultResultConfiguration"
: The default protected query result configuration as specified by the member who can receive results."paymentConfiguration"
: The payment responsibilities accepted by the collaboration member. Not required if the collaboration member has the member ability to run queries. Required if the collaboration member doesn't have the member ability to run queries but is configured as a payer by the collaboration creator."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_privacy_budget_template
— Methodcreate_privacy_budget_template(auto_refresh, membership_identifier, parameters, privacy_budget_type)
create_privacy_budget_template(auto_refresh, membership_identifier, parameters, privacy_budget_type, params::Dict{String,<:Any})
Creates a privacy budget template for a specified membership. Each membership can have only one privacy budget template, but it can be deleted and recreated. If you need to change the privacy budget template for a membership, use the UpdatePrivacyBudgetTemplate operation.
Arguments
auto_refresh
: How often the privacy budget refreshes. If you plan to regularly bring new data into the collaboration, you can use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queries across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.membership_identifier
: A unique identifier for one of your memberships for a collaboration. The privacy budget template is created in the collaboration that this membership belongs to. Accepts a membership ID.parameters
: Specifies your parameters for the privacy budget template.privacy_budget_type
: Specifies the type of the privacy budget template.
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_analysis_template
— Methoddelete_analysis_template(analysis_template_identifier, membership_identifier)
delete_analysis_template(analysis_template_identifier, membership_identifier, params::Dict{String,<:Any})
Deletes an analysis template.
Arguments
analysis_template_identifier
: The identifier for the analysis template resource.membership_identifier
: The identifier for a membership resource.
Main.Cleanrooms.delete_collaboration
— Methoddelete_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_audience_model_association
— Methoddelete_configured_audience_model_association(configured_audience_model_association_identifier, membership_identifier)
delete_configured_audience_model_association(configured_audience_model_association_identifier, membership_identifier, params::Dict{String,<:Any})
Provides the information necessary to delete a configured audience model association.
Arguments
configured_audience_model_association_identifier
: A unique identifier of the configured audience model association that you want to delete.membership_identifier
: A unique identifier of the membership that contains the audience model association that you want to delete.
Main.Cleanrooms.delete_configured_table
— Methoddelete_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_rule
— Methoddelete_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_association
— Methoddelete_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_member
— Methoddelete_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_membership
— Methoddelete_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.delete_privacy_budget_template
— Methoddelete_privacy_budget_template(membership_identifier, privacy_budget_template_identifier)
delete_privacy_budget_template(membership_identifier, privacy_budget_template_identifier, params::Dict{String,<:Any})
Deletes a privacy budget template for a specified membership.
Arguments
membership_identifier
: A unique identifier for one of your memberships for a collaboration. The privacy budget template is deleted from the collaboration that this membership belongs to. Accepts a membership ID.privacy_budget_template_identifier
: A unique identifier for your privacy budget template.
Main.Cleanrooms.get_analysis_template
— Methodget_analysis_template(analysis_template_identifier, membership_identifier)
get_analysis_template(analysis_template_identifier, membership_identifier, params::Dict{String,<:Any})
Retrieves an analysis template.
Arguments
analysis_template_identifier
: The identifier for the analysis template resource.membership_identifier
: The identifier for a membership resource.
Main.Cleanrooms.get_collaboration
— Methodget_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_collaboration_analysis_template
— Methodget_collaboration_analysis_template(analysis_template_arn, collaboration_identifier)
get_collaboration_analysis_template(analysis_template_arn, collaboration_identifier, params::Dict{String,<:Any})
Retrieves an analysis template within a collaboration.
Arguments
analysis_template_arn
: The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.collaboration_identifier
: A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
Main.Cleanrooms.get_collaboration_configured_audience_model_association
— Methodget_collaboration_configured_audience_model_association(collaboration_identifier, configured_audience_model_association_identifier)
get_collaboration_configured_audience_model_association(collaboration_identifier, configured_audience_model_association_identifier, params::Dict{String,<:Any})
Retrieves a configured audience model association within a collaboration.
Arguments
collaboration_identifier
: A unique identifier for the collaboration that the configured audience model association belongs to. Accepts a collaboration ID.configured_audience_model_association_identifier
: A unique identifier for the configured audience model association that you want to retrieve.
Main.Cleanrooms.get_collaboration_privacy_budget_template
— Methodget_collaboration_privacy_budget_template(collaboration_identifier, privacy_budget_template_identifier)
get_collaboration_privacy_budget_template(collaboration_identifier, privacy_budget_template_identifier, params::Dict{String,<:Any})
Returns details about a specified privacy budget template.
Arguments
collaboration_identifier
: A unique identifier for one of your collaborations.privacy_budget_template_identifier
: A unique identifier for one of your privacy budget templates.
Main.Cleanrooms.get_configured_audience_model_association
— Methodget_configured_audience_model_association(configured_audience_model_association_identifier, membership_identifier)
get_configured_audience_model_association(configured_audience_model_association_identifier, membership_identifier, params::Dict{String,<:Any})
Returns information about a configured audience model association.
Arguments
configured_audience_model_association_identifier
: A unique identifier for the configured audience model association that you want to retrieve.membership_identifier
: A unique identifier for the membership that contains the configured audience model association that you want to retrieve.
Main.Cleanrooms.get_configured_table
— Methodget_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_rule
— Methodget_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_association
— Methodget_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_membership
— Methodget_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_privacy_budget_template
— Methodget_privacy_budget_template(membership_identifier, privacy_budget_template_identifier)
get_privacy_budget_template(membership_identifier, privacy_budget_template_identifier, params::Dict{String,<:Any})
Returns details for a specified privacy budget template.
Arguments
membership_identifier
: A unique identifier for one of your memberships for a collaboration. The privacy budget template is retrieved from the collaboration that this membership belongs to. Accepts a membership ID.privacy_budget_template_identifier
: A unique identifier for your privacy budget template.
Main.Cleanrooms.get_protected_query
— Methodget_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_schema
— Methodget_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_rule
— Methodget_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_analysis_templates
— Methodlist_analysis_templates(membership_identifier)
list_analysis_templates(membership_identifier, params::Dict{String,<:Any})
Lists analysis templates that the caller owns.
Arguments
membership_identifier
: The identifier for a membership resource.
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_collaboration_analysis_templates
— Methodlist_collaboration_analysis_templates(collaboration_identifier)
list_collaboration_analysis_templates(collaboration_identifier, params::Dict{String,<:Any})
Lists analysis templates within a collaboration.
Arguments
collaboration_identifier
: A unique identifier for the collaboration that the analysis templates belong to. Currently accepts 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.
Main.Cleanrooms.list_collaboration_configured_audience_model_associations
— Methodlist_collaboration_configured_audience_model_associations(collaboration_identifier)
list_collaboration_configured_audience_model_associations(collaboration_identifier, params::Dict{String,<:Any})
Lists configured audience model associations within a collaboration.
Arguments
collaboration_identifier
: A unique identifier for the collaboration that the configured audience model association belongs to. 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.
Main.Cleanrooms.list_collaboration_privacy_budget_templates
— Methodlist_collaboration_privacy_budget_templates(collaboration_identifier)
list_collaboration_privacy_budget_templates(collaboration_identifier, params::Dict{String,<:Any})
Returns an array that summarizes each privacy budget template in a specified collaboration.
Arguments
collaboration_identifier
: A unique identifier for one of your collaborations.
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."nextToken"
: The token value retrieved from a previous call to access the next page of results.
Main.Cleanrooms.list_collaboration_privacy_budgets
— Methodlist_collaboration_privacy_budgets(collaboration_identifier, privacy_budget_type)
list_collaboration_privacy_budgets(collaboration_identifier, privacy_budget_type, params::Dict{String,<:Any})
Returns an array that summarizes each privacy budget in a specified collaboration. The summary includes the collaboration ARN, creation time, creating account, and privacy budget details.
Arguments
collaboration_identifier
: A unique identifier for one of your collaborations.privacy_budget_type
: Specifies the type of the privacy budget.
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."nextToken"
: The token value retrieved from a previous call to access the next page of results.
Main.Cleanrooms.list_collaborations
— Methodlist_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_audience_model_associations
— Methodlist_configured_audience_model_associations(membership_identifier)
list_configured_audience_model_associations(membership_identifier, params::Dict{String,<:Any})
Lists information about requested configured audience model associations.
Arguments
membership_identifier
: A unique identifier for a membership that contains the configured audience model associations that you want to retrieve.
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."nextToken"
: The token value retrieved from a previous call to access the next page of results.
Main.Cleanrooms.list_configured_table_associations
— Methodlist_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_tables
— Methodlist_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_members
— Methodlist_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_memberships
— Methodlist_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_privacy_budget_templates
— Methodlist_privacy_budget_templates(membership_identifier)
list_privacy_budget_templates(membership_identifier, params::Dict{String,<:Any})
Returns detailed information about the privacy budget templates in a specified membership.
Arguments
membership_identifier
: A unique identifier for one of your memberships for a collaboration. The privacy budget templates are retrieved from the collaboration that this membership belongs to. Accepts a 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. Service chooses a default if it has not been set. Service may 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.
Main.Cleanrooms.list_privacy_budgets
— Methodlist_privacy_budgets(membership_identifier, privacy_budget_type)
list_privacy_budgets(membership_identifier, privacy_budget_type, params::Dict{String,<:Any})
Returns detailed information about the privacy budgets in a specified membership.
Arguments
membership_identifier
: A unique identifier for one of your memberships for a collaboration. The privacy budget is retrieved from the collaboration that this membership belongs to. Accepts a membership ID.privacy_budget_type
: The privacy budget type.
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."nextToken"
: The token value retrieved from a previous call to access the next page of results.
Main.Cleanrooms.list_protected_queries
— Methodlist_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_schemas
— Methodlist_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 currentlyTABLE
.
Main.Cleanrooms.list_tags_for_resource
— Methodlist_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.preview_privacy_impact
— Methodpreview_privacy_impact(membership_identifier, parameters)
preview_privacy_impact(membership_identifier, parameters, params::Dict{String,<:Any})
An estimate of the number of aggregation functions that the member who can query can run given epsilon and noise parameters.
Arguments
membership_identifier
: A unique identifier for one of your memberships for a collaboration. Accepts a membership ID.parameters
: Specifies the desired epsilon and noise parameters to preview.
Main.Cleanrooms.start_protected_query
— Methodstart_protected_query(membership_identifier, sql_parameters, type)
start_protected_query(membership_identifier, sql_parameters, type, params::Dict{String,<:Any})
Creates a protected query that is started by Clean Rooms.
Arguments
membership_identifier
: A unique identifier for the membership to run this query against. Currently accepts a membership ID.sql_parameters
: The protected SQL query parameters.type
: The type of the protected query to be started.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"resultConfiguration"
: The details needed to write the query results.
Main.Cleanrooms.tag_resource
— Methodtag_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_resource
— Methoduntag_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_analysis_template
— Methodupdate_analysis_template(analysis_template_identifier, membership_identifier)
update_analysis_template(analysis_template_identifier, membership_identifier, params::Dict{String,<:Any})
Updates the analysis template metadata.
Arguments
analysis_template_identifier
: The identifier for the analysis template resource.membership_identifier
: The identifier for a membership resource.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"description"
: A new description for the analysis template.
Main.Cleanrooms.update_collaboration
— Methodupdate_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_audience_model_association
— Methodupdate_configured_audience_model_association(configured_audience_model_association_identifier, membership_identifier)
update_configured_audience_model_association(configured_audience_model_association_identifier, membership_identifier, params::Dict{String,<:Any})
Provides the details necessary to update a configured audience model association.
Arguments
configured_audience_model_association_identifier
: A unique identifier for the configured audience model association that you want to update.membership_identifier
: A unique identifier of the membership that contains the configured audience model association that you want to update.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"description"
: A new description for the configured audience model association."name"
: A new name for the configured audience model association.
Main.Cleanrooms.update_configured_table
— Methodupdate_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_rule
— Methodupdate_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_association
— Methodupdate_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_membership
— Methodupdate_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:
"defaultResultConfiguration"
: The default protected query result configuration as specified by the member who can receive results."queryLogStatus"
: An indicator as to whether query logging has been enabled or disabled for the membership.
Main.Cleanrooms.update_privacy_budget_template
— Methodupdate_privacy_budget_template(membership_identifier, privacy_budget_template_identifier, privacy_budget_type)
update_privacy_budget_template(membership_identifier, privacy_budget_template_identifier, privacy_budget_type, params::Dict{String,<:Any})
Updates the privacy budget template for the specified membership.
Arguments
membership_identifier
: A unique identifier for one of your memberships for a collaboration. The privacy budget template is updated in the collaboration that this membership belongs to. Accepts a membership ID.privacy_budget_template_identifier
: A unique identifier for your privacy budget template that you want to update.privacy_budget_type
: Specifies the type of the privacy budget template.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"parameters"
: Specifies the epsilon and noise parameters for the privacy budget template.
Main.Cleanrooms.update_protected_query
— Methodupdate_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.