Package-level declarations

Types

Link copied to clipboard

Caller does not have sufficient access to perform this action.

Link copied to clipboard
Link copied to clipboard
sealed class AdditionalAnalyses
Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
sealed class AggregationType
Link copied to clipboard
sealed class AnalysisFormat
Link copied to clipboard
sealed class AnalysisMethod
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Defines details for the analysis rule ID mapping table.

Link copied to clipboard

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

Link copied to clipboard
sealed class AnalysisRulePolicy

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

Link copied to clipboard

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

Link copied to clipboard
sealed class AnalysisRuleType
Link copied to clipboard

A relation within an analysis.

Link copied to clipboard
sealed class AnalysisSource

The structure that defines the body of the analysis template.

Link copied to clipboard

The analysis source metadata.

Link copied to clipboard

The analysis template.

Link copied to clipboard

The analysis template artifact.

Link copied to clipboard

The analysis template artifact metadata.

Link copied to clipboard

The analysis template artifacts.

Link copied to clipboard

The metadata of the analysis template.

Link copied to clipboard

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.

Link copied to clipboard

The reasons for the validation results.

Link copied to clipboard
Link copied to clipboard
sealed class AnalysisType
Link copied to clipboard
sealed class AnalyticsEngine
Link copied to clipboard

A reference to a table within Athena.

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

Link copied to clipboard

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

Link copied to clipboard

An error describing why a schema could not be fetched.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Information related to the utilization of resources that have been billed or charged for in a given context, such as a protected job.

Link copied to clipboard

Information related to the utilization of resources that have been billed or charged for in a given context, such as a protected query.

Link copied to clipboard

Base class for all service related exceptions thrown by the CleanRooms client

Link copied to clipboard

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

Link copied to clipboard

The analysis template within a collaboration.

Link copied to clipboard

The metadata of the analysis template within a collaboration.

The configured audience model association within a collaboration.

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

Link copied to clipboard

Defines details for the collaboration ID namespace association.

Provides summary information about the collaboration ID namespace association.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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

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.

Link copied to clipboard
Link copied to clipboard

The metadata of the collaboration.

Link copied to clipboard
class Column

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

Link copied to clipboard

The configuration of the compute resources for an analysis with the Spark analytics engine.

Link copied to clipboard

The configuration details.

Link copied to clipboard

Details about the configured audience model association.

A summary of the configured audience model association.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

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

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

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

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

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Updating or deleting a resource can cause an inconsistent state.

Link copied to clipboard
Link copied to clipboard
sealed class ConsolidatedPolicy

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The settings for client-side encryption for cryptographic computing.

An empty response that indicates a successful delete.

Link copied to clipboard

The empty output for a successful deletion.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

Specifies the unique identifier for your users.

Link copied to clipboard

An array that contains the sensitivity parameters.

Link copied to clipboard

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

The epsilon and noise parameters that you want to preview.

Link copied to clipboard

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

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

Link copied to clipboard

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

Link copied to clipboard

Provides the sensitivity parameters.

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

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

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

Link copied to clipboard

The direct analysis configuration details.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

A reference to a table within an Glue data catalog.

Link copied to clipboard
class Hash

Hash

Link copied to clipboard

The configuration settings for the ID mapping table.

Link copied to clipboard

Describes information about the ID mapping table.

Link copied to clipboard

Provides the input reference configuration for the ID mapping table.

Link copied to clipboard

The input reference properties for the ID mapping table.

Link copied to clipboard

The input source of the ID mapping table.

Link copied to clipboard

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

Link copied to clipboard

Detailed information about the ID mapping table.

Link copied to clipboard

Provides information to create the ID namespace association.

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

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

Detailed information about the ID namespace association input reference properties.

Link copied to clipboard

Detailed information about the ID namespace association.

Link copied to clipboard
sealed class IdNamespaceType
Link copied to clipboard

Unexpected error during processing of request.

Link copied to clipboard

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

Link copied to clipboard
sealed class JoinOperator
Link copied to clipboard
sealed class JoinRequiredOption
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class MemberAbility
Link copied to clipboard

The membership object.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Contains configurations for protected job results.

Contains configurations for protected job results.

Contains configurations for protected query results.

Contains configurations for protected query results.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
sealed class MembershipStatus
Link copied to clipboard

The membership object listed by the request.

Link copied to clipboard

Basic metadata used to construct a new member.

Link copied to clipboard
sealed class MemberStatus
Link copied to clipboard

The member object listed by the request.

Link copied to clipboard

The ML member abilities for a collaboration member.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
sealed class ParameterType
Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
sealed class PrivacyBudget

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

Link copied to clipboard

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

Link copied to clipboard

An object that defines the privacy budget template.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
sealed class PrivacyBudgetType
Link copied to clipboard
sealed class PrivacyImpact

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

Link copied to clipboard

The parameters for an Clean Rooms protected job.

Link copied to clipboard
Link copied to clipboard

The protected job configuration details.

The protected job direct analysis configuration details.

Link copied to clipboard

The protected job error.

The protected job member output configuration input.

The protected job member output configuration output.

Link copied to clipboard
sealed class ProtectedJobOutput

Contains details about the protected job output.

Link copied to clipboard

The protected job output configuration input.

Link copied to clipboard

The protected job output configuration output.

Link copied to clipboard

The parameters for the protected job.

Link copied to clipboard

The protected job receiver configuration.

Link copied to clipboard

Details about the job results.

Link copied to clipboard

The protected job result configuration input.

Link copied to clipboard

The output configuration for a protected job result.

Link copied to clipboard

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

Link copied to clipboard

Contains input information for protected jobs with an S3 output type.

Link copied to clipboard

The output configuration for a protected job's S3 output.

Link copied to clipboard

Details about the member who received the job result.

Link copied to clipboard

Contains statistics about the execution of the protected job.

Link copied to clipboard
sealed class ProtectedJobStatus
Link copied to clipboard

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

Link copied to clipboard
sealed class ProtectedJobType
Link copied to clipboard

The parameters for an Clean Rooms protected query.

Link copied to clipboard

Contains the output information for a protected query with a distribute output configuration.

Specifies the configuration for distributing protected query results to multiple receivers, including S3 and collaboration members.

Specifies where you'll distribute the results of your protected query. You must configure either an S3 destination or a collaboration member destination.

Link copied to clipboard

Details of errors thrown by the protected query.

Link copied to clipboard

Contains configuration details for the protected query member output.

Link copied to clipboard

Contains details about the protected query output.

Link copied to clipboard

Contains configuration details for protected query output.

Link copied to clipboard

Details about the query results.

Link copied to clipboard

Contains configurations for protected query results.

Link copied to clipboard

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

Link copied to clipboard

Contains the configuration to write the query results to S3.

Link copied to clipboard

Details about the member who received the query result.

Link copied to clipboard

The parameters for the SQL type Protected Query.

Link copied to clipboard

Contains statistics about the execution of the protected query.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
sealed class ProtectedQueryType
Link copied to clipboard

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

Link copied to clipboard
sealed class QueryConstraint

Provides any necessary query constraint information.

Link copied to clipboard

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

Link copied to clipboard

The receiver configuration for a protected query.

Link copied to clipboard

Request references a resource which does not exist.

Link copied to clipboard
sealed class ResourceType
Link copied to clipboard
sealed class ResultFormat
Link copied to clipboard

The S3 location.

Link copied to clipboard
sealed class ScalarFunctions
Link copied to clipboard
class Schema

A schema is a relation within a collaboration.

Link copied to clipboard

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.

Link copied to clipboard
sealed class SchemaConfiguration
Link copied to clipboard
sealed class SchemaStatus
Link copied to clipboard

Information about the schema status.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

The schema summary for the objects listed by the request.

Link copied to clipboard
sealed class SchemaType
Link copied to clipboard

Information about the schema type properties.

Link copied to clipboard
Link copied to clipboard

Request denied because service quota has been exceeded.

Link copied to clipboard

A reference to a table within Snowflake.

Link copied to clipboard

The schema of a Snowflake table.

Link copied to clipboard

The Snowflake table schema.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class TableReference

A pointer to the dataset that underlies this table.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Request was denied due to request throttling.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The input fails to satisfy the specified constraints.

Link copied to clipboard

Describes validation errors for specific input parameters.

Link copied to clipboard
Link copied to clipboard

The configuration of the compute resources for workers running an analysis with the Clean Rooms SQL analytics engine.

Link copied to clipboard
sealed class WorkerComputeType