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

Usage

import * as mod from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/cleanrooms.ts?docs=full";

§Classes

CleanRooms

§Interfaces

AggregateColumn

Column in configured table that can be used in aggregate function in query.

AggregationConstraint

Constraint on query output removing output rows that do not meet a minimum number of distinct values of a specified column.

AnalysisParameter

Optional. The member who can query can provide this placeholder for a literal data value in an analysis template.

AnalysisRule

A specification about how data from the configured table can be used in a query.

AnalysisRuleAggregation

A type of analysis rule that enables query structure and specified queries that produce aggregate statistics.

AnalysisRuleCustom

A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy.

AnalysisRuleIdMappingTable

Defines details for the analysis rule ID mapping table.

AnalysisRuleList

A type of analysis rule that enables row-level analysis.

AnalysisRulePolicy

Controls on the query specifications that can be run on configured table.

AnalysisRulePolicyV1

Controls on the query specifications that can be run on configured table.

AnalysisSchema

A relation within an analysis.

AnalysisSource

The structure that defines the body of the analysis template.

AnalysisTemplate

The analysis template.

AnalysisTemplateSummary

The metadata of the analysis template.

AnalysisTemplateValidationStatusDetail

The status details of the analysis template validation. Clean Rooms Differential Privacy uses a general-purpose query structure to support complex SQL queries and validates whether an analysis template fits that general-purpose query structure. Validation is performed when analysis templates are created and fetched. Because analysis templates are immutable by design, we recommend that you create analysis templates after you associate the configured tables with their analysis rule to your collaboration.

AnalysisTemplateValidationStatusReason

The reasons for the validation results.

BatchGetCollaborationAnalysisTemplateError

Details of errors thrown by the call to retrieve multiple analysis templates within a collaboration by their identifiers.

BatchGetCollaborationAnalysisTemplateInput
BatchGetCollaborationAnalysisTemplateOutput
BatchGetSchemaAnalysisRuleError

An error that describes why a schema could not be fetched.

BatchGetSchemaAnalysisRuleInput
BatchGetSchemaAnalysisRuleOutput
BatchGetSchemaError

An error describing why a schema could not be fetched.

BatchGetSchemaInput
BatchGetSchemaOutput
Collaboration

The multi-party data share environment. The collaboration contains metadata about its purpose and participants.

CollaborationAnalysisTemplate

The analysis template within a collaboration.

CollaborationAnalysisTemplateSummary

The metadata of the analysis template within a collaboration.

CollaborationConfiguredAudienceModelAssociation

The configured audience model association within a collaboration.

CollaborationConfiguredAudienceModelAssociationSummary

A summary of the configured audience model association in the collaboration.

CollaborationIdNamespaceAssociation

Defines details for the collaboration ID namespace association.

CollaborationIdNamespaceAssociationSummary

Provides summary information about the collaboration ID namespace association.

CollaborationPrivacyBudgetSummary

A summary of the collaboration privacy budgets. This summary includes the collaboration information, creation information, epsilon provided, and utility in terms of aggregations.

CollaborationPrivacyBudgetTemplate

An array that specifies the information for a collaboration's privacy budget template.

CollaborationPrivacyBudgetTemplateSummary

A summary of the collaboration's privacy budget template. This summary includes information about who created the privacy budget template and what collaborations it belongs to.

CollaborationSummary

The metadata of the collaboration.

Column

A column within a schema relation, derived from the underlying Glue table.

ConfigurationDetails

The configuration details.

ConfiguredAudienceModelAssociation

Details about the configured audience model association.

ConfiguredAudienceModelAssociationSummary

A summary of the configured audience model association.

ConfiguredTable

A table that has been configured for use in a collaboration.

ConfiguredTableAnalysisRule

A configured table analysis rule, which limits how data for this table can be used.

ConfiguredTableAnalysisRulePolicy

Controls on the query specifications that can be run on a configured table.

ConfiguredTableAnalysisRulePolicyV1

Controls on the query specifications that can be run on a configured table.

ConfiguredTableAssociation

A configured table association links a configured table to a collaboration.

ConfiguredTableAssociationAnalysisRule

An analysis rule for a configured table association. This analysis rule specifies how data from the table can be used within its associated collaboration. In the console, the ConfiguredTableAssociationAnalysisRule is referred to as the collaboration analysis rule.

ConfiguredTableAssociationAnalysisRuleAggregation

The configured table association analysis rule applied to a configured table with the aggregation analysis rule.

ConfiguredTableAssociationAnalysisRuleCustom

The configured table association analysis rule applied to a configured table with the custom analysis rule.

ConfiguredTableAssociationAnalysisRuleList

The configured table association analysis rule applied to a configured table with the list analysis rule.

ConfiguredTableAssociationAnalysisRulePolicy

Controls on the query specifications that can be run on an associated configured table.

ConfiguredTableAssociationAnalysisRulePolicyV1

Controls on the query specifications that can be run on an associated configured table.

ConfiguredTableAssociationSummary

The configured table association summary for the objects listed by the request.

ConfiguredTableSummary

The configured table summary for the objects listed by the request.

CreateAnalysisTemplateInput
CreateAnalysisTemplateOutput
CreateCollaborationInput
CreateCollaborationOutput
CreateConfiguredAudienceModelAssociationInput
CreateConfiguredAudienceModelAssociationOutput
CreateConfiguredTableAnalysisRuleInput
CreateConfiguredTableAnalysisRuleOutput
CreateConfiguredTableAssociationAnalysisRuleInput
CreateConfiguredTableAssociationAnalysisRuleOutput
CreateConfiguredTableAssociationInput
CreateConfiguredTableAssociationOutput
CreateConfiguredTableInput
CreateConfiguredTableOutput
CreateIdMappingTableInput
CreateIdMappingTableOutput
CreateIdNamespaceAssociationInput
CreateIdNamespaceAssociationOutput
CreateMembershipInput
CreateMembershipOutput
CreatePrivacyBudgetTemplateInput
CreatePrivacyBudgetTemplateOutput
DataEncryptionMetadata

The settings for client-side encryption for cryptographic computing.

DeleteAnalysisTemplateInput
DeleteCollaborationInput
DeleteConfiguredAudienceModelAssociationInput
DeleteConfiguredTableAnalysisRuleInput
DeleteConfiguredTableAssociationAnalysisRuleInput
DeleteConfiguredTableAssociationInput
DeleteConfiguredTableInput
DeleteIdMappingTableInput
DeleteIdNamespaceAssociationInput
DeleteMemberInput
DeleteMembershipInput
DeletePrivacyBudgetTemplateInput
DifferentialPrivacyColumn

Specifies the name of the column that contains the unique identifier of your users, whose privacy you want to protect.

DifferentialPrivacyConfiguration

Specifies the unique identifier for your users.

DifferentialPrivacyParameters

An array that contains the sensitivity parameters.

DifferentialPrivacyPreviewAggregation

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

DifferentialPrivacyPreviewParametersInput

The epsilon and noise parameters that you want to preview.

DifferentialPrivacyPrivacyBudget

Specifies the configured epsilon value and the utility in terms of total aggregations, as well as the remaining aggregations available.

DifferentialPrivacyPrivacyBudgetAggregation

Information about the total number of aggregations, as well as the remaining aggregations.

DifferentialPrivacyPrivacyImpact

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

DifferentialPrivacySensitivityParameters

Provides the sensitivity parameters.

DifferentialPrivacyTemplateParametersInput

The epsilon and noise parameter values that you want to use for the differential privacy template.

DifferentialPrivacyTemplateParametersOutput

The epsilon and noise parameter values that were used for the differential privacy template.

DifferentialPrivacyTemplateUpdateParameters

The epsilon and noise parameter values that you want to update in the differential privacy template.

DirectAnalysisConfigurationDetails

The direct analysis configuration details.

Document
GetAnalysisTemplateInput
GetAnalysisTemplateOutput
GetCollaborationAnalysisTemplateInput
GetCollaborationAnalysisTemplateOutput
GetCollaborationConfiguredAudienceModelAssociationInput
GetCollaborationConfiguredAudienceModelAssociationOutput
GetCollaborationIdNamespaceAssociationInput
GetCollaborationIdNamespaceAssociationOutput
GetCollaborationInput
GetCollaborationOutput
GetCollaborationPrivacyBudgetTemplateInput
GetCollaborationPrivacyBudgetTemplateOutput
GetConfiguredAudienceModelAssociationInput
GetConfiguredAudienceModelAssociationOutput
GetConfiguredTableAnalysisRuleInput
GetConfiguredTableAnalysisRuleOutput
GetConfiguredTableAssociationAnalysisRuleInput
GetConfiguredTableAssociationAnalysisRuleOutput
GetConfiguredTableAssociationInput
GetConfiguredTableAssociationOutput
GetConfiguredTableInput
GetConfiguredTableOutput
GetIdMappingTableInput
GetIdMappingTableOutput
GetIdNamespaceAssociationInput
GetIdNamespaceAssociationOutput
GetMembershipInput
GetMembershipOutput
GetPrivacyBudgetTemplateInput
GetPrivacyBudgetTemplateOutput
GetProtectedQueryInput
GetProtectedQueryOutput
GetSchemaAnalysisRuleInput
GetSchemaAnalysisRuleOutput
GetSchemaInput
GetSchemaOutput
GlueTableReference

A reference to a table within an Glue data catalog.

IdMappingConfig

The configuration settings for the ID mapping table.

IdMappingTable

Describes information about the ID mapping table.

IdMappingTableInputReferenceConfig

Provides the input reference configuration for the ID mapping table.

IdMappingTableInputReferenceProperties

The input reference properties for the ID mapping table.

IdMappingTableInputSource

The input source of the ID mapping table.

IdMappingTableSchemaTypeProperties

Additional properties that are specific to the type of the associated schema.

IdMappingTableSummary

Detailed information about the ID mapping table.

IdNamespaceAssociation

Provides information to create the ID namespace association.

IdNamespaceAssociationInputReferenceConfig

Provides the information for the ID namespace association input reference configuration.

IdNamespaceAssociationInputReferenceProperties

Provides the information for the ID namespace association input reference properties.

IdNamespaceAssociationInputReferencePropertiesSummary

Detailed information about the ID namespace association input reference properties.

IdNamespaceAssociationSummary

Detailed information about the ID namespace association.

ListAnalysisTemplatesInput
ListAnalysisTemplatesOutput
ListCollaborationAnalysisTemplatesInput
ListCollaborationAnalysisTemplatesOutput
ListCollaborationConfiguredAudienceModelAssociationsInput
ListCollaborationConfiguredAudienceModelAssociationsOutput
ListCollaborationIdNamespaceAssociationsInput
ListCollaborationIdNamespaceAssociationsOutput
ListCollaborationPrivacyBudgetsInput
ListCollaborationPrivacyBudgetsOutput
ListCollaborationPrivacyBudgetTemplatesInput
ListCollaborationPrivacyBudgetTemplatesOutput
ListCollaborationsInput
ListCollaborationsOutput
ListConfiguredAudienceModelAssociationsInput
ListConfiguredAudienceModelAssociationsOutput
ListConfiguredTableAssociationsInput
ListConfiguredTableAssociationsOutput
ListConfiguredTablesInput
ListConfiguredTablesOutput
ListIdMappingTablesInput
ListIdMappingTablesOutput
ListIdNamespaceAssociationsInput
ListIdNamespaceAssociationsOutput
ListMembershipsInput
ListMembershipsOutput
ListMembersInput
ListMembersOutput
ListPrivacyBudgetsInput
ListPrivacyBudgetsOutput
ListPrivacyBudgetTemplatesInput
ListPrivacyBudgetTemplatesOutput
ListProtectedQueriesInput
ListProtectedQueriesOutput
ListSchemasInput
ListSchemasOutput
ListTagsForResourceInput
ListTagsForResourceOutput
Membership

The membership object.

MembershipPaymentConfiguration

An object representing the payment responsibilities accepted by the collaboration member.

MembershipProtectedQueryOutputConfiguration

Contains configurations for protected query results.

MembershipProtectedQueryResultConfiguration

Contains configurations for protected query results.

MembershipQueryComputePaymentConfig

An object representing the payment responsibilities accepted by the collaboration member for query compute costs.

MembershipSummary

The membership object listed by the request.

MemberSpecification

Basic metadata used to construct a new member.

MemberSummary

The member object listed by the request.

PaymentConfiguration

An object representing the collaboration member's payment responsibilities set by the collaboration creator.

PopulateIdMappingTableInput
PopulateIdMappingTableOutput
PreviewPrivacyImpactInput
PreviewPrivacyImpactOutput
PreviewPrivacyImpactParametersInput

Specifies the updated epsilon and noise parameters to preview. The preview allows you to see how the maximum number of each type of aggregation function would change with the new parameters.

PrivacyBudget

The epsilon parameter value and number of each aggregation function that you can perform.

PrivacyBudgetSummary

An array that summaries the specified privacy budget. This summary includes collaboration information, creation information, membership information, and privacy budget information.

PrivacyBudgetTemplate

An object that defines the privacy budget template.

PrivacyBudgetTemplateParametersInput

The epsilon and noise parameters that you want to use for the privacy budget template.

PrivacyBudgetTemplateParametersOutput

The epsilon and noise parameters that were used in the privacy budget template.

PrivacyBudgetTemplateSummary

A summary of the privacy budget template. The summary includes membership information, collaboration information, and creation information.

PrivacyBudgetTemplateUpdateParameters

The epsilon and noise parameters that you want to update in the privacy budget template.

PrivacyImpact

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

ProtectedQuery

The parameters for an Clean Rooms protected query.

ProtectedQueryError

Details of errors thrown by the protected query.

ProtectedQueryMemberOutputConfiguration

Contains configuration details for the protected query member output.

ProtectedQueryOutput

Contains details about the protected query output.

ProtectedQueryOutputConfiguration

Contains configuration details for protected query output.

ProtectedQueryResult

Details about the query results.

ProtectedQueryResultConfiguration

Contains configurations for protected query results.

ProtectedQueryS3Output

Contains output information for protected queries with an S3 output type.

ProtectedQueryS3OutputConfiguration

Contains the configuration to write the query results to S3.

ProtectedQuerySingleMemberOutput

Details about the member who received the query result.

ProtectedQuerySQLParameters

The parameters for the SQL type Protected Query.

ProtectedQueryStatistics

Contains statistics about the execution of the protected query.

ProtectedQuerySummary

The protected query summary for the objects listed by the request.

QueryComputePaymentConfig

An object representing the collaboration member's payment responsibilities set by the collaboration creator for query compute costs.

QueryConstraint

Provides any necessary query constraint information.

QueryConstraintRequireOverlap

Provides the name of the columns that are required to overlap.

ReceiverConfiguration

The receiver configuration for a protected query.

Schema

A schema is a relation within a collaboration.

SchemaAnalysisRuleRequest

Defines the information that's necessary to retrieve an analysis rule schema. Schema analysis rules are uniquely identified by a combination of the schema name and the analysis rule type for a given collaboration.

SchemaStatusDetail

Information about the schema status.

SchemaStatusReason

A reason why the schema status is set to its current value.

SchemaSummary

The schema summary for the objects listed by the request.

SchemaTypeProperties

Information about the schema type properties.

StartProtectedQueryInput
StartProtectedQueryOutput
TableReference

A pointer to the dataset that underlies this table. Currently, this can only be an Glue table.

TagResourceInput
UntagResourceInput
UpdateAnalysisTemplateInput
UpdateAnalysisTemplateOutput
UpdateCollaborationInput
UpdateCollaborationOutput
UpdateConfiguredAudienceModelAssociationInput
UpdateConfiguredAudienceModelAssociationOutput
UpdateConfiguredTableAnalysisRuleInput
UpdateConfiguredTableAnalysisRuleOutput
UpdateConfiguredTableAssociationAnalysisRuleInput
UpdateConfiguredTableAssociationAnalysisRuleOutput
UpdateConfiguredTableAssociationInput
UpdateConfiguredTableAssociationOutput
UpdateConfiguredTableInput
UpdateConfiguredTableOutput
UpdateIdMappingTableInput
UpdateIdMappingTableOutput
UpdateIdNamespaceAssociationInput
UpdateIdNamespaceAssociationOutput
UpdateMembershipInput
UpdateMembershipOutput
UpdatePrivacyBudgetTemplateInput
UpdatePrivacyBudgetTemplateOutput
UpdateProtectedQueryInput
UpdateProtectedQueryOutput

§Type Aliases

AdditionalAnalyses
AggregateFunctionName
AggregationType
AnalysisFormat
AnalysisMethod
AnalysisRuleType
AnalysisTemplateValidationStatus
AnalysisTemplateValidationType
AnalysisType
CollaborationQueryLogStatus
ConfiguredTableAnalysisRuleType
ConfiguredTableAssociationAnalysisRuleType
DifferentialPrivacyAggregationType
FilterableMemberStatus
IdNamespaceType
JoinOperator
JoinRequiredOption
MemberAbility
MembershipQueryLogStatus
MembershipStatus
MemberStatus
ParameterType
PrivacyBudgetTemplateAutoRefresh
PrivacyBudgetType
ProtectedQueryStatus
ProtectedQueryType
ResultFormat
ScalarFunctions
SchemaConfiguration
SchemaStatus
SchemaStatusReasonCode
SchemaType
TargetProtectedQueryStatus