Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

CleanRooms

import { CleanRooms } from "https://aws-api.deno.dev/v0.4/services/cleanrooms.ts?docs=full";
class CleanRooms {
constructor(apiFactory: client.ApiFactory);
async batchGetSchema(params: BatchGetSchemaInput, opts?: client.RequestOptions): Promise<BatchGetSchemaOutput>;
async createCollaboration(params: CreateCollaborationInput, opts?: client.RequestOptions): Promise<CreateCollaborationOutput>;
async createConfiguredTable(params: CreateConfiguredTableInput, opts?: client.RequestOptions): Promise<CreateConfiguredTableOutput>;
async createConfiguredTableAnalysisRule(params: CreateConfiguredTableAnalysisRuleInput, opts?: client.RequestOptions): Promise<CreateConfiguredTableAnalysisRuleOutput>;
async createConfiguredTableAssociation(params: CreateConfiguredTableAssociationInput, opts?: client.RequestOptions): Promise<CreateConfiguredTableAssociationOutput>;
async createMembership(params: CreateMembershipInput, opts?: client.RequestOptions): Promise<CreateMembershipOutput>;
async deleteCollaboration(params: DeleteCollaborationInput, opts?: client.RequestOptions): Promise<void>;
async deleteConfiguredTable(params: DeleteConfiguredTableInput, opts?: client.RequestOptions): Promise<void>;
async deleteConfiguredTableAnalysisRule(params: DeleteConfiguredTableAnalysisRuleInput, opts?: client.RequestOptions): Promise<void>;
async deleteConfiguredTableAssociation(params: DeleteConfiguredTableAssociationInput, opts?: client.RequestOptions): Promise<void>;
async deleteMember(params: DeleteMemberInput, opts?: client.RequestOptions): Promise<void>;
async deleteMembership(params: DeleteMembershipInput, opts?: client.RequestOptions): Promise<void>;
async getCollaboration(params: GetCollaborationInput, opts?: client.RequestOptions): Promise<GetCollaborationOutput>;
async getConfiguredTable(params: GetConfiguredTableInput, opts?: client.RequestOptions): Promise<GetConfiguredTableOutput>;
async getConfiguredTableAnalysisRule(params: GetConfiguredTableAnalysisRuleInput, opts?: client.RequestOptions): Promise<GetConfiguredTableAnalysisRuleOutput>;
async getConfiguredTableAssociation(params: GetConfiguredTableAssociationInput, opts?: client.RequestOptions): Promise<GetConfiguredTableAssociationOutput>;
async getMembership(params: GetMembershipInput, opts?: client.RequestOptions): Promise<GetMembershipOutput>;
async getProtectedQuery(params: GetProtectedQueryInput, opts?: client.RequestOptions): Promise<GetProtectedQueryOutput>;
async getSchema(params: GetSchemaInput, opts?: client.RequestOptions): Promise<GetSchemaOutput>;
async getSchemaAnalysisRule(params: GetSchemaAnalysisRuleInput, opts?: client.RequestOptions): Promise<GetSchemaAnalysisRuleOutput>;
async listCollaborations(params?: ListCollaborationsInput, opts?: client.RequestOptions): Promise<ListCollaborationsOutput>;
async listConfiguredTableAssociations(params: ListConfiguredTableAssociationsInput, opts?: client.RequestOptions): Promise<ListConfiguredTableAssociationsOutput>;
async listConfiguredTables(params?: ListConfiguredTablesInput, opts?: client.RequestOptions): Promise<ListConfiguredTablesOutput>;
async listMembers(params: ListMembersInput, opts?: client.RequestOptions): Promise<ListMembersOutput>;
async listMemberships(params?: ListMembershipsInput, opts?: client.RequestOptions): Promise<ListMembershipsOutput>;
async listProtectedQueries(params: ListProtectedQueriesInput, opts?: client.RequestOptions): Promise<ListProtectedQueriesOutput>;
async listSchemas(params: ListSchemasInput, opts?: client.RequestOptions): Promise<ListSchemasOutput>;
async startProtectedQuery(params: StartProtectedQueryInput, opts?: client.RequestOptions): Promise<StartProtectedQueryOutput>;
async updateCollaboration(params: UpdateCollaborationInput, opts?: client.RequestOptions): Promise<UpdateCollaborationOutput>;
async updateConfiguredTable(params: UpdateConfiguredTableInput, opts?: client.RequestOptions): Promise<UpdateConfiguredTableOutput>;
async updateConfiguredTableAnalysisRule(params: UpdateConfiguredTableAnalysisRuleInput, opts?: client.RequestOptions): Promise<UpdateConfiguredTableAnalysisRuleOutput>;
async updateConfiguredTableAssociation(params: UpdateConfiguredTableAssociationInput, opts?: client.RequestOptions): Promise<UpdateConfiguredTableAssociationOutput>;
async updateMembership(params: UpdateMembershipInput, opts?: client.RequestOptions): Promise<UpdateMembershipOutput>;
async updateProtectedQuery(params: UpdateProtectedQueryInput, opts?: client.RequestOptions): Promise<UpdateProtectedQueryOutput>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new CleanRooms(apiFactory: client.ApiFactory)
[src]

§Methods

§
batchGetSchema(params: BatchGetSchemaInput, opts?: client.RequestOptions): Promise<BatchGetSchemaOutput>
[src]

Retrieves multiple schemas by their identifiers.

§
createCollaboration(params: CreateCollaborationInput, opts?: client.RequestOptions): Promise<CreateCollaborationOutput>
[src]

Creates a new collaboration.

§
createConfiguredTable(params: CreateConfiguredTableInput, opts?: client.RequestOptions): Promise<CreateConfiguredTableOutput>
[src]

Creates a new configured table resource.

§
createConfiguredTableAnalysisRule(params: CreateConfiguredTableAnalysisRuleInput, opts?: client.RequestOptions): Promise<CreateConfiguredTableAnalysisRuleOutput>
[src]

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

§
createConfiguredTableAssociation(params: CreateConfiguredTableAssociationInput, opts?: client.RequestOptions): Promise<CreateConfiguredTableAssociationOutput>
[src]

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

§
createMembership(params: CreateMembershipInput, opts?: client.RequestOptions): Promise<CreateMembershipOutput>
[src]

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

§
deleteCollaboration(params: DeleteCollaborationInput, opts?: client.RequestOptions): Promise<void>
[src]

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

§
deleteConfiguredTable(params: DeleteConfiguredTableInput, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a configured table.

§
deleteConfiguredTableAnalysisRule(params: DeleteConfiguredTableAnalysisRuleInput, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a configured table analysis rule.

§
deleteConfiguredTableAssociation(params: DeleteConfiguredTableAssociationInput, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a configured table association.

§
deleteMember(params: DeleteMemberInput, opts?: client.RequestOptions): Promise<void>
[src]

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.

§
deleteMembership(params: DeleteMembershipInput, opts?: client.RequestOptions): Promise<void>
[src]

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

§
getCollaboration(params: GetCollaborationInput, opts?: client.RequestOptions): Promise<GetCollaborationOutput>
[src]

Returns metadata about a collaboration.

§
getConfiguredTable(params: GetConfiguredTableInput, opts?: client.RequestOptions): Promise<GetConfiguredTableOutput>
[src]

Retrieves a configured table.

§
getConfiguredTableAnalysisRule(params: GetConfiguredTableAnalysisRuleInput, opts?: client.RequestOptions): Promise<GetConfiguredTableAnalysisRuleOutput>
[src]

Retrieves a configured table analysis rule.

§
getConfiguredTableAssociation(params: GetConfiguredTableAssociationInput, opts?: client.RequestOptions): Promise<GetConfiguredTableAssociationOutput>
[src]

Retrieves a configured table association.

§
getMembership(params: GetMembershipInput, opts?: client.RequestOptions): Promise<GetMembershipOutput>
[src]

Retrieves a specified membership for an identifier.

§
getProtectedQuery(params: GetProtectedQueryInput, opts?: client.RequestOptions): Promise<GetProtectedQueryOutput>
[src]

Returns query processing metadata.

§
getSchema(params: GetSchemaInput, opts?: client.RequestOptions): Promise<GetSchemaOutput>
[src]

Retrieves the schema for a relation within a collaboration.

§
getSchemaAnalysisRule(params: GetSchemaAnalysisRuleInput, opts?: client.RequestOptions): Promise<GetSchemaAnalysisRuleOutput>
[src]

Retrieves a schema analysis rule.

§
listCollaborations(params?: ListCollaborationsInput, opts?: client.RequestOptions): Promise<ListCollaborationsOutput>
[src]

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

§
listConfiguredTableAssociations(params: ListConfiguredTableAssociationsInput, opts?: client.RequestOptions): Promise<ListConfiguredTableAssociationsOutput>
[src]

Lists configured table associations for a membership.

§
listConfiguredTables(params?: ListConfiguredTablesInput, opts?: client.RequestOptions): Promise<ListConfiguredTablesOutput>
[src]

Lists configured tables.

§
listMembers(params: ListMembersInput, opts?: client.RequestOptions): Promise<ListMembersOutput>
[src]

Lists all members within a collaboration.

§
listMemberships(params?: ListMembershipsInput, opts?: client.RequestOptions): Promise<ListMembershipsOutput>
[src]

Lists all memberships resources within the caller's account.

§
listProtectedQueries(params: ListProtectedQueriesInput, opts?: client.RequestOptions): Promise<ListProtectedQueriesOutput>
[src]

Lists protected queries, sorted by the most recent query.

§
listSchemas(params: ListSchemasInput, opts?: client.RequestOptions): Promise<ListSchemasOutput>
[src]

Lists the schemas for relations within a collaboration.

§
startProtectedQuery(params: StartProtectedQueryInput, opts?: client.RequestOptions): Promise<StartProtectedQueryOutput>
[src]

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

§
updateCollaboration(params: UpdateCollaborationInput, opts?: client.RequestOptions): Promise<UpdateCollaborationOutput>
[src]

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

§
updateConfiguredTable(params: UpdateConfiguredTableInput, opts?: client.RequestOptions): Promise<UpdateConfiguredTableOutput>
[src]

Updates a configured table.

§
updateConfiguredTableAnalysisRule(params: UpdateConfiguredTableAnalysisRuleInput, opts?: client.RequestOptions): Promise<UpdateConfiguredTableAnalysisRuleOutput>
[src]

Updates a configured table analysis rule.

§
updateConfiguredTableAssociation(params: UpdateConfiguredTableAssociationInput, opts?: client.RequestOptions): Promise<UpdateConfiguredTableAssociationOutput>
[src]

Updates a configured table association.

§
updateMembership(params: UpdateMembershipInput, opts?: client.RequestOptions): Promise<UpdateMembershipOutput>
[src]

Updates a membership.

§
updateProtectedQuery(params: UpdateProtectedQueryInput, opts?: client.RequestOptions): Promise<UpdateProtectedQueryOutput>
[src]

Updates the processing of a currently running query.

§Static Properties