(constructor)

[configuration]

Constructs a new instance of the <code>CleanRoomsClient</code> class

config

The resolved configuration of CleanRoomsClient class. This is resolved and normalized from the [constructor configuration interface](@aws-sdk/client-cleanrooms!CleanRoomsClientConfig:Interface).

destroy

Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

middlewareStack

send

command

options

CleanRoomsClient

Welcome to the Clean Rooms API Reference. Clean Rooms is an Amazon Web Services service that helps multiple parties to join their data together in a secure collaboration workspace. In the collaboration, members who can query and receive results can get insights into the collective datasets without either party getting access to the other party's raw data. To learn more about Clean Rooms concepts, procedures, and best practices, see the <a href="https://docs.aws.amazon.com/clean-rooms/latest/userguide/what-is.html">Clean Rooms User Guide</a>. To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the <a href="https://docs.aws.amazon.com/clean-rooms/latest/sql-reference/sql-reference.html">Clean Rooms SQL Reference</a>.

defaultsMode

The [@smithy/smithy-client#DefaultsMode](@smithy/smithy-client!DefaultsMode:type) that will be used to determine how certain default configuration options are resolved in the SDK.

disableHostPrefix

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

extensions

logger

Optional logger for logging debug/info/warn/error.

maxAttempts

Value for how many times a request will be made at most in case of retry.

region

The AWS region to which this client will send requests

requestHandler

The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

retryMode

useDualstackEndpoint

useFipsEndpoint

ClientDefaults

BatchGetCollaborationAnalysisTemplateCommand

Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).

BatchGetSchemaAnalysisRuleCommand

Retrieves multiple analysis rule schemas.

BatchGetSchemaCommand

Retrieves multiple schemas by their identifiers.

CreateAnalysisTemplateCommand

CreateCollaborationCommand

CreateConfiguredAudienceModelAssociationCommand

Provides the details necessary to create a configured audience model association.

CreateConfiguredTableAnalysisRuleCommand

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

CreateConfiguredTableAssociationAnalysisRuleCommand

Creates a new analysis rule for an associated configured table.

CreateConfiguredTableAssociationCommand

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

CreateConfiguredTableCommand

Creates a new configured table resource.

CreateIdMappingTableCommand

CreateIdNamespaceAssociationCommand

Creates an ID namespace association.

CreateMembershipCommand

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

CreatePrivacyBudgetTemplateCommand

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.

DeleteAnalysisTemplateCommand

DeleteCollaborationCommand

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

DeleteConfiguredAudienceModelAssociationCommand

Provides the information necessary to delete a configured audience model association.

DeleteConfiguredTableAnalysisRuleCommand

Deletes a configured table analysis rule.

DeleteConfiguredTableAssociationAnalysisRuleCommand

Deletes an analysis rule for a configured table association.

DeleteConfiguredTableAssociationCommand

Deletes a configured table association.

DeleteConfiguredTableCommand

DeleteIdMappingTableCommand

DeleteIdNamespaceAssociationCommand

Deletes an ID namespace association.

DeleteMemberCommand

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.

DeleteMembershipCommand

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

DeletePrivacyBudgetTemplateCommand

Deletes a privacy budget template for a specified membership.

GetAnalysisTemplateCommand

GetCollaborationAnalysisTemplateCommand

Retrieves an analysis template within a collaboration.

GetCollaborationCommand

Returns metadata about a collaboration.

GetCollaborationConfiguredAudienceModelAssociationCommand

Retrieves a configured audience model association within a collaboration.

GetCollaborationIdNamespaceAssociationCommand

Retrieves an ID namespace association from a specific collaboration.

GetCollaborationPrivacyBudgetTemplateCommand

Returns details about a specified privacy budget template.

GetConfiguredAudienceModelAssociationCommand

Returns information about a configured audience model association.

GetConfiguredTableAnalysisRuleCommand

Retrieves a configured table analysis rule.

GetConfiguredTableAssociationAnalysisRuleCommand

Retrieves the analysis rule for a configured table association.

GetConfiguredTableAssociationCommand

Retrieves a configured table association.

GetConfiguredTableCommand

GetIdMappingTableCommand

GetIdNamespaceAssociationCommand

Retrieves an ID namespace association.

GetMembershipCommand

Retrieves a specified membership for an identifier.

GetPrivacyBudgetTemplateCommand

Returns details for a specified privacy budget template.

GetProtectedQueryCommand

Returns query processing metadata.

GetSchemaAnalysisRuleCommand

GetSchemaCommand

Retrieves the schema for a relation within a collaboration.

ListAnalysisTemplatesCommand

Lists analysis templates that the caller owns.

ListCollaborationAnalysisTemplatesCommand

Lists analysis templates within a collaboration.

ListCollaborationConfiguredAudienceModelAssociationsCommand

Lists configured audience model associations within a collaboration.

ListCollaborationIdNamespaceAssociationsCommand

Returns a list of the ID namespace associations in a collaboration.

ListCollaborationPrivacyBudgetTemplatesCommand

Returns an array that summarizes each privacy budget template in a specified collaboration.

ListCollaborationPrivacyBudgetsCommand

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.

ListCollaborationsCommand

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

ListConfiguredAudienceModelAssociationsCommand

Lists information about requested configured audience model associations.

ListConfiguredTableAssociationsCommand

Lists configured table associations for a membership.

ListConfiguredTablesCommand

ListIdMappingTablesCommand

Returns a list of ID mapping tables.

ListIdNamespaceAssociationsCommand

Returns a list of ID namespace associations.

ListMembersCommand

Lists all members within a collaboration.

ListMembershipsCommand

Lists all memberships resources within the caller's account.

ListPrivacyBudgetTemplatesCommand

Returns detailed information about the privacy budget templates in a specified membership.

ListPrivacyBudgetsCommand

Returns detailed information about the privacy budgets in a specified membership.

ListProtectedQueriesCommand

Lists protected queries, sorted by the most recent query.

ListSchemasCommand

Lists the schemas for relations within a collaboration.

ListTagsForResourceCommand

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

PopulateIdMappingTableCommand

Defines the information that's necessary to populate an ID mapping table.

PreviewPrivacyImpactCommand

An estimate of the number of aggregation functions that the member who can query can run given epsilon and noise parameters.

StartProtectedQueryCommand

Creates a protected query that is started by Clean Rooms.

TagResourceCommand

UntagResourceCommand

Removes a tag or list of tags from a resource.

UpdateAnalysisTemplateCommand

Updates the analysis template metadata.

UpdateCollaborationCommand

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

UpdateConfiguredAudienceModelAssociationCommand

Provides the details necessary to update a configured audience model association.

UpdateConfiguredTableAnalysisRuleCommand

Updates a configured table analysis rule.

UpdateConfiguredTableAssociationAnalysisRuleCommand

Updates the analysis rule for a configured table association.

UpdateConfiguredTableAssociationCommand

Updates a configured table association.

UpdateConfiguredTableCommand

UpdateIdMappingTableCommand

Provides the details that are necessary to update an ID mapping table.

UpdateIdNamespaceAssociationCommand

Provides the details that are necessary to update an ID namespace association.