Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Access
Budget Controls and tracks usage limits for associated configured tables within a collaboration across queries and job. Supports both period-based budgets that can renew (daily, weekly, or monthly) and fixed lifetime budgets. Contains the resource ARN, remaining budget information, and up to two budget configurations (period-based and lifetime). By default, table usage is unlimited unless a budget is configured.
- Access
Budget Details Detailed information about an access budget including time bounds, budget allocation, and configuration settings.
- Access
Budgets Privacy Template Parameters Input Input parameters for privacy budget templates that support access budgets functionality, enabling enhanced budget management capabilities.
- Access
Budgets Privacy Template Parameters Output Output parameters for privacy budget templates with access budgets support, containing the configured budget information.
- Access
Budgets Privacy Template Update Parameters Update parameters for privacy budget templates with access budgets functionality, allowing modification of existing budget configurations.
- Aggregate
Column Column in configured table that can be used in aggregate function in query.
- Aggregation
Constraint Constraint on query output removing output rows that do not meet a minimum number of distinct values of a specified column.
- Analysis
Parameter Optional. The member who can query can provide this placeholder for a literal data value in an analysis template.
- Analysis
Rule A specification about how data from the configured table can be used in a query.
- Analysis
Rule Aggregation A type of analysis rule that enables query structure and specified queries that produce aggregate statistics.
- Analysis
Rule Custom A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy.
- Analysis
Rule IdMapping Table Defines details for the analysis rule ID mapping table.
- Analysis
Rule List A type of analysis rule that enables row-level analysis.
- Analysis
Schema A relation within an analysis.
- Analysis
Template The analysis template.
- Analysis
Template Artifact The analysis template artifact.
- Analysis
Template Artifact Metadata The analysis template artifact metadata.
- Analysis
Template Artifacts The analysis template artifacts.
- Analysis
Template Summary The metadata of the analysis template.
- Analysis
Template Validation Status Detail 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.
For more information, see https://docs.aws.amazon.com/clean-rooms/latest/userguide/analysis-rules-custom.html#custom-diff-privacy.
- Analysis
Template Validation Status Reason The reasons for the validation results.
- Athena
Table Reference A reference to a table within Athena.
- Batch
GetCollaboration Analysis Template Error Details of errors thrown by the call to retrieve multiple analysis templates within a collaboration by their identifiers.
- Batch
GetSchema Analysis Rule Error An error that describes why a schema could not be fetched.
- Batch
GetSchema Error An error describing why a schema could not be fetched.
- Billed
JobResource Utilization Information related to the utilization of resources that have been billed or charged for in a given context, such as a protected job.
- Billed
Resource Utilization Information related to the utilization of resources that have been billed or charged for in a given context, such as a protected query.
- Budget
Parameter Individual budget parameter configuration that defines specific budget allocation settings for access budgets.
- Change
Represents a single change within a collaboration change request, containing the change identifier and specification.
- Change
Input Specifies a change to apply to a collaboration.
- Collaboration
The multi-party data share environment. The collaboration contains metadata about its purpose and participants.
- Collaboration
Analysis Template The analysis template within a collaboration.
- Collaboration
Analysis Template Summary The metadata of the analysis template within a collaboration.
- Collaboration
Change Request Represents a request to modify a collaboration. Change requests enable structured modifications to collaborations after they have been created.
- Collaboration
Change Request Summary Summary information about a collaboration change request.
- Collaboration
Configured Audience Model Association The configured audience model association within a collaboration.
- Collaboration
Configured Audience Model Association Summary A summary of the configured audience model association in the collaboration.
- Collaboration
IdNamespace Association Defines details for the collaboration ID namespace association.
- Collaboration
IdNamespace Association Summary Provides summary information about the collaboration ID namespace association.
- Collaboration
Privacy Budget Summary A summary of the collaboration privacy budgets. This summary includes the collaboration information, creation information, epsilon provided, and utility in terms of aggregations.
- Collaboration
Privacy Budget Template An array that specifies the information for a collaboration's privacy budget template.
- Collaboration
Privacy Budget Template Summary 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.
- Collaboration
Summary The metadata of the collaboration.
- Column
A column within a schema relation, derived from the underlying table.
- Column
Classification Details Contains classification information for data columns, including mappings that specify how columns should be handled during synthetic data generation and privacy analysis.
- Configured
Audience Model Association Details about the configured audience model association.
- Configured
Audience Model Association Summary A summary of the configured audience model association.
- Configured
Table A table that has been configured for use in a collaboration.
- Configured
Table Analysis Rule A configured table analysis rule, which limits how data for this table can be used.
- Configured
Table Association A configured table association links a configured table to a collaboration.
- Configured
Table Association Analysis Rule 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
ConfiguredTableAssociationAnalysisRuleis referred to as the collaboration analysis rule.- Configured
Table Association Analysis Rule Aggregation The configured table association analysis rule applied to a configured table with the aggregation analysis rule.
- Configured
Table Association Analysis Rule Custom The configured table association analysis rule applied to a configured table with the custom analysis rule.
- Configured
Table Association Analysis Rule List The configured table association analysis rule applied to a configured table with the list analysis rule.
- Configured
Table Association Summary The configured table association summary for the objects listed by the request.
- Configured
Table Summary The configured table summary for the objects listed by the request.
- Consolidated
Policy Aggregation Controls on the analysis specifications that can be run on a configured table.
- Consolidated
Policy Custom Controls on the analysis specifications that can be run on a configured table.
- Consolidated
Policy List Controls on the analysis specifications that can be run on a configured table.
- Data
Encryption Metadata The settings for client-side encryption for cryptographic computing.
- Differential
Privacy Column Specifies the name of the column that contains the unique identifier of your users, whose privacy you want to protect.
- Differential
Privacy Configuration Specifies the unique identifier for your users.
- Differential
Privacy Parameters An array that contains the sensitivity parameters.
- Differential
Privacy Preview Aggregation Provides an estimate of the number of aggregation functions that the member who can query can run given the epsilon and noise parameters.
- Differential
Privacy Preview Parameters Input The epsilon and noise parameters that you want to preview.
- Differential
Privacy Privacy Budget Specifies the configured epsilon value and the utility in terms of total aggregations, as well as the remaining aggregations available.
- Differential
Privacy Privacy Budget Aggregation Information about the total number of aggregations, as well as the remaining aggregations.
- Differential
Privacy Privacy Impact Information about the number of aggregation functions that the member who can query can run given the epsilon and noise parameters.
- Differential
Privacy Sensitivity Parameters Provides the sensitivity parameters.
- Differential
Privacy Template Parameters Input The epsilon and noise parameter values that you want to use for the differential privacy template.
- Differential
Privacy Template Parameters Output The epsilon and noise parameter values that were used for the differential privacy template.
- Differential
Privacy Template Update Parameters The epsilon and noise parameter values that you want to update in the differential privacy template.
- Direct
Analysis Configuration Details The direct analysis configuration details.
- Error
Message Configuration A structure that defines the level of detail included in error messages returned by PySpark jobs. This configuration allows you to control the verbosity of error messages to help with troubleshooting PySpark jobs while maintaining appropriate security controls.
- Glue
Table Reference A reference to a table within an Glue data catalog.
- Hash
Hash
- IdMapping
Config The configuration settings for the ID mapping table.
- IdMapping
Table Describes information about the ID mapping table.
- IdMapping
Table Input Reference Config Provides the input reference configuration for the ID mapping table.
- IdMapping
Table Input Reference Properties The input reference properties for the ID mapping table.
- IdMapping
Table Input Source The input source of the ID mapping table.
- IdMapping
Table Schema Type Properties Additional properties that are specific to the type of the associated schema.
- IdMapping
Table Summary Detailed information about the ID mapping table.
- IdNamespace
Association Provides information to create the ID namespace association.
- IdNamespace
Association Input Reference Config Provides the information for the ID namespace association input reference configuration.
- IdNamespace
Association Input Reference Properties Provides the information for the ID namespace association input reference properties.
- IdNamespace
Association Input Reference Properties Summary Detailed information about the ID namespace association input reference properties.
- IdNamespace
Association Summary Detailed information about the ID namespace association.
- JobCompute
Payment Config An object representing the collaboration member's payment responsibilities set by the collaboration creator for query and job compute costs.
- Member
Change Specification Specifies changes to collaboration membership, including adding new members with their abilities and display names.
- Member
Specification Basic metadata used to construct a new member.
- Member
Summary The member object listed by the request.
- Membership
The membership object.
- Membership
JobCompute Payment Config An object representing the payment responsibilities accepted by the collaboration member for query and job compute costs.
- Membership
MlPayment Config An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.
- Membership
Model Inference Payment Config An object representing the collaboration member's model inference payment responsibilities set by the collaboration creator.
- Membership
Model Training Payment Config An object representing the collaboration member's model training payment responsibilities set by the collaboration creator.
- Membership
Payment Configuration An object representing the payment responsibilities accepted by the collaboration member.
- Membership
Protected JobResult Configuration Contains configurations for protected job results.
- Membership
Protected Query Result Configuration Contains configurations for protected query results.
- Membership
Query Compute Payment Config An object representing the payment responsibilities accepted by the collaboration member for query compute costs.
- Membership
Summary The membership object listed by the request.
- Membership
Synthetic Data Generation Payment Config Configuration for payment for synthetic data generation in a membership.
- MlMember
Abilities The ML member abilities for a collaboration member.
- MlPayment
Config An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.
- MlSynthetic
Data Parameters Parameters that control the generation of synthetic data for machine learning, including privacy settings and column classification details.
- Model
Inference Payment Config An object representing the collaboration member's model inference payment responsibilities set by the collaboration creator.
- Model
Training Payment Config An object representing the collaboration member's model training payment responsibilities set by the collaboration creator.
- Payment
Configuration An object representing the collaboration member's payment responsibilities set by the collaboration creator.
- Privacy
Budget Summary An array that summaries the specified privacy budget. This summary includes collaboration information, creation information, membership information, and privacy budget information.
- Privacy
Budget Template An object that defines the privacy budget template.
- Privacy
Budget Template Summary A summary of the privacy budget template. The summary includes membership information, collaboration information, and creation information.
- Protected
Job The parameters for an Clean Rooms protected job.
- Protected
JobDirect Analysis Configuration Details The protected job direct analysis configuration details.
- Protected
JobError The protected job error.
- Protected
JobMember Output Configuration Input The protected job member output configuration input.
- Protected
JobMember Output Configuration Output The protected job member output configuration output.
- Protected
JobParameters The parameters for the protected job.
- Protected
JobReceiver Configuration The protected job receiver configuration.
- Protected
JobResult Details about the job results.
- Protected
JobResult Configuration Input The protected job result configuration input.
- Protected
JobResult Configuration Output The output configuration for a protected job result.
- Protected
JobS3 Output Contains output information for protected jobs with an S3 output type.
- Protected
JobS3 Output Configuration Input Contains input information for protected jobs with an S3 output type.
- Protected
JobS3 Output Configuration Output The output configuration for a protected job's S3 output.
- Protected
JobSingle Member Output Details about the member who received the job result.
- Protected
JobStatistics Contains statistics about the execution of the protected job.
- Protected
JobSummary The protected job summary for the objects listed by the request.
- Protected
JobWorker Compute Configuration The configuration of the compute resources for a PySpark job.
- Protected
Query The parameters for an Clean Rooms protected query.
- Protected
Query Distribute Output Contains the output information for a protected query with a distribute output configuration.
This output type allows query results to be distributed to multiple receivers, including S3 and collaboration members. It is only available for queries using the Spark analytics engine.
- Protected
Query Distribute Output Configuration Specifies the configuration for distributing protected query results to multiple receivers, including S3 and collaboration members.
- Protected
Query Error Details of errors thrown by the protected query.
- Protected
Query Member Output Configuration Contains configuration details for the protected query member output.
- Protected
Query Result Details about the query results.
- Protected
Query Result Configuration Contains configurations for protected query results.
- Protected
Query S3Output Contains output information for protected queries with an S3 output type.
- Protected
Query S3Output Configuration Contains the configuration to write the query results to S3.
- Protected
Query Single Member Output Details about the member who received the query result.
- Protected
Query SqlParameters The parameters for the SQL type Protected Query.
- Protected
Query Statistics Contains statistics about the execution of the protected query.
- Protected
Query Summary The protected query summary for the objects listed by the request.
- Query
Compute Payment Config An object representing the collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
- Query
Constraint Require Overlap Provides the name of the columns that are required to overlap.
- Receiver
Configuration The receiver configuration for a protected query.
- S3Location
The S3 location.
- Schema
A schema is a relation within a collaboration.
- Schema
Analysis Rule Request 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.
- Schema
Status Detail Information about the schema status.
A status of
READYmeans that based on the schema analysis rule, queries of the given analysis rule type are properly configured to run queries on this schema.- Schema
Status Reason A reason why the schema status is set to its current value.
- Schema
Summary The schema summary for the objects listed by the request.
- Snowflake
Table Reference A reference to a table within Snowflake.
- Snowflake
Table Schema V1 The Snowflake table schema.
- Synthetic
Data Column Properties Properties that define how a specific data column should be handled during synthetic data generation, including its name, type, and role in predictive modeling.
- Synthetic
Data Generation Payment Config Payment configuration for synthetic data generation.
- Validation
Exception Field Describes validation errors for specific input parameters.
- Worker
Compute Configuration The configuration of the compute resources for workers running an analysis with the Clean Rooms SQL analytics engine.
Enums§
- Access
Budget Type - When writing a match expression against
AccessBudgetType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Access
Denied Exception Reason - When writing a match expression against
AccessDeniedExceptionReason, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Additional
Analyses - When writing a match expression against
AdditionalAnalyses, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Aggregate
Function Name - When writing a match expression against
AggregateFunctionName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Aggregation
Type - When writing a match expression against
AggregationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Analysis
Format - When writing a match expression against
AnalysisFormat, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Analysis
Method - When writing a match expression against
AnalysisMethod, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Analysis
Rule Policy Controls on the query specifications that can be run on configured table.
- Analysis
Rule Policy V1 Controls on the query specifications that can be run on configured table.
- Analysis
Rule Type - When writing a match expression against
AnalysisRuleType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Analysis
Source The structure that defines the body of the analysis template.
- Analysis
Source Metadata The analysis source metadata.
- Analysis
Template Validation Status - When writing a match expression against
AnalysisTemplateValidationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Analysis
Template Validation Type - When writing a match expression against
AnalysisTemplateValidationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Analysis
Type - When writing a match expression against
AnalysisType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Analytics
Engine - When writing a match expression against
AnalyticsEngine, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Auto
Approved Change Type - When writing a match expression against
AutoApprovedChangeType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Auto
Refresh Mode - When writing a match expression against
AutoRefreshMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Change
Request Status - When writing a match expression against
ChangeRequestStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Change
Specification A union that contains the specification details for different types of changes.
- Change
Specification Type - When writing a match expression against
ChangeSpecificationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Change
Type - When writing a match expression against
ChangeType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Collaboration
JobLog Status - When writing a match expression against
CollaborationJobLogStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Collaboration
Query LogStatus - When writing a match expression against
CollaborationQueryLogStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Commercial
Region - When writing a match expression against
CommercialRegion, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Compute
Configuration The configuration of the compute resources for an analysis with the Spark analytics engine.
- Configuration
Details The configuration details.
- Configured
Table Analysis Rule Policy Controls on the query specifications that can be run on a configured table.
- Configured
Table Analysis Rule Policy V1 Controls on the query specifications that can be run on a configured table.
- Configured
Table Analysis Rule Type - When writing a match expression against
ConfiguredTableAnalysisRuleType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Configured
Table Association Analysis Rule Policy Controls on the query specifications that can be run on an associated configured table.
- Configured
Table Association Analysis Rule Policy V1 Controls on the query specifications that can be run on an associated configured table.
- Configured
Table Association Analysis Rule Type - When writing a match expression against
ConfiguredTableAssociationAnalysisRuleType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Conflict
Exception Reason - When writing a match expression against
ConflictExceptionReason, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Consolidated
Policy Controls on the analysis specifications that can be run on a configured table.
- Consolidated
Policy V1 Controls on the analysis specifications that can be run on a configured table.
- Custom
MlMember Ability - When writing a match expression against
CustomMlMemberAbility, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Differential
Privacy Aggregation Type - When writing a match expression against
DifferentialPrivacyAggregationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Error
Message Type - When writing a match expression against
ErrorMessageType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Filterable
Member Status - When writing a match expression against
FilterableMemberStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - IdNamespace
Type - When writing a match expression against
IdNamespaceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - JobType
- When writing a match expression against
JobType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Join
Operator - When writing a match expression against
JoinOperator, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Join
Required Option - When writing a match expression against
JoinRequiredOption, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Member
Ability - When writing a match expression against
MemberAbility, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Member
Status - When writing a match expression against
MemberStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Membership
JobLog Status - When writing a match expression against
MembershipJobLogStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Membership
Protected JobOutput Configuration Contains configurations for protected job results.
- Membership
Protected Query Output Configuration Contains configurations for protected query results.
- Membership
Query LogStatus - When writing a match expression against
MembershipQueryLogStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Membership
Status - When writing a match expression against
MembershipStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Parameter
Type - When writing a match expression against
ParameterType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Preview
Privacy Impact Parameters Input 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.
- Privacy
Budget The epsilon parameter value and number of each aggregation function that you can perform.
- Privacy
Budget Template Auto Refresh - When writing a match expression against
PrivacyBudgetTemplateAutoRefresh, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Privacy
Budget Template Parameters Input The epsilon and noise parameters that you want to use for the privacy budget template.
- Privacy
Budget Template Parameters Output The epsilon and noise parameters that were used in the privacy budget template.
- Privacy
Budget Template Update Parameters The epsilon and noise parameters that you want to update in the privacy budget template.
- Privacy
Budget Type - When writing a match expression against
PrivacyBudgetType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Privacy
Impact Provides an estimate of the number of aggregation functions that the member who can query can run given the epsilon and noise parameters.
- Protected
JobAnalysis Type - When writing a match expression against
ProtectedJobAnalysisType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Protected
JobCompute Configuration The configuration of the compute resources for a PySpark job.
- Protected
JobConfiguration Details The protected job configuration details.
- Protected
JobOutput Contains details about the protected job output.
- Protected
JobOutput Configuration Input The protected job output configuration input.
- Protected
JobOutput Configuration Output The protected job output configuration output.
- Protected
JobStatus - When writing a match expression against
ProtectedJobStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Protected
JobType - When writing a match expression against
ProtectedJobType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Protected
JobWorker Compute Type - When writing a match expression against
ProtectedJobWorkerComputeType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Protected
Query Distribute Output Configuration Location Specifies where you'll distribute the results of your protected query. You must configure either an S3 destination or a collaboration member destination.
- Protected
Query Output Contains details about the protected query output.
- Protected
Query Output Configuration Contains configuration details for protected query output.
- Protected
Query Status - When writing a match expression against
ProtectedQueryStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Protected
Query Type - When writing a match expression against
ProtectedQueryType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Query
Constraint Provides any necessary query constraint information.
- Resource
Type - When writing a match expression against
ResourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Result
Format - When writing a match expression against
ResultFormat, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Scalar
Functions - When writing a match expression against
ScalarFunctions, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Schema
Configuration - When writing a match expression against
SchemaConfiguration, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Schema
Status - When writing a match expression against
SchemaStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Schema
Status Reason Code - When writing a match expression against
SchemaStatusReasonCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Schema
Type - When writing a match expression against
SchemaType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Schema
Type Properties Information about the schema type properties.
- Selected
Analysis Method - When writing a match expression against
SelectedAnalysisMethod, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Snowflake
Table Schema The schema of a Snowflake table.
- Supported
S3Region - When writing a match expression against
SupportedS3Region, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Synthetic
Data Column Type - When writing a match expression against
SyntheticDataColumnType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Synthetic
Data Parameters The parameters that control how synthetic data is generated, including privacy settings, column classifications, and other configuration options that affect the data synthesis process.
- Table
Reference A pointer to the dataset that underlies this table.
- Target
Protected JobStatus - When writing a match expression against
TargetProtectedJobStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Target
Protected Query Status - When writing a match expression against
TargetProtectedQueryStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Validation
Exception Reason - When writing a match expression against
ValidationExceptionReason, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Worker
Compute Configuration Properties The configuration properties that define the compute environment settings for workers in Clean Rooms. These properties enable customization of the underlying compute environment to optimize performance for your specific workloads.
- Worker
Compute Type - When writing a match expression against
WorkerComputeType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.