# Data Types
<a name="API_Types"></a>

The AWS Clean Rooms Service API contains several data types that various actions use. This section describes each data type in detail.

**Note**  
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.

The following data types are supported:
+  [AccessBudget](API_AccessBudget.md) 
+  [AccessBudgetDetails](API_AccessBudgetDetails.md) 
+  [AccessBudgetsPrivacyTemplateParametersInput](API_AccessBudgetsPrivacyTemplateParametersInput.md) 
+  [AccessBudgetsPrivacyTemplateParametersOutput](API_AccessBudgetsPrivacyTemplateParametersOutput.md) 
+  [AccessBudgetsPrivacyTemplateUpdateParameters](API_AccessBudgetsPrivacyTemplateUpdateParameters.md) 
+  [AggregateColumn](API_AggregateColumn.md) 
+  [AggregationConstraint](API_AggregationConstraint.md) 
+  [AnalysisParameter](API_AnalysisParameter.md) 
+  [AnalysisRule](API_AnalysisRule.md) 
+  [AnalysisRuleAggregation](API_AnalysisRuleAggregation.md) 
+  [AnalysisRuleCustom](API_AnalysisRuleCustom.md) 
+  [AnalysisRuleIdMappingTable](API_AnalysisRuleIdMappingTable.md) 
+  [AnalysisRuleList](API_AnalysisRuleList.md) 
+  [AnalysisRulePolicy](API_AnalysisRulePolicy.md) 
+  [AnalysisRulePolicyV1](API_AnalysisRulePolicyV1.md) 
+  [AnalysisSchema](API_AnalysisSchema.md) 
+  [AnalysisSource](API_AnalysisSource.md) 
+  [AnalysisSourceMetadata](API_AnalysisSourceMetadata.md) 
+  [AnalysisTemplate](API_AnalysisTemplate.md) 
+  [AnalysisTemplateArtifact](API_AnalysisTemplateArtifact.md) 
+  [AnalysisTemplateArtifactMetadata](API_AnalysisTemplateArtifactMetadata.md) 
+  [AnalysisTemplateArtifacts](API_AnalysisTemplateArtifacts.md) 
+  [AnalysisTemplateSummary](API_AnalysisTemplateSummary.md) 
+  [AnalysisTemplateValidationStatusDetail](API_AnalysisTemplateValidationStatusDetail.md) 
+  [AnalysisTemplateValidationStatusReason](API_AnalysisTemplateValidationStatusReason.md) 
+  [ApprovalStatusDetails](API_ApprovalStatusDetails.md) 
+  [AthenaTableReference](API_AthenaTableReference.md) 
+  [BatchGetCollaborationAnalysisTemplateError](API_BatchGetCollaborationAnalysisTemplateError.md) 
+  [BatchGetSchemaAnalysisRuleError](API_BatchGetSchemaAnalysisRuleError.md) 
+  [BatchGetSchemaError](API_BatchGetSchemaError.md) 
+  [BilledJobResourceUtilization](API_BilledJobResourceUtilization.md) 
+  [BilledResourceUtilization](API_BilledResourceUtilization.md) 
+  [BudgetParameter](API_BudgetParameter.md) 
+  [Change](API_Change.md) 
+  [ChangeInput](API_ChangeInput.md) 
+  [ChangeSpecification](API_ChangeSpecification.md) 
+  [Collaboration](API_Collaboration.md) 
+  [CollaborationAnalysisTemplate](API_CollaborationAnalysisTemplate.md) 
+  [CollaborationAnalysisTemplateSummary](API_CollaborationAnalysisTemplateSummary.md) 
+  [CollaborationChangeRequest](API_CollaborationChangeRequest.md) 
+  [CollaborationChangeRequestSummary](API_CollaborationChangeRequestSummary.md) 
+  [CollaborationChangeSpecification](API_CollaborationChangeSpecification.md) 
+  [CollaborationConfiguredAudienceModelAssociation](API_CollaborationConfiguredAudienceModelAssociation.md) 
+  [CollaborationConfiguredAudienceModelAssociationSummary](API_CollaborationConfiguredAudienceModelAssociationSummary.md) 
+  [CollaborationIdNamespaceAssociation](API_CollaborationIdNamespaceAssociation.md) 
+  [CollaborationIdNamespaceAssociationSummary](API_CollaborationIdNamespaceAssociationSummary.md) 
+  [CollaborationPrivacyBudgetSummary](API_CollaborationPrivacyBudgetSummary.md) 
+  [CollaborationPrivacyBudgetTemplate](API_CollaborationPrivacyBudgetTemplate.md) 
+  [CollaborationPrivacyBudgetTemplateSummary](API_CollaborationPrivacyBudgetTemplateSummary.md) 
+  [CollaborationSummary](API_CollaborationSummary.md) 
+  [Column](API_Column.md) 
+  [ColumnClassificationDetails](API_ColumnClassificationDetails.md) 
+  [ComputeConfiguration](API_ComputeConfiguration.md) 
+  [ConfigurationDetails](API_ConfigurationDetails.md) 
+  [ConfiguredAudienceModelAssociation](API_ConfiguredAudienceModelAssociation.md) 
+  [ConfiguredAudienceModelAssociationSummary](API_ConfiguredAudienceModelAssociationSummary.md) 
+  [ConfiguredTable](API_ConfiguredTable.md) 
+  [ConfiguredTableAnalysisRule](API_ConfiguredTableAnalysisRule.md) 
+  [ConfiguredTableAnalysisRulePolicy](API_ConfiguredTableAnalysisRulePolicy.md) 
+  [ConfiguredTableAnalysisRulePolicyV1](API_ConfiguredTableAnalysisRulePolicyV1.md) 
+  [ConfiguredTableAssociation](API_ConfiguredTableAssociation.md) 
+  [ConfiguredTableAssociationAnalysisRule](API_ConfiguredTableAssociationAnalysisRule.md) 
+  [ConfiguredTableAssociationAnalysisRuleAggregation](API_ConfiguredTableAssociationAnalysisRuleAggregation.md) 
+  [ConfiguredTableAssociationAnalysisRuleCustom](API_ConfiguredTableAssociationAnalysisRuleCustom.md) 
+  [ConfiguredTableAssociationAnalysisRuleList](API_ConfiguredTableAssociationAnalysisRuleList.md) 
+  [ConfiguredTableAssociationAnalysisRulePolicy](API_ConfiguredTableAssociationAnalysisRulePolicy.md) 
+  [ConfiguredTableAssociationAnalysisRulePolicyV1](API_ConfiguredTableAssociationAnalysisRulePolicyV1.md) 
+  [ConfiguredTableAssociationSummary](API_ConfiguredTableAssociationSummary.md) 
+  [ConfiguredTableSummary](API_ConfiguredTableSummary.md) 
+  [ConsolidatedPolicy](API_ConsolidatedPolicy.md) 
+  [ConsolidatedPolicyAggregation](API_ConsolidatedPolicyAggregation.md) 
+  [ConsolidatedPolicyCustom](API_ConsolidatedPolicyCustom.md) 
+  [ConsolidatedPolicyList](API_ConsolidatedPolicyList.md) 
+  [ConsolidatedPolicyV1](API_ConsolidatedPolicyV1.md) 
+  [DataEncryptionMetadata](API_DataEncryptionMetadata.md) 
+  [DifferentialPrivacyColumn](API_DifferentialPrivacyColumn.md) 
+  [DifferentialPrivacyConfiguration](API_DifferentialPrivacyConfiguration.md) 
+  [DifferentialPrivacyParameters](API_DifferentialPrivacyParameters.md) 
+  [DifferentialPrivacyPreviewAggregation](API_DifferentialPrivacyPreviewAggregation.md) 
+  [DifferentialPrivacyPreviewParametersInput](API_DifferentialPrivacyPreviewParametersInput.md) 
+  [DifferentialPrivacyPrivacyBudget](API_DifferentialPrivacyPrivacyBudget.md) 
+  [DifferentialPrivacyPrivacyBudgetAggregation](API_DifferentialPrivacyPrivacyBudgetAggregation.md) 
+  [DifferentialPrivacyPrivacyImpact](API_DifferentialPrivacyPrivacyImpact.md) 
+  [DifferentialPrivacySensitivityParameters](API_DifferentialPrivacySensitivityParameters.md) 
+  [DifferentialPrivacyTemplateParametersInput](API_DifferentialPrivacyTemplateParametersInput.md) 
+  [DifferentialPrivacyTemplateParametersOutput](API_DifferentialPrivacyTemplateParametersOutput.md) 
+  [DifferentialPrivacyTemplateUpdateParameters](API_DifferentialPrivacyTemplateUpdateParameters.md) 
+  [DirectAnalysisConfigurationDetails](API_DirectAnalysisConfigurationDetails.md) 
+  [ErrorMessageConfiguration](API_ErrorMessageConfiguration.md) 
+  [GlueTableReference](API_GlueTableReference.md) 
+  [Hash](API_Hash.md) 
+  [IdMappingConfig](API_IdMappingConfig.md) 
+  [IdMappingTable](API_IdMappingTable.md) 
+  [IdMappingTableInputReferenceConfig](API_IdMappingTableInputReferenceConfig.md) 
+  [IdMappingTableInputReferenceProperties](API_IdMappingTableInputReferenceProperties.md) 
+  [IdMappingTableInputSource](API_IdMappingTableInputSource.md) 
+  [IdMappingTableSchemaTypeProperties](API_IdMappingTableSchemaTypeProperties.md) 
+  [IdMappingTableSummary](API_IdMappingTableSummary.md) 
+  [IdNamespaceAssociation](API_IdNamespaceAssociation.md) 
+  [IdNamespaceAssociationInputReferenceConfig](API_IdNamespaceAssociationInputReferenceConfig.md) 
+  [IdNamespaceAssociationInputReferenceProperties](API_IdNamespaceAssociationInputReferenceProperties.md) 
+  [IdNamespaceAssociationInputReferencePropertiesSummary](API_IdNamespaceAssociationInputReferencePropertiesSummary.md) 
+  [IdNamespaceAssociationSummary](API_IdNamespaceAssociationSummary.md) 
+  [JobComputePaymentConfig](API_JobComputePaymentConfig.md) 
+  [MemberChangeSpecification](API_MemberChangeSpecification.md) 
+  [Membership](API_Membership.md) 
+  [MembershipJobComputePaymentConfig](API_MembershipJobComputePaymentConfig.md) 
+  [MembershipMLPaymentConfig](API_MembershipMLPaymentConfig.md) 
+  [MembershipModelInferencePaymentConfig](API_MembershipModelInferencePaymentConfig.md) 
+  [MembershipModelTrainingPaymentConfig](API_MembershipModelTrainingPaymentConfig.md) 
+  [MembershipPaymentConfiguration](API_MembershipPaymentConfiguration.md) 
+  [MembershipProtectedJobOutputConfiguration](API_MembershipProtectedJobOutputConfiguration.md) 
+  [MembershipProtectedJobResultConfiguration](API_MembershipProtectedJobResultConfiguration.md) 
+  [MembershipProtectedQueryOutputConfiguration](API_MembershipProtectedQueryOutputConfiguration.md) 
+  [MembershipProtectedQueryResultConfiguration](API_MembershipProtectedQueryResultConfiguration.md) 
+  [MembershipQueryComputePaymentConfig](API_MembershipQueryComputePaymentConfig.md) 
+  [MembershipSummary](API_MembershipSummary.md) 
+  [MembershipSyntheticDataGenerationPaymentConfig](API_MembershipSyntheticDataGenerationPaymentConfig.md) 
+  [MemberSpecification](API_MemberSpecification.md) 
+  [MemberSummary](API_MemberSummary.md) 
+  [MLMemberAbilities](API_MLMemberAbilities.md) 
+  [MLPaymentConfig](API_MLPaymentConfig.md) 
+  [MLSyntheticDataParameters](API_MLSyntheticDataParameters.md) 
+  [ModelInferencePaymentConfig](API_ModelInferencePaymentConfig.md) 
+  [ModelTrainingPaymentConfig](API_ModelTrainingPaymentConfig.md) 
+  [PaymentConfiguration](API_PaymentConfiguration.md) 
+  [PreviewPrivacyImpactParametersInput](API_PreviewPrivacyImpactParametersInput.md) 
+  [PrivacyBudget](API_PrivacyBudget.md) 
+  [PrivacyBudgetSummary](API_PrivacyBudgetSummary.md) 
+  [PrivacyBudgetTemplate](API_PrivacyBudgetTemplate.md) 
+  [PrivacyBudgetTemplateParametersInput](API_PrivacyBudgetTemplateParametersInput.md) 
+  [PrivacyBudgetTemplateParametersOutput](API_PrivacyBudgetTemplateParametersOutput.md) 
+  [PrivacyBudgetTemplateSummary](API_PrivacyBudgetTemplateSummary.md) 
+  [PrivacyBudgetTemplateUpdateParameters](API_PrivacyBudgetTemplateUpdateParameters.md) 
+  [PrivacyImpact](API_PrivacyImpact.md) 
+  [ProtectedJob](API_ProtectedJob.md) 
+  [ProtectedJobComputeConfiguration](API_ProtectedJobComputeConfiguration.md) 
+  [ProtectedJobConfigurationDetails](API_ProtectedJobConfigurationDetails.md) 
+  [ProtectedJobDirectAnalysisConfigurationDetails](API_ProtectedJobDirectAnalysisConfigurationDetails.md) 
+  [ProtectedJobError](API_ProtectedJobError.md) 
+  [ProtectedJobMemberOutputConfigurationInput](API_ProtectedJobMemberOutputConfigurationInput.md) 
+  [ProtectedJobMemberOutputConfigurationOutput](API_ProtectedJobMemberOutputConfigurationOutput.md) 
+  [ProtectedJobOutput](API_ProtectedJobOutput.md) 
+  [ProtectedJobOutputConfigurationInput](API_ProtectedJobOutputConfigurationInput.md) 
+  [ProtectedJobOutputConfigurationOutput](API_ProtectedJobOutputConfigurationOutput.md) 
+  [ProtectedJobParameters](API_ProtectedJobParameters.md) 
+  [ProtectedJobReceiverConfiguration](API_ProtectedJobReceiverConfiguration.md) 
+  [ProtectedJobResult](API_ProtectedJobResult.md) 
+  [ProtectedJobResultConfigurationInput](API_ProtectedJobResultConfigurationInput.md) 
+  [ProtectedJobResultConfigurationOutput](API_ProtectedJobResultConfigurationOutput.md) 
+  [ProtectedJobS3Output](API_ProtectedJobS3Output.md) 
+  [ProtectedJobS3OutputConfigurationInput](API_ProtectedJobS3OutputConfigurationInput.md) 
+  [ProtectedJobS3OutputConfigurationOutput](API_ProtectedJobS3OutputConfigurationOutput.md) 
+  [ProtectedJobSingleMemberOutput](API_ProtectedJobSingleMemberOutput.md) 
+  [ProtectedJobStatistics](API_ProtectedJobStatistics.md) 
+  [ProtectedJobSummary](API_ProtectedJobSummary.md) 
+  [ProtectedJobWorkerComputeConfiguration](API_ProtectedJobWorkerComputeConfiguration.md) 
+  [ProtectedQuery](API_ProtectedQuery.md) 
+  [ProtectedQueryDistributeOutput](API_ProtectedQueryDistributeOutput.md) 
+  [ProtectedQueryDistributeOutputConfiguration](API_ProtectedQueryDistributeOutputConfiguration.md) 
+  [ProtectedQueryDistributeOutputConfigurationLocation](API_ProtectedQueryDistributeOutputConfigurationLocation.md) 
+  [ProtectedQueryError](API_ProtectedQueryError.md) 
+  [ProtectedQueryMemberOutputConfiguration](API_ProtectedQueryMemberOutputConfiguration.md) 
+  [ProtectedQueryOutput](API_ProtectedQueryOutput.md) 
+  [ProtectedQueryOutputConfiguration](API_ProtectedQueryOutputConfiguration.md) 
+  [ProtectedQueryResult](API_ProtectedQueryResult.md) 
+  [ProtectedQueryResultConfiguration](API_ProtectedQueryResultConfiguration.md) 
+  [ProtectedQueryS3Output](API_ProtectedQueryS3Output.md) 
+  [ProtectedQueryS3OutputConfiguration](API_ProtectedQueryS3OutputConfiguration.md) 
+  [ProtectedQuerySingleMemberOutput](API_ProtectedQuerySingleMemberOutput.md) 
+  [ProtectedQuerySQLParameters](API_ProtectedQuerySQLParameters.md) 
+  [ProtectedQueryStatistics](API_ProtectedQueryStatistics.md) 
+  [ProtectedQuerySummary](API_ProtectedQuerySummary.md) 
+  [QueryComputePaymentConfig](API_QueryComputePaymentConfig.md) 
+  [QueryConstraint](API_QueryConstraint.md) 
+  [QueryConstraintRequireOverlap](API_QueryConstraintRequireOverlap.md) 
+  [ReceiverConfiguration](API_ReceiverConfiguration.md) 
+  [S3Location](API_S3Location.md) 
+  [Schema](API_Schema.md) 
+  [SchemaAnalysisRuleRequest](API_SchemaAnalysisRuleRequest.md) 
+  [SchemaStatusDetail](API_SchemaStatusDetail.md) 
+  [SchemaStatusReason](API_SchemaStatusReason.md) 
+  [SchemaSummary](API_SchemaSummary.md) 
+  [SchemaTypeProperties](API_SchemaTypeProperties.md) 
+  [SnowflakeTableReference](API_SnowflakeTableReference.md) 
+  [SnowflakeTableSchema](API_SnowflakeTableSchema.md) 
+  [SnowflakeTableSchemaV1](API_SnowflakeTableSchemaV1.md) 
+  [SyntheticDataColumnProperties](API_SyntheticDataColumnProperties.md) 
+  [SyntheticDataGenerationPaymentConfig](API_SyntheticDataGenerationPaymentConfig.md) 
+  [SyntheticDataParameters](API_SyntheticDataParameters.md) 
+  [TableReference](API_TableReference.md) 
+  [ValidationExceptionField](API_ValidationExceptionField.md) 
+  [WorkerComputeConfiguration](API_WorkerComputeConfiguration.md) 
+  [WorkerComputeConfigurationProperties](API_WorkerComputeConfigurationProperties.md) 

# AccessBudget
<a name="API_AccessBudget"></a>

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.

## Contents
<a name="API_AccessBudget_Contents"></a>

 ** aggregateRemainingBudget **   <a name="API-Type-AccessBudget-aggregateRemainingBudget"></a>
The total remaining budget across all budget parameters, showing the lower value between the per-period budget and lifetime budget for this access budget. For individual parameter budgets, see `remainingBudget`.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: Yes

 ** details **   <a name="API-Type-AccessBudget-details"></a>
Detailed budget information including time bounds, remaining budget, and refresh settings.  
Type: Array of [AccessBudgetDetails](API_AccessBudgetDetails.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 2 items.  
Required: Yes

 ** resourceArn **   <a name="API-Type-AccessBudget-resourceArn"></a>
The Amazon Resource Name (ARN) of the access budget resource.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/(configuredtableassociation|intermediatetable)/[\d\w-]+`   
Required: Yes

## See Also
<a name="API_AccessBudget_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AccessBudget) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AccessBudget) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AccessBudget) 

# AccessBudgetDetails
<a name="API_AccessBudgetDetails"></a>

Detailed information about an access budget including time bounds, budget allocation, and configuration settings.

## Contents
<a name="API_AccessBudgetDetails_Contents"></a>

 ** budget **   <a name="API-Type-AccessBudgetDetails-budget"></a>
The total budget allocation amount for this access budget.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1000000.  
Required: Yes

 ** budgetType **   <a name="API-Type-AccessBudgetDetails-budgetType"></a>
Specifies the time period for limiting table usage in queries and jobs. For calendar-based periods, the budget can renew if auto refresh is enabled. For lifetime budgets, the limit applies to the total usage throughout the collaboration. Valid values are:  
 `CALENDAR_DAY` - Limit table usage per day.  
 `CALENDAR_WEEK` - Limit table usage per week.  
 `CALENDAR_MONTH` - Limit table usage per month.  
 `LIFETIME` - Limit total table usage for the collaboration duration.  
Type: String  
Valid Values: `CALENDAR_DAY | CALENDAR_MONTH | CALENDAR_WEEK | LIFETIME`   
Required: Yes

 ** remainingBudget **   <a name="API-Type-AccessBudgetDetails-remainingBudget"></a>
The remaining budget amount available for use within this access budget.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: Yes

 ** startTime **   <a name="API-Type-AccessBudgetDetails-startTime"></a>
The start time for the access budget period.  
Type: Timestamp  
Required: Yes

 ** autoRefresh **   <a name="API-Type-AccessBudgetDetails-autoRefresh"></a>
Indicates whether the budget automatically refreshes for each time period specified in `budgetType`. Valid values are:  
 `ENABLED` - The budget refreshes automatically at the start of each period.  
 `DISABLED` - The budget must be refreshed manually.  
 `NULL` - The value is null when `budgetType` is set to `LIFETIME`.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** endTime **   <a name="API-Type-AccessBudgetDetails-endTime"></a>
The end time for the access budget period.  
Type: Timestamp  
Required: No

## See Also
<a name="API_AccessBudgetDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AccessBudgetDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AccessBudgetDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AccessBudgetDetails) 

# AccessBudgetsPrivacyTemplateParametersInput
<a name="API_AccessBudgetsPrivacyTemplateParametersInput"></a>

Input parameters for privacy budget templates that support access budgets functionality, enabling enhanced budget management capabilities.

## Contents
<a name="API_AccessBudgetsPrivacyTemplateParametersInput_Contents"></a>

 ** budgetParameters **   <a name="API-Type-AccessBudgetsPrivacyTemplateParametersInput-budgetParameters"></a>
An array of budget parameters that define the access budget configuration for the privacy template.  
Type: Array of [BudgetParameter](API_BudgetParameter.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 2 items.  
Required: Yes

 ** resourceArn **   <a name="API-Type-AccessBudgetsPrivacyTemplateParametersInput-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource associated with this privacy budget template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/(configuredtableassociation|intermediatetable)/[\d\w-]+`   
Required: Yes

## See Also
<a name="API_AccessBudgetsPrivacyTemplateParametersInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AccessBudgetsPrivacyTemplateParametersInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AccessBudgetsPrivacyTemplateParametersInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AccessBudgetsPrivacyTemplateParametersInput) 

# AccessBudgetsPrivacyTemplateParametersOutput
<a name="API_AccessBudgetsPrivacyTemplateParametersOutput"></a>

Output parameters for privacy budget templates with access budgets support, containing the configured budget information.

## Contents
<a name="API_AccessBudgetsPrivacyTemplateParametersOutput_Contents"></a>

 ** budgetParameters **   <a name="API-Type-AccessBudgetsPrivacyTemplateParametersOutput-budgetParameters"></a>
An array of budget parameters returned from the access budget configuration.  
Type: Array of [BudgetParameter](API_BudgetParameter.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 2 items.  
Required: Yes

 ** resourceArn **   <a name="API-Type-AccessBudgetsPrivacyTemplateParametersOutput-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource associated with this privacy budget template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/(configuredtableassociation|intermediatetable)/[\d\w-]+`   
Required: Yes

## See Also
<a name="API_AccessBudgetsPrivacyTemplateParametersOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AccessBudgetsPrivacyTemplateParametersOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AccessBudgetsPrivacyTemplateParametersOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AccessBudgetsPrivacyTemplateParametersOutput) 

# AccessBudgetsPrivacyTemplateUpdateParameters
<a name="API_AccessBudgetsPrivacyTemplateUpdateParameters"></a>

Update parameters for privacy budget templates with access budgets functionality, allowing modification of existing budget configurations.

## Contents
<a name="API_AccessBudgetsPrivacyTemplateUpdateParameters_Contents"></a>

 ** budgetParameters **   <a name="API-Type-AccessBudgetsPrivacyTemplateUpdateParameters-budgetParameters"></a>
Updated array of budget parameters for the access budget configuration.  
Type: Array of [BudgetParameter](API_BudgetParameter.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 2 items.  
Required: Yes

## See Also
<a name="API_AccessBudgetsPrivacyTemplateUpdateParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AccessBudgetsPrivacyTemplateUpdateParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AccessBudgetsPrivacyTemplateUpdateParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AccessBudgetsPrivacyTemplateUpdateParameters) 

# AggregateColumn
<a name="API_AggregateColumn"></a>

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

## Contents
<a name="API_AggregateColumn_Contents"></a>

 ** columnNames **   <a name="API-Type-AggregateColumn-columnNames"></a>
Column names in configured table of aggregate columns.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?`   
Required: Yes

 ** function **   <a name="API-Type-AggregateColumn-function"></a>
Aggregation function that can be applied to aggregate column in query.  
Type: String  
Valid Values: `SUM | SUM_DISTINCT | COUNT | COUNT_DISTINCT | AVG`   
Required: Yes

## See Also
<a name="API_AggregateColumn_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AggregateColumn) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AggregateColumn) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AggregateColumn) 

# AggregationConstraint
<a name="API_AggregationConstraint"></a>

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

## Contents
<a name="API_AggregationConstraint_Contents"></a>

 ** columnName **   <a name="API-Type-AggregationConstraint-columnName"></a>
Column in aggregation constraint for which there must be a minimum number of distinct values in an output row for it to be in the query output.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?`   
Required: Yes

 ** minimum **   <a name="API-Type-AggregationConstraint-minimum"></a>
The minimum number of distinct values that an output row must be an aggregation of. Minimum threshold of distinct values for a specified column that must exist in an output row for it to be in the query output.  
Type: Integer  
Valid Range: Minimum value of 2. Maximum value of 100000.  
Required: Yes

 ** type **   <a name="API-Type-AggregationConstraint-type"></a>
The type of aggregation the constraint allows. The only valid value is currently `COUNT\$1DISTINCT`.  
Type: String  
Valid Values: `COUNT_DISTINCT`   
Required: Yes

## See Also
<a name="API_AggregationConstraint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AggregationConstraint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AggregationConstraint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AggregationConstraint) 

# AnalysisParameter
<a name="API_AnalysisParameter"></a>

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

## Contents
<a name="API_AnalysisParameter_Contents"></a>

 ** name **   <a name="API-Type-AnalysisParameter-name"></a>
The name of the parameter. The name must use only alphanumeric or underscore (\$1) characters.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9a-zA-Z_]+`   
Required: Yes

 ** type **   <a name="API-Type-AnalysisParameter-type"></a>
The type of parameter.  
Type: String  
Valid Values: `SMALLINT | INTEGER | BIGINT | DECIMAL | REAL | DOUBLE_PRECISION | BOOLEAN | CHAR | VARCHAR | DATE | TIMESTAMP | TIMESTAMPTZ | TIME | TIMETZ | VARBYTE | BINARY | BYTE | CHARACTER | DOUBLE | FLOAT | INT | LONG | NUMERIC | SHORT | STRING | TIMESTAMP_LTZ | TIMESTAMP_NTZ | TINYINT`   
Required: Yes

 ** defaultValue **   <a name="API-Type-AnalysisParameter-defaultValue"></a>
Optional. The default value that is applied in the analysis template. The member who can query can override this value in the query editor.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Required: No

## See Also
<a name="API_AnalysisParameter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AnalysisParameter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AnalysisParameter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AnalysisParameter) 

# AnalysisRule
<a name="API_AnalysisRule"></a>

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

## Contents
<a name="API_AnalysisRule_Contents"></a>

 ** collaborationId **   <a name="API-Type-AnalysisRule-collaborationId"></a>
The unique ID for the associated collaboration.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** createTime **   <a name="API-Type-AnalysisRule-createTime"></a>
The time the analysis rule was created.  
Type: Timestamp  
Required: Yes

 ** name **   <a name="API-Type-AnalysisRule-name"></a>
The name for the analysis rule.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?`   
Required: Yes

 ** policy **   <a name="API-Type-AnalysisRule-policy"></a>
A policy that describes the associated data usage limitations.  
Type: [AnalysisRulePolicy](API_AnalysisRulePolicy.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** type **   <a name="API-Type-AnalysisRule-type"></a>
The type of analysis rule.  
Type: String  
Valid Values: `AGGREGATION | LIST | CUSTOM | ID_MAPPING_TABLE`   
Required: Yes

 ** updateTime **   <a name="API-Type-AnalysisRule-updateTime"></a>
The time the analysis rule was last updated.  
Type: Timestamp  
Required: Yes

 ** collaborationPolicy **   <a name="API-Type-AnalysisRule-collaborationPolicy"></a>
 Controls on the query specifications that can be run on an associated configured table.  
Type: [ConfiguredTableAssociationAnalysisRulePolicy](API_ConfiguredTableAssociationAnalysisRulePolicy.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** consolidatedPolicy **   <a name="API-Type-AnalysisRule-consolidatedPolicy"></a>
 The consolidated policy for the analysis rule.  
Type: [ConsolidatedPolicy](API_ConsolidatedPolicy.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## See Also
<a name="API_AnalysisRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AnalysisRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AnalysisRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AnalysisRule) 

# AnalysisRuleAggregation
<a name="API_AnalysisRuleAggregation"></a>

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

## Contents
<a name="API_AnalysisRuleAggregation_Contents"></a>

 ** aggregateColumns **   <a name="API-Type-AnalysisRuleAggregation-aggregateColumns"></a>
The columns that query runners are allowed to use in aggregation queries.  
Type: Array of [AggregateColumn](API_AggregateColumn.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

 ** dimensionColumns **   <a name="API-Type-AnalysisRuleAggregation-dimensionColumns"></a>
The columns that query runners are allowed to select, group by, or filter by.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?`   
Required: Yes

 ** joinColumns **   <a name="API-Type-AnalysisRuleAggregation-joinColumns"></a>
Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?`   
Required: Yes

 ** outputConstraints **   <a name="API-Type-AnalysisRuleAggregation-outputConstraints"></a>
Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.  
Type: Array of [AggregationConstraint](API_AggregationConstraint.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

 ** scalarFunctions **   <a name="API-Type-AnalysisRuleAggregation-scalarFunctions"></a>
Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.  
Type: Array of strings  
Valid Values: `ABS | CAST | CEILING | COALESCE | CONVERT | CURRENT_DATE | DATEADD | EXTRACT | FLOOR | GETDATE | LN | LOG | LOWER | ROUND | RTRIM | SQRT | SUBSTRING | TO_CHAR | TO_DATE | TO_NUMBER | TO_TIMESTAMP | TRIM | TRUNC | UPPER`   
Required: Yes

 ** additionalAnalyses **   <a name="API-Type-AnalysisRuleAggregation-additionalAnalyses"></a>
 An indicator as to whether additional analyses (such as AWS Clean Rooms ML) can be applied to the output of the direct query.   
The `additionalAnalyses` parameter is currently supported for the list analysis rule (`AnalysisRuleList`) and the custom analysis rule (`AnalysisRuleCustom`).  
Type: String  
Valid Values: `ALLOWED | REQUIRED | NOT_ALLOWED`   
Required: No

 ** allowedJoinOperators **   <a name="API-Type-AnalysisRuleAggregation-allowedJoinOperators"></a>
Which logical operators (if any) are to be used in an INNER JOIN match condition. Default is `AND`.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 2 items.  
Valid Values: `OR | AND`   
Required: No

 ** joinRequired **   <a name="API-Type-AnalysisRuleAggregation-joinRequired"></a>
Control that requires member who runs query to do a join with their configured table and/or other configured table in query.  
Type: String  
Valid Values: `QUERY_RUNNER`   
Required: No

## See Also
<a name="API_AnalysisRuleAggregation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AnalysisRuleAggregation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AnalysisRuleAggregation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AnalysisRuleAggregation) 

# AnalysisRuleCustom
<a name="API_AnalysisRuleCustom"></a>

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

## Contents
<a name="API_AnalysisRuleCustom_Contents"></a>

 ** allowedAnalyses **   <a name="API-Type-AnalysisRuleCustom-allowedAnalyses"></a>
The ARN of the analysis templates that are allowed by the custom analysis rule.  
Type: Array of strings  
Array Members: Minimum number of 0 items.  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Pattern: `(ANY_QUERY|ANY_JOB|arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/analysistemplate/[\d\w-]+)`   
Required: Yes

 ** additionalAnalyses **   <a name="API-Type-AnalysisRuleCustom-additionalAnalyses"></a>
 An indicator as to whether additional analyses (such as AWS Clean Rooms ML) can be applied to the output of the direct query.  
Type: String  
Valid Values: `ALLOWED | REQUIRED | NOT_ALLOWED`   
Required: No

 ** allowedAnalysisProviders **   <a name="API-Type-AnalysisRuleCustom-allowedAnalysisProviders"></a>
The IDs of the AWS accounts that are allowed to query by the custom analysis rule. Required when `allowedAnalyses` is `ANY_QUERY`.  
Type: Array of strings  
Array Members: Minimum number of 0 items.  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: No

 ** differentialPrivacy **   <a name="API-Type-AnalysisRuleCustom-differentialPrivacy"></a>
The differential privacy configuration.  
Type: [DifferentialPrivacyConfiguration](API_DifferentialPrivacyConfiguration.md) object  
Required: No

 ** disallowedOutputColumns **   <a name="API-Type-AnalysisRuleCustom-disallowedOutputColumns"></a>
 A list of columns that aren't allowed to be shown in the query output.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?`   
Required: No

## See Also
<a name="API_AnalysisRuleCustom_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AnalysisRuleCustom) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AnalysisRuleCustom) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AnalysisRuleCustom) 

# AnalysisRuleIdMappingTable
<a name="API_AnalysisRuleIdMappingTable"></a>

Defines details for the analysis rule ID mapping table.

## Contents
<a name="API_AnalysisRuleIdMappingTable_Contents"></a>

 ** joinColumns **   <a name="API-Type-AnalysisRuleIdMappingTable-joinColumns"></a>
The columns that query runners are allowed to use in an INNER JOIN statement.  
Type: Array of strings  
Array Members: Fixed number of 2 items.  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?`   
Required: Yes

 ** queryConstraints **   <a name="API-Type-AnalysisRuleIdMappingTable-queryConstraints"></a>
The query constraints of the analysis rule ID mapping table.  
Type: Array of [QueryConstraint](API_QueryConstraint.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Required: Yes

 ** dimensionColumns **   <a name="API-Type-AnalysisRuleIdMappingTable-dimensionColumns"></a>
The columns that query runners are allowed to select, group by, or filter by.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?`   
Required: No

## See Also
<a name="API_AnalysisRuleIdMappingTable_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AnalysisRuleIdMappingTable) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AnalysisRuleIdMappingTable) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AnalysisRuleIdMappingTable) 

# AnalysisRuleList
<a name="API_AnalysisRuleList"></a>

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

## Contents
<a name="API_AnalysisRuleList_Contents"></a>

 ** joinColumns **   <a name="API-Type-AnalysisRuleList-joinColumns"></a>
Columns that can be used to join a configured table with the table of the member who can query and other members' configured tables.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?`   
Required: Yes

 ** listColumns **   <a name="API-Type-AnalysisRuleList-listColumns"></a>
Columns that can be listed in the output.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?`   
Required: Yes

 ** additionalAnalyses **   <a name="API-Type-AnalysisRuleList-additionalAnalyses"></a>
 An indicator as to whether additional analyses (such as AWS Clean Rooms ML) can be applied to the output of the direct query.  
Type: String  
Valid Values: `ALLOWED | REQUIRED | NOT_ALLOWED`   
Required: No

 ** allowedJoinOperators **   <a name="API-Type-AnalysisRuleList-allowedJoinOperators"></a>
The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is `AND`.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 2 items.  
Valid Values: `OR | AND`   
Required: No

## See Also
<a name="API_AnalysisRuleList_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AnalysisRuleList) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AnalysisRuleList) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AnalysisRuleList) 

# AnalysisRulePolicy
<a name="API_AnalysisRulePolicy"></a>

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

## Contents
<a name="API_AnalysisRulePolicy_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** v1 **   <a name="API-Type-AnalysisRulePolicy-v1"></a>
Controls on the query specifications that can be run on configured table.  
Type: [AnalysisRulePolicyV1](API_AnalysisRulePolicyV1.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## See Also
<a name="API_AnalysisRulePolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AnalysisRulePolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AnalysisRulePolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AnalysisRulePolicy) 

# AnalysisRulePolicyV1
<a name="API_AnalysisRulePolicyV1"></a>

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

## Contents
<a name="API_AnalysisRulePolicyV1_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** aggregation **   <a name="API-Type-AnalysisRulePolicyV1-aggregation"></a>
Analysis rule type that enables only aggregation queries on a configured table.  
Type: [AnalysisRuleAggregation](API_AnalysisRuleAggregation.md) object  
Required: No

 ** custom **   <a name="API-Type-AnalysisRulePolicyV1-custom"></a>
Analysis rule type that enables custom SQL queries on a configured table.  
Type: [AnalysisRuleCustom](API_AnalysisRuleCustom.md) object  
Required: No

 ** idMappingTable **   <a name="API-Type-AnalysisRulePolicyV1-idMappingTable"></a>
The ID mapping table.  
Type: [AnalysisRuleIdMappingTable](API_AnalysisRuleIdMappingTable.md) object  
Required: No

 ** list **   <a name="API-Type-AnalysisRulePolicyV1-list"></a>
Analysis rule type that enables only list queries on a configured table.  
Type: [AnalysisRuleList](API_AnalysisRuleList.md) object  
Required: No

## See Also
<a name="API_AnalysisRulePolicyV1_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AnalysisRulePolicyV1) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AnalysisRulePolicyV1) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AnalysisRulePolicyV1) 

# AnalysisSchema
<a name="API_AnalysisSchema"></a>

A relation within an analysis.

## Contents
<a name="API_AnalysisSchema_Contents"></a>

 ** referencedTables **   <a name="API-Type-AnalysisSchema-referencedTables"></a>
The tables referenced in the analysis schema.  
Type: Array of strings  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?`   
Required: No

## See Also
<a name="API_AnalysisSchema_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AnalysisSchema) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AnalysisSchema) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AnalysisSchema) 

# AnalysisSource
<a name="API_AnalysisSource"></a>

The structure that defines the body of the analysis template.

## Contents
<a name="API_AnalysisSource_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** artifacts **   <a name="API-Type-AnalysisSource-artifacts"></a>
 The artifacts of the analysis source.  
Type: [AnalysisTemplateArtifacts](API_AnalysisTemplateArtifacts.md) object  
Required: No

 ** text **   <a name="API-Type-AnalysisSource-text"></a>
The query text.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500000.  
Required: No

## See Also
<a name="API_AnalysisSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AnalysisSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AnalysisSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AnalysisSource) 

# AnalysisSourceMetadata
<a name="API_AnalysisSourceMetadata"></a>

The analysis source metadata.

## Contents
<a name="API_AnalysisSourceMetadata_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** artifacts **   <a name="API-Type-AnalysisSourceMetadata-artifacts"></a>
 The artifacts of the analysis source metadata.  
Type: [AnalysisTemplateArtifactMetadata](API_AnalysisTemplateArtifactMetadata.md) object  
Required: No

## See Also
<a name="API_AnalysisSourceMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AnalysisSourceMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AnalysisSourceMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AnalysisSourceMetadata) 

# AnalysisTemplate
<a name="API_AnalysisTemplate"></a>

The analysis template.

## Contents
<a name="API_AnalysisTemplate_Contents"></a>

 ** arn **   <a name="API-Type-AnalysisTemplate-arn"></a>
The Amazon Resource Name (ARN) of the analysis template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Pattern: `arn:aws[-a-z]*:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/analysistemplate/[\d\w-]+`   
Required: Yes

 ** collaborationArn **   <a name="API-Type-AnalysisTemplate-collaborationArn"></a>
The unique ARN for the analysis template’s associated collaboration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** collaborationId **   <a name="API-Type-AnalysisTemplate-collaborationId"></a>
The unique ID for the associated collaboration of the analysis template.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** createTime **   <a name="API-Type-AnalysisTemplate-createTime"></a>
The time that the analysis template was created.  
Type: Timestamp  
Required: Yes

 ** format **   <a name="API-Type-AnalysisTemplate-format"></a>
The format of the analysis template.  
Type: String  
Valid Values: `SQL | PYSPARK_1_0`   
Required: Yes

 ** id **   <a name="API-Type-AnalysisTemplate-id"></a>
The identifier for the analysis template.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** membershipArn **   <a name="API-Type-AnalysisTemplate-membershipArn"></a>
The Amazon Resource Name (ARN) of the member who created the analysis template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+`   
Required: Yes

 ** membershipId **   <a name="API-Type-AnalysisTemplate-membershipId"></a>
The identifier of a member who created the analysis template.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** name **   <a name="API-Type-AnalysisTemplate-name"></a>
The name of the analysis template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?`   
Required: Yes

 ** schema **   <a name="API-Type-AnalysisTemplate-schema"></a>
The entire schema object.  
Type: [AnalysisSchema](API_AnalysisSchema.md) object  
Required: Yes

 ** source **   <a name="API-Type-AnalysisTemplate-source"></a>
The source of the analysis template.  
Type: [AnalysisSource](API_AnalysisSource.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** updateTime **   <a name="API-Type-AnalysisTemplate-updateTime"></a>
The time that the analysis template was last updated.  
Type: Timestamp  
Required: Yes

 ** analysisParameters **   <a name="API-Type-AnalysisTemplate-analysisParameters"></a>
The parameters of the analysis template.  
Type: Array of [AnalysisParameter](API_AnalysisParameter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

 ** description **   <a name="API-Type-AnalysisTemplate-description"></a>
The description of the analysis template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*`   
Required: No

 ** errorMessageConfiguration **   <a name="API-Type-AnalysisTemplate-errorMessageConfiguration"></a>
The configuration that specifies the level of detail in error messages returned by analyses using this template. When set to `DETAILED`, error messages include more information to help troubleshoot issues with PySpark jobs. Detailed error messages may expose underlying data, including sensitive information. Recommended for faster troubleshooting in development and testing environments.  
Type: [ErrorMessageConfiguration](API_ErrorMessageConfiguration.md) object  
Required: No

 ** sourceMetadata **   <a name="API-Type-AnalysisTemplate-sourceMetadata"></a>
 The source metadata for the analysis template.  
Type: [AnalysisSourceMetadata](API_AnalysisSourceMetadata.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** syntheticDataParameters **   <a name="API-Type-AnalysisTemplate-syntheticDataParameters"></a>
The parameters used to generate synthetic data for this analysis template.  
Type: [SyntheticDataParameters](API_SyntheticDataParameters.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** validations **   <a name="API-Type-AnalysisTemplate-validations"></a>
Information about the validations performed on the analysis template.  
Type: Array of [AnalysisTemplateValidationStatusDetail](API_AnalysisTemplateValidationStatusDetail.md) objects  
Required: No

## See Also
<a name="API_AnalysisTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AnalysisTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AnalysisTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AnalysisTemplate) 

# AnalysisTemplateArtifact
<a name="API_AnalysisTemplateArtifact"></a>

The analysis template artifact.

## Contents
<a name="API_AnalysisTemplateArtifact_Contents"></a>

 ** location **   <a name="API-Type-AnalysisTemplateArtifact-location"></a>
 The artifact location.  
Type: [S3Location](API_S3Location.md) object  
Required: Yes

## See Also
<a name="API_AnalysisTemplateArtifact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AnalysisTemplateArtifact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AnalysisTemplateArtifact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AnalysisTemplateArtifact) 

# AnalysisTemplateArtifactMetadata
<a name="API_AnalysisTemplateArtifactMetadata"></a>

The analysis template artifact metadata.

## Contents
<a name="API_AnalysisTemplateArtifactMetadata_Contents"></a>

 ** entryPointHash **   <a name="API-Type-AnalysisTemplateArtifactMetadata-entryPointHash"></a>
 The hash of the entry point for the analysis template artifact metadata.  
Type: [Hash](API_Hash.md) object  
Required: Yes

 ** additionalArtifactHashes **   <a name="API-Type-AnalysisTemplateArtifactMetadata-additionalArtifactHashes"></a>
 Additional artifact hashes for the analysis template.  
Type: Array of [Hash](API_Hash.md) objects  
Required: No

## See Also
<a name="API_AnalysisTemplateArtifactMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AnalysisTemplateArtifactMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AnalysisTemplateArtifactMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AnalysisTemplateArtifactMetadata) 

# AnalysisTemplateArtifacts
<a name="API_AnalysisTemplateArtifacts"></a>

The analysis template artifacts.

## Contents
<a name="API_AnalysisTemplateArtifacts_Contents"></a>

 ** entryPoint **   <a name="API-Type-AnalysisTemplateArtifacts-entryPoint"></a>
 The entry point for the analysis template artifacts.  
Type: [AnalysisTemplateArtifact](API_AnalysisTemplateArtifact.md) object  
Required: Yes

 ** roleArn **   <a name="API-Type-AnalysisTemplateArtifacts-roleArn"></a>
 The role ARN for the analysis template artifacts.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 512.  
Pattern: `arn:aws:iam::[\w]+:role/[\w+=./@-]+`   
Required: Yes

 ** additionalArtifacts **   <a name="API-Type-AnalysisTemplateArtifacts-additionalArtifacts"></a>
 Additional artifacts for the analysis template.  
Type: Array of [AnalysisTemplateArtifact](API_AnalysisTemplateArtifact.md) objects  
Array Members: Fixed number of 1 item.  
Required: No

## See Also
<a name="API_AnalysisTemplateArtifacts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AnalysisTemplateArtifacts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AnalysisTemplateArtifacts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AnalysisTemplateArtifacts) 

# AnalysisTemplateSummary
<a name="API_AnalysisTemplateSummary"></a>

The metadata of the analysis template.

## Contents
<a name="API_AnalysisTemplateSummary_Contents"></a>

 ** arn **   <a name="API-Type-AnalysisTemplateSummary-arn"></a>
The Amazon Resource Name (ARN) of the analysis template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Pattern: `arn:aws[-a-z]*:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/analysistemplate/[\d\w-]+`   
Required: Yes

 ** collaborationArn **   <a name="API-Type-AnalysisTemplateSummary-collaborationArn"></a>
The unique ARN for the analysis template summary’s associated collaboration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** collaborationId **   <a name="API-Type-AnalysisTemplateSummary-collaborationId"></a>
A unique identifier for the collaboration that the analysis template summary belongs to. Currently accepts collaboration ID.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** createTime **   <a name="API-Type-AnalysisTemplateSummary-createTime"></a>
The time that the analysis template summary was created.  
Type: Timestamp  
Required: Yes

 ** id **   <a name="API-Type-AnalysisTemplateSummary-id"></a>
The identifier of the analysis template.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** membershipArn **   <a name="API-Type-AnalysisTemplateSummary-membershipArn"></a>
The Amazon Resource Name (ARN) of the member who created the analysis template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+`   
Required: Yes

 ** membershipId **   <a name="API-Type-AnalysisTemplateSummary-membershipId"></a>
The identifier for a membership resource.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** name **   <a name="API-Type-AnalysisTemplateSummary-name"></a>
The name of the analysis template.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?`   
Required: Yes

 ** updateTime **   <a name="API-Type-AnalysisTemplateSummary-updateTime"></a>
The time that the analysis template summary was last updated.  
Type: Timestamp  
Required: Yes

 ** description **   <a name="API-Type-AnalysisTemplateSummary-description"></a>
The description of the analysis template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*`   
Required: No

 ** isSyntheticData **   <a name="API-Type-AnalysisTemplateSummary-isSyntheticData"></a>
Indicates if this analysis template summary generated synthetic data.  
Type: Boolean  
Required: No

## See Also
<a name="API_AnalysisTemplateSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AnalysisTemplateSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AnalysisTemplateSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AnalysisTemplateSummary) 

# AnalysisTemplateValidationStatusDetail
<a name="API_AnalysisTemplateValidationStatusDetail"></a>

The status details of the analysis template validation. AWS 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](https://docs.aws.amazon.com/clean-rooms/latest/userguide/analysis-rules-custom.html#custom-diff-privacy).

## Contents
<a name="API_AnalysisTemplateValidationStatusDetail_Contents"></a>

 ** status **   <a name="API-Type-AnalysisTemplateValidationStatusDetail-status"></a>
The status of the validation.  
Type: String  
Valid Values: `VALID | INVALID | UNABLE_TO_VALIDATE`   
Required: Yes

 ** type **   <a name="API-Type-AnalysisTemplateValidationStatusDetail-type"></a>
The type of validation that was performed.  
Type: String  
Valid Values: `DIFFERENTIAL_PRIVACY`   
Required: Yes

 ** reasons **   <a name="API-Type-AnalysisTemplateValidationStatusDetail-reasons"></a>
The reasons for the validation results.  
Type: Array of [AnalysisTemplateValidationStatusReason](API_AnalysisTemplateValidationStatusReason.md) objects  
Required: No

## See Also
<a name="API_AnalysisTemplateValidationStatusDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AnalysisTemplateValidationStatusDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AnalysisTemplateValidationStatusDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AnalysisTemplateValidationStatusDetail) 

# AnalysisTemplateValidationStatusReason
<a name="API_AnalysisTemplateValidationStatusReason"></a>

The reasons for the validation results.

## Contents
<a name="API_AnalysisTemplateValidationStatusReason_Contents"></a>

 ** message **   <a name="API-Type-AnalysisTemplateValidationStatusReason-message"></a>
The validation message.  
Type: String  
Required: Yes

## See Also
<a name="API_AnalysisTemplateValidationStatusReason_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AnalysisTemplateValidationStatusReason) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AnalysisTemplateValidationStatusReason) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AnalysisTemplateValidationStatusReason) 

# ApprovalStatusDetails
<a name="API_ApprovalStatusDetails"></a>

Contains detailed information about the approval state of a given member in the collaboration for a given collaboration change request.

## Contents
<a name="API_ApprovalStatusDetails_Contents"></a>

 ** status **   <a name="API-Type-ApprovalStatusDetails-status"></a>
The approval status of a member's vote on the change request. Valid values are PENDING (if they haven't voted), APPROVED, or DENIED.  
Type: String  
Valid Values: `APPROVED | DENIED | PENDING`   
Required: Yes

## See Also
<a name="API_ApprovalStatusDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ApprovalStatusDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ApprovalStatusDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ApprovalStatusDetails) 

# AthenaTableReference
<a name="API_AthenaTableReference"></a>

 A reference to a table within Athena.

## Contents
<a name="API_AthenaTableReference_Contents"></a>

 ** databaseName **   <a name="API-Type-AthenaTableReference-databaseName"></a>
 The database name.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_](([a-zA-Z0-9_]+-)*([a-zA-Z0-9_]+))?`   
Required: Yes

 ** tableName **   <a name="API-Type-AthenaTableReference-tableName"></a>
 The table reference.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_](([a-zA-Z0-9_]+)*([a-zA-Z0-9_]+))?`   
Required: Yes

 ** workGroup **   <a name="API-Type-AthenaTableReference-workGroup"></a>
 The workgroup of the Athena table reference.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `([a-zA-Z0-9._-])*`   
Required: Yes

 ** catalogName **   <a name="API-Type-AthenaTableReference-catalogName"></a>
 The catalog name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: No

 ** outputLocation **   <a name="API-Type-AthenaTableReference-outputLocation"></a>
 The output location for the Athena table.  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 1024.  
Pattern: `s3://[a-z0-9.-]{3,63}(.*)`   
Required: No

 ** region **   <a name="API-Type-AthenaTableReference-region"></a>
The AWS Region where the Athena table is located. This parameter is required to uniquely identify and access tables across different Regions.  
Type: String  
Valid Values: `us-west-1 | us-west-2 | us-east-1 | us-east-2 | af-south-1 | ap-east-1 | ap-south-2 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ap-southeast-5 | ap-southeast-4 | ap-southeast-7 | ap-south-1 | ap-northeast-3 | ap-northeast-1 | ap-northeast-2 | ca-central-1 | ca-west-1 | eu-south-1 | eu-west-3 | eu-south-2 | eu-central-2 | eu-central-1 | eu-north-1 | eu-west-1 | eu-west-2 | me-south-1 | me-central-1 | il-central-1 | sa-east-1 | mx-central-1 | ap-east-2`   
Required: No

## See Also
<a name="API_AthenaTableReference_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/AthenaTableReference) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/AthenaTableReference) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/AthenaTableReference) 

# BatchGetCollaborationAnalysisTemplateError
<a name="API_BatchGetCollaborationAnalysisTemplateError"></a>

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

## Contents
<a name="API_BatchGetCollaborationAnalysisTemplateError_Contents"></a>

 ** arn **   <a name="API-Type-BatchGetCollaborationAnalysisTemplateError-arn"></a>
The Amazon Resource Name (ARN) of the analysis template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Pattern: `arn:aws[-a-z]*:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/analysistemplate/[\d\w-]+`   
Required: Yes

 ** code **   <a name="API-Type-BatchGetCollaborationAnalysisTemplateError-code"></a>
An error code for the error.  
Type: String  
Required: Yes

 ** message **   <a name="API-Type-BatchGetCollaborationAnalysisTemplateError-message"></a>
A description of why the call failed.  
Type: String  
Required: Yes

## See Also
<a name="API_BatchGetCollaborationAnalysisTemplateError_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/BatchGetCollaborationAnalysisTemplateError) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/BatchGetCollaborationAnalysisTemplateError) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/BatchGetCollaborationAnalysisTemplateError) 

# BatchGetSchemaAnalysisRuleError
<a name="API_BatchGetSchemaAnalysisRuleError"></a>

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

## Contents
<a name="API_BatchGetSchemaAnalysisRuleError_Contents"></a>

 ** code **   <a name="API-Type-BatchGetSchemaAnalysisRuleError-code"></a>
An error code for the error.  
Type: String  
Required: Yes

 ** message **   <a name="API-Type-BatchGetSchemaAnalysisRuleError-message"></a>
A description of why the call failed.  
Type: String  
Required: Yes

 ** name **   <a name="API-Type-BatchGetSchemaAnalysisRuleError-name"></a>
An error name for the error.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?`   
Required: Yes

 ** type **   <a name="API-Type-BatchGetSchemaAnalysisRuleError-type"></a>
The analysis rule type.  
Type: String  
Valid Values: `AGGREGATION | LIST | CUSTOM | ID_MAPPING_TABLE`   
Required: Yes

## See Also
<a name="API_BatchGetSchemaAnalysisRuleError_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/BatchGetSchemaAnalysisRuleError) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/BatchGetSchemaAnalysisRuleError) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/BatchGetSchemaAnalysisRuleError) 

# BatchGetSchemaError
<a name="API_BatchGetSchemaError"></a>

An error describing why a schema could not be fetched.

## Contents
<a name="API_BatchGetSchemaError_Contents"></a>

 ** code **   <a name="API-Type-BatchGetSchemaError-code"></a>
An error code for the error.   
Type: String  
Required: Yes

 ** message **   <a name="API-Type-BatchGetSchemaError-message"></a>
An error message for the error.  
Type: String  
Required: Yes

 ** name **   <a name="API-Type-BatchGetSchemaError-name"></a>
An error name for the error.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?`   
Required: Yes

## See Also
<a name="API_BatchGetSchemaError_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/BatchGetSchemaError) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/BatchGetSchemaError) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/BatchGetSchemaError) 

# BilledJobResourceUtilization
<a name="API_BilledJobResourceUtilization"></a>

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

## Contents
<a name="API_BilledJobResourceUtilization_Contents"></a>

 ** units **   <a name="API-Type-BilledJobResourceUtilization-units"></a>
 The number of Clean Rooms Processing Unit (CRPU) hours that have been billed.  
Type: Double  
Required: Yes

## See Also
<a name="API_BilledJobResourceUtilization_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/BilledJobResourceUtilization) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/BilledJobResourceUtilization) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/BilledJobResourceUtilization) 

# BilledResourceUtilization
<a name="API_BilledResourceUtilization"></a>

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

## Contents
<a name="API_BilledResourceUtilization_Contents"></a>

 ** units **   <a name="API-Type-BilledResourceUtilization-units"></a>
 The number of Clean Rooms Processing Unit (CRPU) hours that have been billed.  
Type: Double  
Required: Yes

## See Also
<a name="API_BilledResourceUtilization_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/BilledResourceUtilization) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/BilledResourceUtilization) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/BilledResourceUtilization) 

# BudgetParameter
<a name="API_BudgetParameter"></a>

Individual budget parameter configuration that defines specific budget allocation settings for access budgets.

## Contents
<a name="API_BudgetParameter_Contents"></a>

 ** budget **   <a name="API-Type-BudgetParameter-budget"></a>
The budget allocation amount for this specific parameter.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1000000.  
Required: Yes

 ** type **   <a name="API-Type-BudgetParameter-type"></a>
The type of budget parameter being configured.  
Type: String  
Valid Values: `CALENDAR_DAY | CALENDAR_MONTH | CALENDAR_WEEK | LIFETIME`   
Required: Yes

 ** autoRefresh **   <a name="API-Type-BudgetParameter-autoRefresh"></a>
Whether this individual budget parameter automatically refreshes when the budget period resets.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

## See Also
<a name="API_BudgetParameter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/BudgetParameter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/BudgetParameter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/BudgetParameter) 

# Change
<a name="API_Change"></a>

Represents a single change within a collaboration change request, containing the change identifier and specification.

## Contents
<a name="API_Change_Contents"></a>

 ** specification **   <a name="API-Type-Change-specification"></a>
The specification details for this change.  
Type: [ChangeSpecification](API_ChangeSpecification.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** specificationType **   <a name="API-Type-Change-specificationType"></a>
The type of specification for this change.  
Type: String  
Valid Values: `MEMBER | COLLABORATION`   
Required: Yes

 ** types **   <a name="API-Type-Change-types"></a>
The list of change types that were applied.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Valid Values: `ADD_MEMBER | GRANT_RECEIVE_RESULTS_ABILITY | REVOKE_RECEIVE_RESULTS_ABILITY | EDIT_AUTO_APPROVED_CHANGE_TYPES`   
Required: Yes

## See Also
<a name="API_Change_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/Change) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/Change) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/Change) 

# ChangeInput
<a name="API_ChangeInput"></a>

Specifies a change to apply to a collaboration.

## Contents
<a name="API_ChangeInput_Contents"></a>

 ** specification **   <a name="API-Type-ChangeInput-specification"></a>
The specification details for the change. The structure depends on the specification type.  
Type: [ChangeSpecification](API_ChangeSpecification.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** specificationType **   <a name="API-Type-ChangeInput-specificationType"></a>
The type of specification for the change. Currently supports `MEMBER` for member-related changes.  
Type: String  
Valid Values: `MEMBER | COLLABORATION`   
Required: Yes

## See Also
<a name="API_ChangeInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ChangeInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ChangeInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ChangeInput) 

# ChangeSpecification
<a name="API_ChangeSpecification"></a>

A union that contains the specification details for different types of changes.

## Contents
<a name="API_ChangeSpecification_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** collaboration **   <a name="API-Type-ChangeSpecification-collaboration"></a>
The collaboration configuration changes being requested. Currently, this only supports modifying which change types are auto-approved for the collaboration.  
Type: [CollaborationChangeSpecification](API_CollaborationChangeSpecification.md) object  
Required: No

 ** member **   <a name="API-Type-ChangeSpecification-member"></a>
The member change specification when the change type is `MEMBER`.  
Type: [MemberChangeSpecification](API_MemberChangeSpecification.md) object  
Required: No

## See Also
<a name="API_ChangeSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ChangeSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ChangeSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ChangeSpecification) 

# Collaboration
<a name="API_Collaboration"></a>

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

## Contents
<a name="API_Collaboration_Contents"></a>

 ** arn **   <a name="API-Type-Collaboration-arn"></a>
The unique ARN for the collaboration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** createTime **   <a name="API-Type-Collaboration-createTime"></a>
The time when the collaboration was created.  
Type: Timestamp  
Required: Yes

 ** creatorAccountId **   <a name="API-Type-Collaboration-creatorAccountId"></a>
The identifier used to reference members of the collaboration. Currently only supports AWS account ID.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: Yes

 ** creatorDisplayName **   <a name="API-Type-Collaboration-creatorDisplayName"></a>
A display name of the collaboration creator.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*`   
Required: Yes

 ** id **   <a name="API-Type-Collaboration-id"></a>
The unique ID for the collaboration.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** memberStatus **   <a name="API-Type-Collaboration-memberStatus"></a>
The status of a member in a collaboration.  
Type: String  
Valid Values: `INVITED | ACTIVE | LEFT | REMOVED`   
Required: Yes

 ** name **   <a name="API-Type-Collaboration-name"></a>
A human-readable identifier provided by the collaboration owner. Display names are not unique.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*`   
Required: Yes

 ** queryLogStatus **   <a name="API-Type-Collaboration-queryLogStatus"></a>
An indicator as to whether query logging has been enabled or disabled for the collaboration.  
When `ENABLED`, AWS Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is `DISABLED`.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: Yes

 ** updateTime **   <a name="API-Type-Collaboration-updateTime"></a>
The time the collaboration metadata was last updated.  
Type: Timestamp  
Required: Yes

 ** allowedResultRegions **   <a name="API-Type-Collaboration-allowedResultRegions"></a>
The AWS Regions where collaboration query results can be stored. Returns the list of Region identifiers that were specified when the collaboration was created. This list is used to enforce regional storage policies and compliance requirements.  
Type: Array of strings  
Valid Values: `us-west-1 | us-west-2 | us-east-1 | us-east-2 | af-south-1 | ap-east-1 | ap-east-2 | ap-south-2 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ap-southeast-5 | ap-southeast-4 | ap-southeast-7 | ap-south-1 | ap-northeast-3 | ap-northeast-1 | ap-northeast-2 | ca-central-1 | ca-west-1 | eu-south-1 | eu-west-3 | eu-south-2 | eu-central-2 | eu-central-1 | eu-north-1 | eu-west-1 | eu-west-2 | me-south-1 | me-central-1 | il-central-1 | sa-east-1 | mx-central-1`   
Required: No

 ** analyticsEngine **   <a name="API-Type-Collaboration-analyticsEngine"></a>
 The analytics engine for the collaboration.  
After July 16, 2025, the `CLEAN_ROOMS_SQL` parameter will no longer be available. 
Type: String  
Valid Values: `SPARK | CLEAN_ROOMS_SQL`   
Required: No

 ** autoApprovedChangeTypes **   <a name="API-Type-Collaboration-autoApprovedChangeTypes"></a>
The types of change requests that are automatically approved for this collaboration.  
Type: Array of strings  
Valid Values: `ADD_MEMBER | GRANT_RECEIVE_RESULTS_ABILITY | REVOKE_RECEIVE_RESULTS_ABILITY`   
Required: No

 ** dataEncryptionMetadata **   <a name="API-Type-Collaboration-dataEncryptionMetadata"></a>
The settings for client-side encryption for cryptographic computing.  
Type: [DataEncryptionMetadata](API_DataEncryptionMetadata.md) object  
Required: No

 ** description **   <a name="API-Type-Collaboration-description"></a>
A description of the collaboration provided by the collaboration owner.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*`   
Required: No

 ** isMetricsEnabled **   <a name="API-Type-Collaboration-isMetricsEnabled"></a>
An indicator as to whether metrics are enabled for the collaboration.  
When `true`, collaboration members can opt in to Amazon CloudWatch metrics for their membership queries.  
Type: Boolean  
Required: No

 ** jobLogStatus **   <a name="API-Type-Collaboration-jobLogStatus"></a>
An indicator as to whether job logging has been enabled or disabled for the collaboration.   
When `ENABLED`, AWS Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is `DISABLED`.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** membershipArn **   <a name="API-Type-Collaboration-membershipArn"></a>
The unique ARN for your membership within the collaboration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+`   
Required: No

 ** membershipId **   <a name="API-Type-Collaboration-membershipId"></a>
The unique ID for your membership within the collaboration.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

## See Also
<a name="API_Collaboration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/Collaboration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/Collaboration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/Collaboration) 

# CollaborationAnalysisTemplate
<a name="API_CollaborationAnalysisTemplate"></a>

The analysis template within a collaboration.

## Contents
<a name="API_CollaborationAnalysisTemplate_Contents"></a>

 ** arn **   <a name="API-Type-CollaborationAnalysisTemplate-arn"></a>
The Amazon Resource Name (ARN) of the analysis template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Pattern: `arn:aws[-a-z]*:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/analysistemplate/[\d\w-]+`   
Required: Yes

 ** collaborationArn **   <a name="API-Type-CollaborationAnalysisTemplate-collaborationArn"></a>
The unique ARN for the analysis template’s associated collaboration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** collaborationId **   <a name="API-Type-CollaborationAnalysisTemplate-collaborationId"></a>
A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** createTime **   <a name="API-Type-CollaborationAnalysisTemplate-createTime"></a>
The time that the analysis template within a collaboration was created.  
Type: Timestamp  
Required: Yes

 ** creatorAccountId **   <a name="API-Type-CollaborationAnalysisTemplate-creatorAccountId"></a>
The identifier used to reference members of the collaboration. Currently only supports AWS account ID.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: Yes

 ** format **   <a name="API-Type-CollaborationAnalysisTemplate-format"></a>
The format of the analysis template in the collaboration.  
Type: String  
Valid Values: `SQL | PYSPARK_1_0`   
Required: Yes

 ** id **   <a name="API-Type-CollaborationAnalysisTemplate-id"></a>
The identifier of the analysis template.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** name **   <a name="API-Type-CollaborationAnalysisTemplate-name"></a>
The name of the analysis template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?`   
Required: Yes

 ** schema **   <a name="API-Type-CollaborationAnalysisTemplate-schema"></a>
The entire schema object.  
Type: [AnalysisSchema](API_AnalysisSchema.md) object  
Required: Yes

 ** updateTime **   <a name="API-Type-CollaborationAnalysisTemplate-updateTime"></a>
The time that the analysis template in the collaboration was last updated.  
Type: Timestamp  
Required: Yes

 ** analysisParameters **   <a name="API-Type-CollaborationAnalysisTemplate-analysisParameters"></a>
The analysis parameters that have been specified in the analysis template.  
Type: Array of [AnalysisParameter](API_AnalysisParameter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

 ** description **   <a name="API-Type-CollaborationAnalysisTemplate-description"></a>
The description of the analysis template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*`   
Required: No

 ** errorMessageConfiguration **   <a name="API-Type-CollaborationAnalysisTemplate-errorMessageConfiguration"></a>
The configuration that specifies the level of detail in error messages returned by analyses using this template. When set to `DETAILED`, error messages include more information to help troubleshoot issues with PySpark jobs. Detailed error messages may expose underlying data, including sensitive information. Recommended for faster troubleshooting in development and testing environments.  
Type: [ErrorMessageConfiguration](API_ErrorMessageConfiguration.md) object  
Required: No

 ** source **   <a name="API-Type-CollaborationAnalysisTemplate-source"></a>
The source of the analysis template within a collaboration.  
Type: [AnalysisSource](API_AnalysisSource.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** sourceMetadata **   <a name="API-Type-CollaborationAnalysisTemplate-sourceMetadata"></a>
 The source metadata for the collaboration analysis template.  
Type: [AnalysisSourceMetadata](API_AnalysisSourceMetadata.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** syntheticDataParameters **   <a name="API-Type-CollaborationAnalysisTemplate-syntheticDataParameters"></a>
The synthetic data generation parameters configured for this collaboration analysis template.  
Type: [SyntheticDataParameters](API_SyntheticDataParameters.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** validations **   <a name="API-Type-CollaborationAnalysisTemplate-validations"></a>
The validations that were performed.  
Type: Array of [AnalysisTemplateValidationStatusDetail](API_AnalysisTemplateValidationStatusDetail.md) objects  
Required: No

## See Also
<a name="API_CollaborationAnalysisTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/CollaborationAnalysisTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/CollaborationAnalysisTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/CollaborationAnalysisTemplate) 

# CollaborationAnalysisTemplateSummary
<a name="API_CollaborationAnalysisTemplateSummary"></a>

The metadata of the analysis template within a collaboration.

## Contents
<a name="API_CollaborationAnalysisTemplateSummary_Contents"></a>

 ** arn **   <a name="API-Type-CollaborationAnalysisTemplateSummary-arn"></a>
The Amazon Resource Name (ARN) of the analysis template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Pattern: `arn:aws[-a-z]*:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/analysistemplate/[\d\w-]+`   
Required: Yes

 ** collaborationArn **   <a name="API-Type-CollaborationAnalysisTemplateSummary-collaborationArn"></a>
The unique ARN for the analysis template’s associated collaboration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** collaborationId **   <a name="API-Type-CollaborationAnalysisTemplateSummary-collaborationId"></a>
A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** createTime **   <a name="API-Type-CollaborationAnalysisTemplateSummary-createTime"></a>
The time that the summary of the analysis template in a collaboration was created.  
Type: Timestamp  
Required: Yes

 ** creatorAccountId **   <a name="API-Type-CollaborationAnalysisTemplateSummary-creatorAccountId"></a>
The identifier used to reference members of the collaboration. Currently only supports AWS account ID.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: Yes

 ** id **   <a name="API-Type-CollaborationAnalysisTemplateSummary-id"></a>
The identifier of the analysis template.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** name **   <a name="API-Type-CollaborationAnalysisTemplateSummary-name"></a>
The name of the analysis template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?`   
Required: Yes

 ** updateTime **   <a name="API-Type-CollaborationAnalysisTemplateSummary-updateTime"></a>
The time that the summary of the analysis template in the collaboration was last updated.  
Type: Timestamp  
Required: Yes

 ** description **   <a name="API-Type-CollaborationAnalysisTemplateSummary-description"></a>
The description of the analysis template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*`   
Required: No

 ** isSyntheticData **   <a name="API-Type-CollaborationAnalysisTemplateSummary-isSyntheticData"></a>
Indicates if this collaboration analysis template uses synthetic data generation.  
Type: Boolean  
Required: No

## See Also
<a name="API_CollaborationAnalysisTemplateSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/CollaborationAnalysisTemplateSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/CollaborationAnalysisTemplateSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/CollaborationAnalysisTemplateSummary) 

# CollaborationChangeRequest
<a name="API_CollaborationChangeRequest"></a>

Represents a request to modify a collaboration. Change requests enable structured modifications to collaborations after they have been created.

## Contents
<a name="API_CollaborationChangeRequest_Contents"></a>

 ** changes **   <a name="API-Type-CollaborationChangeRequest-changes"></a>
The list of changes specified in this change request.  
Type: Array of [Change](API_Change.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: Yes

 ** collaborationId **   <a name="API-Type-CollaborationChangeRequest-collaborationId"></a>
The unique identifier for the collaboration being modified.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** createTime **   <a name="API-Type-CollaborationChangeRequest-createTime"></a>
The time when the change request was created.  
Type: Timestamp  
Required: Yes

 ** id **   <a name="API-Type-CollaborationChangeRequest-id"></a>
The unique identifier for the change request.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** isAutoApproved **   <a name="API-Type-CollaborationChangeRequest-isAutoApproved"></a>
Whether the change request was automatically approved based on the collaboration's auto-approval settings.  
Type: Boolean  
Required: Yes

 ** status **   <a name="API-Type-CollaborationChangeRequest-status"></a>
The current status of the change request. Valid values are `PENDING`, `APPROVED`, `DENIED`, `COMMITTED`, and `CANCELLED`.  
Type: String  
Valid Values: `PENDING | APPROVED | CANCELLED | DENIED | COMMITTED`   
Required: Yes

 ** updateTime **   <a name="API-Type-CollaborationChangeRequest-updateTime"></a>
The time when the change request was last updated.  
Type: Timestamp  
Required: Yes

 ** approvals **   <a name="API-Type-CollaborationChangeRequest-approvals"></a>
A list of approval details from collaboration members, including approval status and multi-party approval workflow information.  
Type: String to [ApprovalStatusDetails](API_ApprovalStatusDetails.md) object map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Fixed length of 12.  
Key Pattern: `\d+`   
Required: No

## See Also
<a name="API_CollaborationChangeRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/CollaborationChangeRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/CollaborationChangeRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/CollaborationChangeRequest) 

# CollaborationChangeRequestSummary
<a name="API_CollaborationChangeRequestSummary"></a>

Summary information about a collaboration change request.

## Contents
<a name="API_CollaborationChangeRequestSummary_Contents"></a>

 ** changes **   <a name="API-Type-CollaborationChangeRequestSummary-changes"></a>
Summary of the changes in this change request.  
Type: Array of [Change](API_Change.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: Yes

 ** collaborationId **   <a name="API-Type-CollaborationChangeRequestSummary-collaborationId"></a>
The unique identifier for the collaboration.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** createTime **   <a name="API-Type-CollaborationChangeRequestSummary-createTime"></a>
The time when the change request was created.  
Type: Timestamp  
Required: Yes

 ** id **   <a name="API-Type-CollaborationChangeRequestSummary-id"></a>
The unique identifier for the change request.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** isAutoApproved **   <a name="API-Type-CollaborationChangeRequestSummary-isAutoApproved"></a>
Whether the change request was automatically approved.  
Type: Boolean  
Required: Yes

 ** status **   <a name="API-Type-CollaborationChangeRequestSummary-status"></a>
The current status of the change request.  
Type: String  
Valid Values: `PENDING | APPROVED | CANCELLED | DENIED | COMMITTED`   
Required: Yes

 ** updateTime **   <a name="API-Type-CollaborationChangeRequestSummary-updateTime"></a>
The time when the change request was last updated.  
Type: Timestamp  
Required: Yes

 ** approvals **   <a name="API-Type-CollaborationChangeRequestSummary-approvals"></a>
Summary of approval statuses from all collaboration members for this change request.  
Type: String to [ApprovalStatusDetails](API_ApprovalStatusDetails.md) object map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Fixed length of 12.  
Key Pattern: `\d+`   
Required: No

## See Also
<a name="API_CollaborationChangeRequestSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/CollaborationChangeRequestSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/CollaborationChangeRequestSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/CollaborationChangeRequestSummary) 

# CollaborationChangeSpecification
<a name="API_CollaborationChangeSpecification"></a>

Defines the specific changes being requested for a collaboration, including configuration modifications and approval requirements.

## Contents
<a name="API_CollaborationChangeSpecification_Contents"></a>

 ** autoApprovedChangeTypes **   <a name="API-Type-CollaborationChangeSpecification-autoApprovedChangeTypes"></a>
Defines requested updates to properties of the collaboration. Currently, this only supports modifying which change types are auto-approved for the collaboration.  
Type: Array of strings  
Valid Values: `ADD_MEMBER | GRANT_RECEIVE_RESULTS_ABILITY | REVOKE_RECEIVE_RESULTS_ABILITY`   
Required: No

## See Also
<a name="API_CollaborationChangeSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/CollaborationChangeSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/CollaborationChangeSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/CollaborationChangeSpecification) 

# CollaborationConfiguredAudienceModelAssociation
<a name="API_CollaborationConfiguredAudienceModelAssociation"></a>

The configured audience model association within a collaboration.

## Contents
<a name="API_CollaborationConfiguredAudienceModelAssociation_Contents"></a>

 ** arn **   <a name="API-Type-CollaborationConfiguredAudienceModelAssociation-arn"></a>
The Amazon Resource Name (ARN) of the configured audience model association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/configuredaudiencemodelassociation/[\d\w-]+`   
Required: Yes

 ** collaborationArn **   <a name="API-Type-CollaborationConfiguredAudienceModelAssociation-collaborationArn"></a>
The unique ARN for the configured audience model's associated collaboration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** collaborationId **   <a name="API-Type-CollaborationConfiguredAudienceModelAssociation-collaborationId"></a>
A unique identifier for the collaboration that the configured audience model associations belong to. Accepts collaboration ID.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** configuredAudienceModelArn **   <a name="API-Type-CollaborationConfiguredAudienceModelAssociation-configuredAudienceModelArn"></a>
The Amazon Resource Name (ARN) of the configure audience model.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:configured-audience-model/[-a-zA-Z0-9_/.]+`   
Required: Yes

 ** createTime **   <a name="API-Type-CollaborationConfiguredAudienceModelAssociation-createTime"></a>
The time at which the configured audience model association was created.  
Type: Timestamp  
Required: Yes

 ** creatorAccountId **   <a name="API-Type-CollaborationConfiguredAudienceModelAssociation-creatorAccountId"></a>
The identifier used to reference members of the collaboration. Only supports AWS account ID.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: Yes

 ** id **   <a name="API-Type-CollaborationConfiguredAudienceModelAssociation-id"></a>
The identifier of the configured audience model association.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** name **   <a name="API-Type-CollaborationConfiguredAudienceModelAssociation-name"></a>
The name of the configured audience model association.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*`   
Required: Yes

 ** updateTime **   <a name="API-Type-CollaborationConfiguredAudienceModelAssociation-updateTime"></a>
The most recent time at which the configured audience model association was updated.  
Type: Timestamp  
Required: Yes

 ** description **   <a name="API-Type-CollaborationConfiguredAudienceModelAssociation-description"></a>
The description of the configured audience model association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*`   
Required: No

## See Also
<a name="API_CollaborationConfiguredAudienceModelAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/CollaborationConfiguredAudienceModelAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/CollaborationConfiguredAudienceModelAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/CollaborationConfiguredAudienceModelAssociation) 

# CollaborationConfiguredAudienceModelAssociationSummary
<a name="API_CollaborationConfiguredAudienceModelAssociationSummary"></a>

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

## Contents
<a name="API_CollaborationConfiguredAudienceModelAssociationSummary_Contents"></a>

 ** arn **   <a name="API-Type-CollaborationConfiguredAudienceModelAssociationSummary-arn"></a>
The Amazon Resource Name (ARN) of the configured audience model association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/configuredaudiencemodelassociation/[\d\w-]+`   
Required: Yes

 ** collaborationArn **   <a name="API-Type-CollaborationConfiguredAudienceModelAssociationSummary-collaborationArn"></a>
The unique ARN for the configured audience model's associated collaboration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** collaborationId **   <a name="API-Type-CollaborationConfiguredAudienceModelAssociationSummary-collaborationId"></a>
A unique identifier for the collaboration that the configured audience model associations belong to. Accepts collaboration ID.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** createTime **   <a name="API-Type-CollaborationConfiguredAudienceModelAssociationSummary-createTime"></a>
The time at which the configured audience model association was created.  
Type: Timestamp  
Required: Yes

 ** creatorAccountId **   <a name="API-Type-CollaborationConfiguredAudienceModelAssociationSummary-creatorAccountId"></a>
The identifier used to reference members of the collaboration. Only supports AWS account ID.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: Yes

 ** id **   <a name="API-Type-CollaborationConfiguredAudienceModelAssociationSummary-id"></a>
The identifier of the configured audience model association.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** name **   <a name="API-Type-CollaborationConfiguredAudienceModelAssociationSummary-name"></a>
The name of the configured audience model association.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*`   
Required: Yes

 ** updateTime **   <a name="API-Type-CollaborationConfiguredAudienceModelAssociationSummary-updateTime"></a>
The most recent time at which the configured audience model association was updated.  
Type: Timestamp  
Required: Yes

 ** description **   <a name="API-Type-CollaborationConfiguredAudienceModelAssociationSummary-description"></a>
The description of the configured audience model association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*`   
Required: No

## See Also
<a name="API_CollaborationConfiguredAudienceModelAssociationSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/CollaborationConfiguredAudienceModelAssociationSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/CollaborationConfiguredAudienceModelAssociationSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/CollaborationConfiguredAudienceModelAssociationSummary) 

# CollaborationIdNamespaceAssociation
<a name="API_CollaborationIdNamespaceAssociation"></a>

Defines details for the collaboration ID namespace association.

## Contents
<a name="API_CollaborationIdNamespaceAssociation_Contents"></a>

 ** arn **   <a name="API-Type-CollaborationIdNamespaceAssociation-arn"></a>
The Amazon Resource Name (ARN) of the collaboration ID namespace association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/idnamespaceassociation/[\d\w-]+`   
Required: Yes

 ** collaborationArn **   <a name="API-Type-CollaborationIdNamespaceAssociation-collaborationArn"></a>
The Amazon Resource Name (ARN) of the collaboration that contains the collaboration ID namespace association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** collaborationId **   <a name="API-Type-CollaborationIdNamespaceAssociation-collaborationId"></a>
The unique identifier of the collaboration that contains the collaboration ID namespace association.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** createTime **   <a name="API-Type-CollaborationIdNamespaceAssociation-createTime"></a>
The time at which the collaboration ID namespace association was created.  
Type: Timestamp  
Required: Yes

 ** creatorAccountId **   <a name="API-Type-CollaborationIdNamespaceAssociation-creatorAccountId"></a>
The unique identifier of the AWS account that created the collaboration ID namespace association.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: Yes

 ** id **   <a name="API-Type-CollaborationIdNamespaceAssociation-id"></a>
The unique identifier of the collaboration ID namespace association.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** inputReferenceConfig **   <a name="API-Type-CollaborationIdNamespaceAssociation-inputReferenceConfig"></a>
The input reference configuration that's necessary to create the collaboration ID namespace association.  
Type: [IdNamespaceAssociationInputReferenceConfig](API_IdNamespaceAssociationInputReferenceConfig.md) object  
Required: Yes

 ** inputReferenceProperties **   <a name="API-Type-CollaborationIdNamespaceAssociation-inputReferenceProperties"></a>
The input reference properties that are needed to create the collaboration ID namespace association.  
Type: [IdNamespaceAssociationInputReferenceProperties](API_IdNamespaceAssociationInputReferenceProperties.md) object  
Required: Yes

 ** name **   <a name="API-Type-CollaborationIdNamespaceAssociation-name"></a>
The name of the collaboration ID namespace association.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*`   
Required: Yes

 ** updateTime **   <a name="API-Type-CollaborationIdNamespaceAssociation-updateTime"></a>
The most recent time at which the collaboration ID namespace was updated.  
Type: Timestamp  
Required: Yes

 ** description **   <a name="API-Type-CollaborationIdNamespaceAssociation-description"></a>
The description of the collaboration ID namespace association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*`   
Required: No

 ** idMappingConfig **   <a name="API-Type-CollaborationIdNamespaceAssociation-idMappingConfig"></a>
The configuration settings for the ID mapping table.  
Type: [IdMappingConfig](API_IdMappingConfig.md) object  
Required: No

## See Also
<a name="API_CollaborationIdNamespaceAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/CollaborationIdNamespaceAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/CollaborationIdNamespaceAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/CollaborationIdNamespaceAssociation) 

# CollaborationIdNamespaceAssociationSummary
<a name="API_CollaborationIdNamespaceAssociationSummary"></a>

Provides summary information about the collaboration ID namespace association.

## Contents
<a name="API_CollaborationIdNamespaceAssociationSummary_Contents"></a>

 ** arn **   <a name="API-Type-CollaborationIdNamespaceAssociationSummary-arn"></a>
The Amazon Resource Name (ARN) of the collaboration ID namespace association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/idnamespaceassociation/[\d\w-]+`   
Required: Yes

 ** collaborationArn **   <a name="API-Type-CollaborationIdNamespaceAssociationSummary-collaborationArn"></a>
The Amazon Resource Name (ARN) of the collaboration that contains this collaboration ID namespace association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** collaborationId **   <a name="API-Type-CollaborationIdNamespaceAssociationSummary-collaborationId"></a>
The unique identifier of the collaboration that contains this collaboration ID namespace association.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** createTime **   <a name="API-Type-CollaborationIdNamespaceAssociationSummary-createTime"></a>
The time at which the collaboration ID namespace association was created.  
Type: Timestamp  
Required: Yes

 ** creatorAccountId **   <a name="API-Type-CollaborationIdNamespaceAssociationSummary-creatorAccountId"></a>
The AWS account that created this collaboration ID namespace association.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: Yes

 ** id **   <a name="API-Type-CollaborationIdNamespaceAssociationSummary-id"></a>
The unique identifier of the collaboration ID namespace association.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** inputReferenceConfig **   <a name="API-Type-CollaborationIdNamespaceAssociationSummary-inputReferenceConfig"></a>
The input reference configuration that's used to create the collaboration ID namespace association.  
Type: [IdNamespaceAssociationInputReferenceConfig](API_IdNamespaceAssociationInputReferenceConfig.md) object  
Required: Yes

 ** inputReferenceProperties **   <a name="API-Type-CollaborationIdNamespaceAssociationSummary-inputReferenceProperties"></a>
The input reference properties that are used to create the collaboration ID namespace association.  
Type: [IdNamespaceAssociationInputReferencePropertiesSummary](API_IdNamespaceAssociationInputReferencePropertiesSummary.md) object  
Required: Yes

 ** name **   <a name="API-Type-CollaborationIdNamespaceAssociationSummary-name"></a>
The name of the collaboration ID namespace association.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*`   
Required: Yes

 ** updateTime **   <a name="API-Type-CollaborationIdNamespaceAssociationSummary-updateTime"></a>
The most recent time at which the collaboration ID namespace association was updated.  
Type: Timestamp  
Required: Yes

 ** description **   <a name="API-Type-CollaborationIdNamespaceAssociationSummary-description"></a>
The description of the collaboration ID namepsace association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*`   
Required: No

## See Also
<a name="API_CollaborationIdNamespaceAssociationSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/CollaborationIdNamespaceAssociationSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/CollaborationIdNamespaceAssociationSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/CollaborationIdNamespaceAssociationSummary) 

# CollaborationPrivacyBudgetSummary
<a name="API_CollaborationPrivacyBudgetSummary"></a>

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

## Contents
<a name="API_CollaborationPrivacyBudgetSummary_Contents"></a>

 ** budget **   <a name="API-Type-CollaborationPrivacyBudgetSummary-budget"></a>
The includes epsilon provided and utility in terms of aggregations.  
Type: [PrivacyBudget](API_PrivacyBudget.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** collaborationArn **   <a name="API-Type-CollaborationPrivacyBudgetSummary-collaborationArn"></a>
The ARN of the collaboration that includes this privacy budget.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** collaborationId **   <a name="API-Type-CollaborationPrivacyBudgetSummary-collaborationId"></a>
The unique identifier of the collaboration that includes this privacy budget.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** createTime **   <a name="API-Type-CollaborationPrivacyBudgetSummary-createTime"></a>
The time at which the privacy budget was created.  
Type: Timestamp  
Required: Yes

 ** creatorAccountId **   <a name="API-Type-CollaborationPrivacyBudgetSummary-creatorAccountId"></a>
The unique identifier of the account that created this privacy budget.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: Yes

 ** id **   <a name="API-Type-CollaborationPrivacyBudgetSummary-id"></a>
The unique identifier of the collaboration privacy budget.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** privacyBudgetTemplateArn **   <a name="API-Type-CollaborationPrivacyBudgetSummary-privacyBudgetTemplateArn"></a>
The ARN of the collaboration privacy budget template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:privacybudgettemplate/[\d\w-]+`   
Required: Yes

 ** privacyBudgetTemplateId **   <a name="API-Type-CollaborationPrivacyBudgetSummary-privacyBudgetTemplateId"></a>
The unique identifier of the collaboration privacy budget template.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** type **   <a name="API-Type-CollaborationPrivacyBudgetSummary-type"></a>
The type of privacy budget template.  
Type: String  
Valid Values: `DIFFERENTIAL_PRIVACY | ACCESS_BUDGET`   
Required: Yes

 ** updateTime **   <a name="API-Type-CollaborationPrivacyBudgetSummary-updateTime"></a>
The most recent time at which the privacy budget was updated.  
Type: Timestamp  
Required: Yes

## See Also
<a name="API_CollaborationPrivacyBudgetSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/CollaborationPrivacyBudgetSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/CollaborationPrivacyBudgetSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/CollaborationPrivacyBudgetSummary) 

# CollaborationPrivacyBudgetTemplate
<a name="API_CollaborationPrivacyBudgetTemplate"></a>

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

## Contents
<a name="API_CollaborationPrivacyBudgetTemplate_Contents"></a>

 ** arn **   <a name="API-Type-CollaborationPrivacyBudgetTemplate-arn"></a>
The ARN of the collaboration privacy budget template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:privacybudgettemplate/[\d\w-]+`   
Required: Yes

 ** autoRefresh **   <a name="API-Type-CollaborationPrivacyBudgetTemplate-autoRefresh"></a>
How often the privacy budget refreshes.  
If you plan to regularly bring new data into the collaboration, use `CALENDAR_MONTH` to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.
Type: String  
Valid Values: `CALENDAR_MONTH | NONE`   
Required: Yes

 ** collaborationArn **   <a name="API-Type-CollaborationPrivacyBudgetTemplate-collaborationArn"></a>
The ARN of the collaboration that includes this collaboration privacy budget template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** collaborationId **   <a name="API-Type-CollaborationPrivacyBudgetTemplate-collaborationId"></a>
The unique identifier of the collaboration that includes this collaboration privacy budget template.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** createTime **   <a name="API-Type-CollaborationPrivacyBudgetTemplate-createTime"></a>
The time at which the collaboration privacy budget template was created.  
Type: Timestamp  
Required: Yes

 ** creatorAccountId **   <a name="API-Type-CollaborationPrivacyBudgetTemplate-creatorAccountId"></a>
The unique identifier of the account that created this collaboration privacy budget template.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: Yes

 ** id **   <a name="API-Type-CollaborationPrivacyBudgetTemplate-id"></a>
The unique identifier of the collaboration privacy budget template.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** parameters **   <a name="API-Type-CollaborationPrivacyBudgetTemplate-parameters"></a>
Specifies the epsilon and noise parameters for the privacy budget template.  
Type: [PrivacyBudgetTemplateParametersOutput](API_PrivacyBudgetTemplateParametersOutput.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** privacyBudgetType **   <a name="API-Type-CollaborationPrivacyBudgetTemplate-privacyBudgetType"></a>
The type of privacy budget template.  
Type: String  
Valid Values: `DIFFERENTIAL_PRIVACY | ACCESS_BUDGET`   
Required: Yes

 ** updateTime **   <a name="API-Type-CollaborationPrivacyBudgetTemplate-updateTime"></a>
The most recent time at which the collaboration privacy budget template was updated.  
Type: Timestamp  
Required: Yes

## See Also
<a name="API_CollaborationPrivacyBudgetTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/CollaborationPrivacyBudgetTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/CollaborationPrivacyBudgetTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/CollaborationPrivacyBudgetTemplate) 

# CollaborationPrivacyBudgetTemplateSummary
<a name="API_CollaborationPrivacyBudgetTemplateSummary"></a>

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.

## Contents
<a name="API_CollaborationPrivacyBudgetTemplateSummary_Contents"></a>

 ** arn **   <a name="API-Type-CollaborationPrivacyBudgetTemplateSummary-arn"></a>
The ARN of the collaboration privacy budget template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:privacybudgettemplate/[\d\w-]+`   
Required: Yes

 ** collaborationArn **   <a name="API-Type-CollaborationPrivacyBudgetTemplateSummary-collaborationArn"></a>
The ARN of the collaboration that contains this collaboration privacy budget template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** collaborationId **   <a name="API-Type-CollaborationPrivacyBudgetTemplateSummary-collaborationId"></a>
The unique identifier of the collaboration that contains this collaboration privacy budget template.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** createTime **   <a name="API-Type-CollaborationPrivacyBudgetTemplateSummary-createTime"></a>
The time at which the collaboration privacy budget template was created.  
Type: Timestamp  
Required: Yes

 ** creatorAccountId **   <a name="API-Type-CollaborationPrivacyBudgetTemplateSummary-creatorAccountId"></a>
The unique identifier of the account that created this collaboration privacy budget template.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: Yes

 ** id **   <a name="API-Type-CollaborationPrivacyBudgetTemplateSummary-id"></a>
The unique identifier of the collaboration privacy budget template.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** privacyBudgetType **   <a name="API-Type-CollaborationPrivacyBudgetTemplateSummary-privacyBudgetType"></a>
The type of the privacy budget template.  
Type: String  
Valid Values: `DIFFERENTIAL_PRIVACY | ACCESS_BUDGET`   
Required: Yes

 ** updateTime **   <a name="API-Type-CollaborationPrivacyBudgetTemplateSummary-updateTime"></a>
The most recent time at which the collaboration privacy budget template was updated.  
Type: Timestamp  
Required: Yes

## See Also
<a name="API_CollaborationPrivacyBudgetTemplateSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/CollaborationPrivacyBudgetTemplateSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/CollaborationPrivacyBudgetTemplateSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/CollaborationPrivacyBudgetTemplateSummary) 

# CollaborationSummary
<a name="API_CollaborationSummary"></a>

The metadata of the collaboration.

## Contents
<a name="API_CollaborationSummary_Contents"></a>

 ** arn **   <a name="API-Type-CollaborationSummary-arn"></a>
The ARN of the collaboration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** createTime **   <a name="API-Type-CollaborationSummary-createTime"></a>
The time when the collaboration was created.  
Type: Timestamp  
Required: Yes

 ** creatorAccountId **   <a name="API-Type-CollaborationSummary-creatorAccountId"></a>
The identifier used to reference members of the collaboration. Currently only supports AWS account ID.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: Yes

 ** creatorDisplayName **   <a name="API-Type-CollaborationSummary-creatorDisplayName"></a>
The display name of the collaboration creator.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*`   
Required: Yes

 ** id **   <a name="API-Type-CollaborationSummary-id"></a>
The identifier for the collaboration.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** memberStatus **   <a name="API-Type-CollaborationSummary-memberStatus"></a>
The status of a member in a collaboration.  
Type: String  
Valid Values: `INVITED | ACTIVE | LEFT | REMOVED`   
Required: Yes

 ** name **   <a name="API-Type-CollaborationSummary-name"></a>
A human-readable identifier provided by the collaboration owner. Display names are not unique.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*`   
Required: Yes

 ** updateTime **   <a name="API-Type-CollaborationSummary-updateTime"></a>
The time the collaboration metadata was last updated.  
Type: Timestamp  
Required: Yes

 ** analyticsEngine **   <a name="API-Type-CollaborationSummary-analyticsEngine"></a>
 The analytics engine.  
After July 16, 2025, the `CLEAN_ROOMS_SQL` parameter will no longer be available. 
Type: String  
Valid Values: `SPARK | CLEAN_ROOMS_SQL`   
Required: No

 ** membershipArn **   <a name="API-Type-CollaborationSummary-membershipArn"></a>
The ARN of a member in a collaboration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+`   
Required: No

 ** membershipId **   <a name="API-Type-CollaborationSummary-membershipId"></a>
The identifier of a member in a collaboration.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

## See Also
<a name="API_CollaborationSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/CollaborationSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/CollaborationSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/CollaborationSummary) 

# Column
<a name="API_Column"></a>

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

## Contents
<a name="API_Column_Contents"></a>

 ** name **   <a name="API-Type-Column-name"></a>
The name of the column.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?`   
Required: Yes

 ** type **   <a name="API-Type-Column-type"></a>
The type of the column.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*`   
Required: Yes

## See Also
<a name="API_Column_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/Column) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/Column) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/Column) 

# ColumnClassificationDetails
<a name="API_ColumnClassificationDetails"></a>

Contains classification information for data columns, including mappings that specify how columns should be handled during synthetic data generation and privacy analysis.

## Contents
<a name="API_ColumnClassificationDetails_Contents"></a>

 ** columnMapping **   <a name="API-Type-ColumnClassificationDetails-columnMapping"></a>
A mapping that defines the classification of data columns for synthetic data generation and specifies how each column should be handled during the privacy-preserving data synthesis process.  
Type: Array of [SyntheticDataColumnProperties](API_SyntheticDataColumnProperties.md) objects  
Array Members: Minimum number of 5 items. Maximum number of 1000 items.  
Required: Yes

## See Also
<a name="API_ColumnClassificationDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ColumnClassificationDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ColumnClassificationDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ColumnClassificationDetails) 

# ComputeConfiguration
<a name="API_ComputeConfiguration"></a>

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

## Contents
<a name="API_ComputeConfiguration_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** worker **   <a name="API-Type-ComputeConfiguration-worker"></a>
 The worker configuration for the compute environment.  
Type: [WorkerComputeConfiguration](API_WorkerComputeConfiguration.md) object  
Required: No

## See Also
<a name="API_ComputeConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ComputeConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ComputeConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ComputeConfiguration) 

# ConfigurationDetails
<a name="API_ConfigurationDetails"></a>

 The configuration details.

## Contents
<a name="API_ConfigurationDetails_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** directAnalysisConfigurationDetails **   <a name="API-Type-ConfigurationDetails-directAnalysisConfigurationDetails"></a>
 The direct analysis configuration details.  
Type: [DirectAnalysisConfigurationDetails](API_DirectAnalysisConfigurationDetails.md) object  
Required: No

## See Also
<a name="API_ConfigurationDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ConfigurationDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ConfigurationDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ConfigurationDetails) 

# ConfiguredAudienceModelAssociation
<a name="API_ConfiguredAudienceModelAssociation"></a>

Details about the configured audience model association.

## Contents
<a name="API_ConfiguredAudienceModelAssociation_Contents"></a>

 ** arn **   <a name="API-Type-ConfiguredAudienceModelAssociation-arn"></a>
The Amazon Resource Name (ARN) of the configured audience model association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/configuredaudiencemodelassociation/[\d\w-]+`   
Required: Yes

 ** collaborationArn **   <a name="API-Type-ConfiguredAudienceModelAssociation-collaborationArn"></a>
The Amazon Resource Name (ARN) of the collaboration that contains this configured audience model association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** collaborationId **   <a name="API-Type-ConfiguredAudienceModelAssociation-collaborationId"></a>
A unique identifier of the collaboration that contains this configured audience model association.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** configuredAudienceModelArn **   <a name="API-Type-ConfiguredAudienceModelAssociation-configuredAudienceModelArn"></a>
The Amazon Resource Name (ARN) of the configured audience model that was used for this configured audience model association.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:configured-audience-model/[-a-zA-Z0-9_/.]+`   
Required: Yes

 ** createTime **   <a name="API-Type-ConfiguredAudienceModelAssociation-createTime"></a>
The time at which the configured audience model association was created.  
Type: Timestamp  
Required: Yes

 ** id **   <a name="API-Type-ConfiguredAudienceModelAssociation-id"></a>
A unique identifier of the configured audience model association.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** manageResourcePolicies **   <a name="API-Type-ConfiguredAudienceModelAssociation-manageResourcePolicies"></a>
When `TRUE`, indicates that the resource policy for the configured audience model resource being associated is configured for AWS Clean Rooms to manage permissions related to the given collaboration. When `FALSE`, indicates that the configured audience model resource owner will manage permissions related to the given collaboration.  
Type: Boolean  
Required: Yes

 ** membershipArn **   <a name="API-Type-ConfiguredAudienceModelAssociation-membershipArn"></a>
The Amazon Resource Name (ARN) of the membership that contains this configured audience model association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+`   
Required: Yes

 ** membershipId **   <a name="API-Type-ConfiguredAudienceModelAssociation-membershipId"></a>
A unique identifier for the membership that contains this configured audience model association.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** name **   <a name="API-Type-ConfiguredAudienceModelAssociation-name"></a>
The name of the configured audience model association.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*`   
Required: Yes

 ** updateTime **   <a name="API-Type-ConfiguredAudienceModelAssociation-updateTime"></a>
The most recent time at which the configured audience model association was updated.  
Type: Timestamp  
Required: Yes

 ** description **   <a name="API-Type-ConfiguredAudienceModelAssociation-description"></a>
The description of the configured audience model association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*`   
Required: No

## See Also
<a name="API_ConfiguredAudienceModelAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ConfiguredAudienceModelAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ConfiguredAudienceModelAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ConfiguredAudienceModelAssociation) 

# ConfiguredAudienceModelAssociationSummary
<a name="API_ConfiguredAudienceModelAssociationSummary"></a>

A summary of the configured audience model association.

## Contents
<a name="API_ConfiguredAudienceModelAssociationSummary_Contents"></a>

 ** arn **   <a name="API-Type-ConfiguredAudienceModelAssociationSummary-arn"></a>
The Amazon Resource Name (ARN) of the configured audience model association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/configuredaudiencemodelassociation/[\d\w-]+`   
Required: Yes

 ** collaborationArn **   <a name="API-Type-ConfiguredAudienceModelAssociationSummary-collaborationArn"></a>
The Amazon Resource Name (ARN) of the collaboration that contains the configured audience model association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** collaborationId **   <a name="API-Type-ConfiguredAudienceModelAssociationSummary-collaborationId"></a>
A unique identifier of the collaboration that configured audience model is associated with.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** configuredAudienceModelArn **   <a name="API-Type-ConfiguredAudienceModelAssociationSummary-configuredAudienceModelArn"></a>
The Amazon Resource Name (ARN) of the configured audience model that was used for this configured audience model association.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:configured-audience-model/[-a-zA-Z0-9_/.]+`   
Required: Yes

 ** createTime **   <a name="API-Type-ConfiguredAudienceModelAssociationSummary-createTime"></a>
The time at which the configured audience model association was created.  
Type: Timestamp  
Required: Yes

 ** id **   <a name="API-Type-ConfiguredAudienceModelAssociationSummary-id"></a>
A unique identifier of the configured audience model association.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** membershipArn **   <a name="API-Type-ConfiguredAudienceModelAssociationSummary-membershipArn"></a>
The Amazon Resource Name (ARN) of the membership that contains the configured audience model association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+`   
Required: Yes

 ** membershipId **   <a name="API-Type-ConfiguredAudienceModelAssociationSummary-membershipId"></a>
A unique identifier of the membership that contains the configured audience model association.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** name **   <a name="API-Type-ConfiguredAudienceModelAssociationSummary-name"></a>
The name of the configured audience model association.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*`   
Required: Yes

 ** updateTime **   <a name="API-Type-ConfiguredAudienceModelAssociationSummary-updateTime"></a>
The most recent time at which the configured audience model association was updated.  
Type: Timestamp  
Required: Yes

 ** description **   <a name="API-Type-ConfiguredAudienceModelAssociationSummary-description"></a>
The description of the configured audience model association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*`   
Required: No

## See Also
<a name="API_ConfiguredAudienceModelAssociationSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ConfiguredAudienceModelAssociationSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ConfiguredAudienceModelAssociationSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ConfiguredAudienceModelAssociationSummary) 

# ConfiguredTable
<a name="API_ConfiguredTable"></a>

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

## Contents
<a name="API_ConfiguredTable_Contents"></a>

 ** allowedColumns **   <a name="API-Type-ConfiguredTable-allowedColumns"></a>
The columns within the underlying AWS Glue table that can be used within collaborations.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?`   
Required: Yes

 ** analysisMethod **   <a name="API-Type-ConfiguredTable-analysisMethod"></a>
The analysis method for the configured table.  
 `DIRECT_QUERY` allows SQL queries to be run directly on this table.  
 `DIRECT_JOB` allows PySpark jobs to be run directly on this table.  
 `MULTIPLE` allows both SQL queries and PySpark jobs to be run directly on this table.  
Type: String  
Valid Values: `DIRECT_QUERY | DIRECT_JOB | MULTIPLE`   
Required: Yes

 ** analysisRuleTypes **   <a name="API-Type-ConfiguredTable-analysisRuleTypes"></a>
The types of analysis rules associated with this configured table. Currently, only one analysis rule may be associated with a configured table.  
Type: Array of strings  
Valid Values: `AGGREGATION | LIST | CUSTOM`   
Required: Yes

 ** arn **   <a name="API-Type-ConfiguredTable-arn"></a>
The unique ARN for the configured table.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:configuredtable/[\d\w-]+`   
Required: Yes

 ** createTime **   <a name="API-Type-ConfiguredTable-createTime"></a>
The time the configured table was created.  
Type: Timestamp  
Required: Yes

 ** id **   <a name="API-Type-ConfiguredTable-id"></a>
The unique ID for the configured table.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** name **   <a name="API-Type-ConfiguredTable-name"></a>
A name for the configured table.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*`   
Required: Yes

 ** tableReference **   <a name="API-Type-ConfiguredTable-tableReference"></a>
The table that this configured table represents.  
Type: [TableReference](API_TableReference.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** updateTime **   <a name="API-Type-ConfiguredTable-updateTime"></a>
The time the configured table was last updated  
Type: Timestamp  
Required: Yes

 ** description **   <a name="API-Type-ConfiguredTable-description"></a>
A description for the configured table.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*`   
Required: No

 ** selectedAnalysisMethods **   <a name="API-Type-ConfiguredTable-selectedAnalysisMethods"></a>
 The selected analysis methods for the configured table.  
Type: Array of strings  
Valid Values: `DIRECT_QUERY | DIRECT_JOB`   
Required: No

## See Also
<a name="API_ConfiguredTable_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ConfiguredTable) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ConfiguredTable) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ConfiguredTable) 

# ConfiguredTableAnalysisRule
<a name="API_ConfiguredTableAnalysisRule"></a>

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

## Contents
<a name="API_ConfiguredTableAnalysisRule_Contents"></a>

 ** configuredTableArn **   <a name="API-Type-ConfiguredTableAnalysisRule-configuredTableArn"></a>
The unique ARN for the configured table.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:configuredtable/[\d\w-]+`   
Required: Yes

 ** configuredTableId **   <a name="API-Type-ConfiguredTableAnalysisRule-configuredTableId"></a>
The unique ID for the configured table.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** createTime **   <a name="API-Type-ConfiguredTableAnalysisRule-createTime"></a>
The time the configured table analysis rule was created.  
Type: Timestamp  
Required: Yes

 ** policy **   <a name="API-Type-ConfiguredTableAnalysisRule-policy"></a>
The policy that controls SQL query rules.  
Type: [ConfiguredTableAnalysisRulePolicy](API_ConfiguredTableAnalysisRulePolicy.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** type **   <a name="API-Type-ConfiguredTableAnalysisRule-type"></a>
The type of configured table analysis rule.  
Type: String  
Valid Values: `AGGREGATION | LIST | CUSTOM`   
Required: Yes

 ** updateTime **   <a name="API-Type-ConfiguredTableAnalysisRule-updateTime"></a>
The time the configured table analysis rule was last updated.  
Type: Timestamp  
Required: Yes

## See Also
<a name="API_ConfiguredTableAnalysisRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ConfiguredTableAnalysisRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ConfiguredTableAnalysisRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ConfiguredTableAnalysisRule) 

# ConfiguredTableAnalysisRulePolicy
<a name="API_ConfiguredTableAnalysisRulePolicy"></a>

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

## Contents
<a name="API_ConfiguredTableAnalysisRulePolicy_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** v1 **   <a name="API-Type-ConfiguredTableAnalysisRulePolicy-v1"></a>
Controls on the query specifications that can be run on a configured table.  
Type: [ConfiguredTableAnalysisRulePolicyV1](API_ConfiguredTableAnalysisRulePolicyV1.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## See Also
<a name="API_ConfiguredTableAnalysisRulePolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ConfiguredTableAnalysisRulePolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ConfiguredTableAnalysisRulePolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ConfiguredTableAnalysisRulePolicy) 

# ConfiguredTableAnalysisRulePolicyV1
<a name="API_ConfiguredTableAnalysisRulePolicyV1"></a>

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

## Contents
<a name="API_ConfiguredTableAnalysisRulePolicyV1_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** aggregation **   <a name="API-Type-ConfiguredTableAnalysisRulePolicyV1-aggregation"></a>
Analysis rule type that enables only aggregation queries on a configured table.  
Type: [AnalysisRuleAggregation](API_AnalysisRuleAggregation.md) object  
Required: No

 ** custom **   <a name="API-Type-ConfiguredTableAnalysisRulePolicyV1-custom"></a>
A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy.  
Type: [AnalysisRuleCustom](API_AnalysisRuleCustom.md) object  
Required: No

 ** list **   <a name="API-Type-ConfiguredTableAnalysisRulePolicyV1-list"></a>
Analysis rule type that enables only list queries on a configured table.  
Type: [AnalysisRuleList](API_AnalysisRuleList.md) object  
Required: No

## See Also
<a name="API_ConfiguredTableAnalysisRulePolicyV1_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ConfiguredTableAnalysisRulePolicyV1) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ConfiguredTableAnalysisRulePolicyV1) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ConfiguredTableAnalysisRulePolicyV1) 

# ConfiguredTableAssociation
<a name="API_ConfiguredTableAssociation"></a>

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

## Contents
<a name="API_ConfiguredTableAssociation_Contents"></a>

 ** arn **   <a name="API-Type-ConfiguredTableAssociation-arn"></a>
The unique ARN for the configured table association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:configuredtableassociation/[\d\w-]+/[\d\w-]+`   
Required: Yes

 ** configuredTableArn **   <a name="API-Type-ConfiguredTableAssociation-configuredTableArn"></a>
The unique ARN for the configured table that the association refers to.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:configuredtable/[\d\w-]+`   
Required: Yes

 ** configuredTableId **   <a name="API-Type-ConfiguredTableAssociation-configuredTableId"></a>
The unique ID for the configured table that the association refers to.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** createTime **   <a name="API-Type-ConfiguredTableAssociation-createTime"></a>
The time the configured table association was created.  
Type: Timestamp  
Required: Yes

 ** id **   <a name="API-Type-ConfiguredTableAssociation-id"></a>
The unique ID for the configured table association.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** membershipArn **   <a name="API-Type-ConfiguredTableAssociation-membershipArn"></a>
The unique ARN for the membership this configured table association belongs to.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+`   
Required: Yes

 ** membershipId **   <a name="API-Type-ConfiguredTableAssociation-membershipId"></a>
The unique ID for the membership this configured table association belongs to.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** name **   <a name="API-Type-ConfiguredTableAssociation-name"></a>
The name of the configured table association, in lowercase. The table is identified by this name when running protected queries against the underlying data.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?`   
Required: Yes

 ** roleArn **   <a name="API-Type-ConfiguredTableAssociation-roleArn"></a>
The service will assume this role to access catalog metadata and query the table.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 512.  
Pattern: `arn:aws:iam::[\w]+:role/[\w+=./@-]+`   
Required: Yes

 ** updateTime **   <a name="API-Type-ConfiguredTableAssociation-updateTime"></a>
The time the configured table association was last updated.  
Type: Timestamp  
Required: Yes

 ** analysisRuleTypes **   <a name="API-Type-ConfiguredTableAssociation-analysisRuleTypes"></a>
 The analysis rule types for the configured table association.  
Type: Array of strings  
Valid Values: `AGGREGATION | LIST | CUSTOM`   
Required: No

 ** description **   <a name="API-Type-ConfiguredTableAssociation-description"></a>
A description of the configured table association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*`   
Required: No

## See Also
<a name="API_ConfiguredTableAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ConfiguredTableAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ConfiguredTableAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ConfiguredTableAssociation) 

# ConfiguredTableAssociationAnalysisRule
<a name="API_ConfiguredTableAssociationAnalysisRule"></a>

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*.

## Contents
<a name="API_ConfiguredTableAssociationAnalysisRule_Contents"></a>

 ** configuredTableAssociationArn **   <a name="API-Type-ConfiguredTableAssociationAnalysisRule-configuredTableAssociationArn"></a>
 The Amazon Resource Name (ARN) of the configured table association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:configuredtableassociation/[\d\w-]+/[\d\w-]+`   
Required: Yes

 ** configuredTableAssociationId **   <a name="API-Type-ConfiguredTableAssociationAnalysisRule-configuredTableAssociationId"></a>
 The unique identifier for the configured table association.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** createTime **   <a name="API-Type-ConfiguredTableAssociationAnalysisRule-createTime"></a>
 The creation time of the configured table association analysis rule.  
Type: Timestamp  
Required: Yes

 ** membershipIdentifier **   <a name="API-Type-ConfiguredTableAssociationAnalysisRule-membershipIdentifier"></a>
 The membership identifier for the configured table association analysis rule.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** policy **   <a name="API-Type-ConfiguredTableAssociationAnalysisRule-policy"></a>
 The policy of the configured table association analysis rule.  
Type: [ConfiguredTableAssociationAnalysisRulePolicy](API_ConfiguredTableAssociationAnalysisRulePolicy.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** type **   <a name="API-Type-ConfiguredTableAssociationAnalysisRule-type"></a>
 The type of the configured table association analysis rule.  
Type: String  
Valid Values: `AGGREGATION | LIST | CUSTOM`   
Required: Yes

 ** updateTime **   <a name="API-Type-ConfiguredTableAssociationAnalysisRule-updateTime"></a>
 The update time of the configured table association analysis rule.  
Type: Timestamp  
Required: Yes

## See Also
<a name="API_ConfiguredTableAssociationAnalysisRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ConfiguredTableAssociationAnalysisRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ConfiguredTableAssociationAnalysisRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ConfiguredTableAssociationAnalysisRule) 

# ConfiguredTableAssociationAnalysisRuleAggregation
<a name="API_ConfiguredTableAssociationAnalysisRuleAggregation"></a>

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

## Contents
<a name="API_ConfiguredTableAssociationAnalysisRuleAggregation_Contents"></a>

 ** allowedAdditionalAnalyses **   <a name="API-Type-ConfiguredTableAssociationAnalysisRuleAggregation-allowedAdditionalAnalyses"></a>
 The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.  
The `allowedAdditionalAnalyses` parameter is currently supported for the list analysis rule (`AnalysisRuleList`) and the custom analysis rule (`AnalysisRuleCustom`).  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 25 items.  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:([\d]{12}|\*):membership\/[\*\d\w-]+\/configuredaudiencemodelassociation\/[\*\d\w-]+$|^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:([0-9]{12}|\*):membership\/[\*\d\w-]+\/configured-model-algorithm-association\/([-a-zA-Z0-9_\/.]+|\*)`   
Required: No

 ** allowedResultReceivers **   <a name="API-Type-ConfiguredTableAssociationAnalysisRuleAggregation-allowedResultReceivers"></a>
 The list of collaboration members who are allowed to receive results of queries run with this configured table.  
Type: Array of strings  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: No

## See Also
<a name="API_ConfiguredTableAssociationAnalysisRuleAggregation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ConfiguredTableAssociationAnalysisRuleAggregation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ConfiguredTableAssociationAnalysisRuleAggregation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ConfiguredTableAssociationAnalysisRuleAggregation) 

# ConfiguredTableAssociationAnalysisRuleCustom
<a name="API_ConfiguredTableAssociationAnalysisRuleCustom"></a>

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

## Contents
<a name="API_ConfiguredTableAssociationAnalysisRuleCustom_Contents"></a>

 ** allowedAdditionalAnalyses **   <a name="API-Type-ConfiguredTableAssociationAnalysisRuleCustom-allowedAdditionalAnalyses"></a>
 The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 25 items.  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:([\d]{12}|\*):membership\/[\*\d\w-]+\/configuredaudiencemodelassociation\/[\*\d\w-]+$|^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:([0-9]{12}|\*):membership\/[\*\d\w-]+\/configured-model-algorithm-association\/([-a-zA-Z0-9_\/.]+|\*)`   
Required: No

 ** allowedResultReceivers **   <a name="API-Type-ConfiguredTableAssociationAnalysisRuleCustom-allowedResultReceivers"></a>
 The list of collaboration members who are allowed to receive results of queries run with this configured table.  
Type: Array of strings  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: No

## See Also
<a name="API_ConfiguredTableAssociationAnalysisRuleCustom_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ConfiguredTableAssociationAnalysisRuleCustom) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ConfiguredTableAssociationAnalysisRuleCustom) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ConfiguredTableAssociationAnalysisRuleCustom) 

# ConfiguredTableAssociationAnalysisRuleList
<a name="API_ConfiguredTableAssociationAnalysisRuleList"></a>

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

## Contents
<a name="API_ConfiguredTableAssociationAnalysisRuleList_Contents"></a>

 ** allowedAdditionalAnalyses **   <a name="API-Type-ConfiguredTableAssociationAnalysisRuleList-allowedAdditionalAnalyses"></a>
 The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 25 items.  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:([\d]{12}|\*):membership\/[\*\d\w-]+\/configuredaudiencemodelassociation\/[\*\d\w-]+$|^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:([0-9]{12}|\*):membership\/[\*\d\w-]+\/configured-model-algorithm-association\/([-a-zA-Z0-9_\/.]+|\*)`   
Required: No

 ** allowedResultReceivers **   <a name="API-Type-ConfiguredTableAssociationAnalysisRuleList-allowedResultReceivers"></a>
 The list of collaboration members who are allowed to receive results of queries run with this configured table.  
Type: Array of strings  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: No

## See Also
<a name="API_ConfiguredTableAssociationAnalysisRuleList_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ConfiguredTableAssociationAnalysisRuleList) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ConfiguredTableAssociationAnalysisRuleList) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ConfiguredTableAssociationAnalysisRuleList) 

# ConfiguredTableAssociationAnalysisRulePolicy
<a name="API_ConfiguredTableAssociationAnalysisRulePolicy"></a>

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

## Contents
<a name="API_ConfiguredTableAssociationAnalysisRulePolicy_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** v1 **   <a name="API-Type-ConfiguredTableAssociationAnalysisRulePolicy-v1"></a>
 The policy for the configured table association analysis rule.  
Type: [ConfiguredTableAssociationAnalysisRulePolicyV1](API_ConfiguredTableAssociationAnalysisRulePolicyV1.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## See Also
<a name="API_ConfiguredTableAssociationAnalysisRulePolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ConfiguredTableAssociationAnalysisRulePolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ConfiguredTableAssociationAnalysisRulePolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ConfiguredTableAssociationAnalysisRulePolicy) 

# ConfiguredTableAssociationAnalysisRulePolicyV1
<a name="API_ConfiguredTableAssociationAnalysisRulePolicyV1"></a>

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

## Contents
<a name="API_ConfiguredTableAssociationAnalysisRulePolicyV1_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** aggregation **   <a name="API-Type-ConfiguredTableAssociationAnalysisRulePolicyV1-aggregation"></a>
 Analysis rule type that enables only aggregation queries on a configured table.  
Type: [ConfiguredTableAssociationAnalysisRuleAggregation](API_ConfiguredTableAssociationAnalysisRuleAggregation.md) object  
Required: No

 ** custom **   <a name="API-Type-ConfiguredTableAssociationAnalysisRulePolicyV1-custom"></a>
 Analysis rule type that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy.  
Type: [ConfiguredTableAssociationAnalysisRuleCustom](API_ConfiguredTableAssociationAnalysisRuleCustom.md) object  
Required: No

 ** list **   <a name="API-Type-ConfiguredTableAssociationAnalysisRulePolicyV1-list"></a>
 Analysis rule type that enables only list queries on a configured table.  
Type: [ConfiguredTableAssociationAnalysisRuleList](API_ConfiguredTableAssociationAnalysisRuleList.md) object  
Required: No

## See Also
<a name="API_ConfiguredTableAssociationAnalysisRulePolicyV1_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ConfiguredTableAssociationAnalysisRulePolicyV1) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ConfiguredTableAssociationAnalysisRulePolicyV1) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ConfiguredTableAssociationAnalysisRulePolicyV1) 

# ConfiguredTableAssociationSummary
<a name="API_ConfiguredTableAssociationSummary"></a>

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

## Contents
<a name="API_ConfiguredTableAssociationSummary_Contents"></a>

 ** arn **   <a name="API-Type-ConfiguredTableAssociationSummary-arn"></a>
The unique ARN for the configured table association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:configuredtableassociation/[\d\w-]+/[\d\w-]+`   
Required: Yes

 ** configuredTableId **   <a name="API-Type-ConfiguredTableAssociationSummary-configuredTableId"></a>
The unique configured table ID that this configured table association refers to.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** createTime **   <a name="API-Type-ConfiguredTableAssociationSummary-createTime"></a>
The time the configured table association was created.  
Type: Timestamp  
Required: Yes

 ** id **   <a name="API-Type-ConfiguredTableAssociationSummary-id"></a>
The unique ID for the configured table association.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** membershipArn **   <a name="API-Type-ConfiguredTableAssociationSummary-membershipArn"></a>
The unique ARN for the membership that the configured table association belongs to.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+`   
Required: Yes

 ** membershipId **   <a name="API-Type-ConfiguredTableAssociationSummary-membershipId"></a>
The unique ID for the membership that the configured table association belongs to.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** name **   <a name="API-Type-ConfiguredTableAssociationSummary-name"></a>
The name of the configured table association. The table is identified by this name when running Protected Queries against the underlying data.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?`   
Required: Yes

 ** updateTime **   <a name="API-Type-ConfiguredTableAssociationSummary-updateTime"></a>
The time the configured table association was last updated.  
Type: Timestamp  
Required: Yes

 ** analysisRuleTypes **   <a name="API-Type-ConfiguredTableAssociationSummary-analysisRuleTypes"></a>
The analysis rule types that are associated with the configured table associations in this summary.   
Type: Array of strings  
Valid Values: `AGGREGATION | LIST | CUSTOM`   
Required: No

## See Also
<a name="API_ConfiguredTableAssociationSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ConfiguredTableAssociationSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ConfiguredTableAssociationSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ConfiguredTableAssociationSummary) 

# ConfiguredTableSummary
<a name="API_ConfiguredTableSummary"></a>

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

## Contents
<a name="API_ConfiguredTableSummary_Contents"></a>

 ** analysisMethod **   <a name="API-Type-ConfiguredTableSummary-analysisMethod"></a>
The analysis method for the configured tables.   
 `DIRECT_QUERY` allows SQL queries to be run directly on this table.  
 `DIRECT_JOB` allows PySpark jobs to be run directly on this table.  
 `MULTIPLE` allows both SQL queries and PySpark jobs to be run directly on this table.  
Type: String  
Valid Values: `DIRECT_QUERY | DIRECT_JOB | MULTIPLE`   
Required: Yes

 ** analysisRuleTypes **   <a name="API-Type-ConfiguredTableSummary-analysisRuleTypes"></a>
The types of analysis rules associated with this configured table.  
Type: Array of strings  
Valid Values: `AGGREGATION | LIST | CUSTOM`   
Required: Yes

 ** arn **   <a name="API-Type-ConfiguredTableSummary-arn"></a>
The unique ARN of the configured table.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:configuredtable/[\d\w-]+`   
Required: Yes

 ** createTime **   <a name="API-Type-ConfiguredTableSummary-createTime"></a>
The time the configured table was created.  
Type: Timestamp  
Required: Yes

 ** id **   <a name="API-Type-ConfiguredTableSummary-id"></a>
The unique ID of the configured table.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** name **   <a name="API-Type-ConfiguredTableSummary-name"></a>
The name of the configured table.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*`   
Required: Yes

 ** updateTime **   <a name="API-Type-ConfiguredTableSummary-updateTime"></a>
The time the configured table was last updated.  
Type: Timestamp  
Required: Yes

 ** selectedAnalysisMethods **   <a name="API-Type-ConfiguredTableSummary-selectedAnalysisMethods"></a>
 The selected analysis methods for the configured table summary.  
Type: Array of strings  
Valid Values: `DIRECT_QUERY | DIRECT_JOB`   
Required: No

## See Also
<a name="API_ConfiguredTableSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ConfiguredTableSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ConfiguredTableSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ConfiguredTableSummary) 

# ConsolidatedPolicy
<a name="API_ConsolidatedPolicy"></a>

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

## Contents
<a name="API_ConsolidatedPolicy_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** v1 **   <a name="API-Type-ConsolidatedPolicy-v1"></a>
 The consolidated policy version 1.  
Type: [ConsolidatedPolicyV1](API_ConsolidatedPolicyV1.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## See Also
<a name="API_ConsolidatedPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ConsolidatedPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ConsolidatedPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ConsolidatedPolicy) 

# ConsolidatedPolicyAggregation
<a name="API_ConsolidatedPolicyAggregation"></a>

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

## Contents
<a name="API_ConsolidatedPolicyAggregation_Contents"></a>

 ** aggregateColumns **   <a name="API-Type-ConsolidatedPolicyAggregation-aggregateColumns"></a>
 Aggregate columns in consolidated policy aggregation.  
Type: Array of [AggregateColumn](API_AggregateColumn.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

 ** dimensionColumns **   <a name="API-Type-ConsolidatedPolicyAggregation-dimensionColumns"></a>
 The dimension columns of the consolidated policy aggregation.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?`   
Required: Yes

 ** joinColumns **   <a name="API-Type-ConsolidatedPolicyAggregation-joinColumns"></a>
 The columns to join on.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?`   
Required: Yes

 ** outputConstraints **   <a name="API-Type-ConsolidatedPolicyAggregation-outputConstraints"></a>
 The output constraints of the consolidated policy aggregation.  
Type: Array of [AggregationConstraint](API_AggregationConstraint.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

 ** scalarFunctions **   <a name="API-Type-ConsolidatedPolicyAggregation-scalarFunctions"></a>
 The scalar functions.  
Type: Array of strings  
Valid Values: `ABS | CAST | CEILING | COALESCE | CONVERT | CURRENT_DATE | DATEADD | EXTRACT | FLOOR | GETDATE | LN | LOG | LOWER | ROUND | RTRIM | SQRT | SUBSTRING | TO_CHAR | TO_DATE | TO_NUMBER | TO_TIMESTAMP | TRIM | TRUNC | UPPER`   
Required: Yes

 ** additionalAnalyses **   <a name="API-Type-ConsolidatedPolicyAggregation-additionalAnalyses"></a>
 Additional analyses for the consolidated policy aggregation.  
Type: String  
Valid Values: `ALLOWED | REQUIRED | NOT_ALLOWED`   
Required: No

 ** allowedAdditionalAnalyses **   <a name="API-Type-ConsolidatedPolicyAggregation-allowedAdditionalAnalyses"></a>
 The additional analyses allowed by the consolidated policy aggregation.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 25 items.  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:([\d]{12}|\*):membership\/[\*\d\w-]+\/configuredaudiencemodelassociation\/[\*\d\w-]+$|^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:([0-9]{12}|\*):membership\/[\*\d\w-]+\/configured-model-algorithm-association\/([-a-zA-Z0-9_\/.]+|\*)`   
Required: No

 ** allowedJoinOperators **   <a name="API-Type-ConsolidatedPolicyAggregation-allowedJoinOperators"></a>
 The allowed join operators.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 2 items.  
Valid Values: `OR | AND`   
Required: No

 ** allowedResultReceivers **   <a name="API-Type-ConsolidatedPolicyAggregation-allowedResultReceivers"></a>
 The allowed result receivers.  
Type: Array of strings  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: No

 ** joinRequired **   <a name="API-Type-ConsolidatedPolicyAggregation-joinRequired"></a>
 Join required  
Type: String  
Valid Values: `QUERY_RUNNER`   
Required: No

## See Also
<a name="API_ConsolidatedPolicyAggregation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ConsolidatedPolicyAggregation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ConsolidatedPolicyAggregation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ConsolidatedPolicyAggregation) 

# ConsolidatedPolicyCustom
<a name="API_ConsolidatedPolicyCustom"></a>

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

## Contents
<a name="API_ConsolidatedPolicyCustom_Contents"></a>

 ** allowedAnalyses **   <a name="API-Type-ConsolidatedPolicyCustom-allowedAnalyses"></a>
 The allowed analyses.  
Type: Array of strings  
Array Members: Minimum number of 0 items.  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Pattern: `(ANY_QUERY|ANY_JOB|arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/analysistemplate/[\d\w-]+)`   
Required: Yes

 ** additionalAnalyses **   <a name="API-Type-ConsolidatedPolicyCustom-additionalAnalyses"></a>
 Additional analyses for the consolidated policy.  
Type: String  
Valid Values: `ALLOWED | REQUIRED | NOT_ALLOWED`   
Required: No

 ** allowedAdditionalAnalyses **   <a name="API-Type-ConsolidatedPolicyCustom-allowedAdditionalAnalyses"></a>
 The additional analyses allowed by the consolidated policy.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 25 items.  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:([\d]{12}|\*):membership\/[\*\d\w-]+\/configuredaudiencemodelassociation\/[\*\d\w-]+$|^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:([0-9]{12}|\*):membership\/[\*\d\w-]+\/configured-model-algorithm-association\/([-a-zA-Z0-9_\/.]+|\*)`   
Required: No

 ** allowedAnalysisProviders **   <a name="API-Type-ConsolidatedPolicyCustom-allowedAnalysisProviders"></a>
 The allowed analysis providers.  
Type: Array of strings  
Array Members: Minimum number of 0 items.  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: No

 ** allowedResultReceivers **   <a name="API-Type-ConsolidatedPolicyCustom-allowedResultReceivers"></a>
 The allowed result receivers.  
Type: Array of strings  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: No

 ** differentialPrivacy **   <a name="API-Type-ConsolidatedPolicyCustom-differentialPrivacy"></a>
Specifies the unique identifier for your users.  
Type: [DifferentialPrivacyConfiguration](API_DifferentialPrivacyConfiguration.md) object  
Required: No

 ** disallowedOutputColumns **   <a name="API-Type-ConsolidatedPolicyCustom-disallowedOutputColumns"></a>
 Disallowed output columns  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?`   
Required: No

## See Also
<a name="API_ConsolidatedPolicyCustom_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ConsolidatedPolicyCustom) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ConsolidatedPolicyCustom) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ConsolidatedPolicyCustom) 

# ConsolidatedPolicyList
<a name="API_ConsolidatedPolicyList"></a>

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

## Contents
<a name="API_ConsolidatedPolicyList_Contents"></a>

 ** joinColumns **   <a name="API-Type-ConsolidatedPolicyList-joinColumns"></a>
 The columns to join on.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?`   
Required: Yes

 ** listColumns **   <a name="API-Type-ConsolidatedPolicyList-listColumns"></a>
 The columns in the consolidated policy list.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?`   
Required: Yes

 ** additionalAnalyses **   <a name="API-Type-ConsolidatedPolicyList-additionalAnalyses"></a>
 Additional analyses for the consolidated policy list.  
Type: String  
Valid Values: `ALLOWED | REQUIRED | NOT_ALLOWED`   
Required: No

 ** allowedAdditionalAnalyses **   <a name="API-Type-ConsolidatedPolicyList-allowedAdditionalAnalyses"></a>
 The additional analyses allowed by the consolidated policy list.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 25 items.  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:([\d]{12}|\*):membership\/[\*\d\w-]+\/configuredaudiencemodelassociation\/[\*\d\w-]+$|^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:([0-9]{12}|\*):membership\/[\*\d\w-]+\/configured-model-algorithm-association\/([-a-zA-Z0-9_\/.]+|\*)`   
Required: No

 ** allowedJoinOperators **   <a name="API-Type-ConsolidatedPolicyList-allowedJoinOperators"></a>
 The allowed join operators in the consolidated policy list.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 2 items.  
Valid Values: `OR | AND`   
Required: No

 ** allowedResultReceivers **   <a name="API-Type-ConsolidatedPolicyList-allowedResultReceivers"></a>
 The allowed result receivers.  
Type: Array of strings  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: No

## See Also
<a name="API_ConsolidatedPolicyList_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ConsolidatedPolicyList) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ConsolidatedPolicyList) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ConsolidatedPolicyList) 

# ConsolidatedPolicyV1
<a name="API_ConsolidatedPolicyV1"></a>

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

## Contents
<a name="API_ConsolidatedPolicyV1_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** aggregation **   <a name="API-Type-ConsolidatedPolicyV1-aggregation"></a>
 The aggregation setting for the consolidated policy.  
Type: [ConsolidatedPolicyAggregation](API_ConsolidatedPolicyAggregation.md) object  
Required: No

 ** custom **   <a name="API-Type-ConsolidatedPolicyV1-custom"></a>
 Custom policy  
Type: [ConsolidatedPolicyCustom](API_ConsolidatedPolicyCustom.md) object  
Required: No

 ** list **   <a name="API-Type-ConsolidatedPolicyV1-list"></a>
 The list of consolidated policies.  
Type: [ConsolidatedPolicyList](API_ConsolidatedPolicyList.md) object  
Required: No

## See Also
<a name="API_ConsolidatedPolicyV1_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ConsolidatedPolicyV1) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ConsolidatedPolicyV1) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ConsolidatedPolicyV1) 

# DataEncryptionMetadata
<a name="API_DataEncryptionMetadata"></a>

The settings for client-side encryption for cryptographic computing.

## Contents
<a name="API_DataEncryptionMetadata_Contents"></a>

 ** allowCleartext **   <a name="API-Type-DataEncryptionMetadata-allowCleartext"></a>
Indicates whether encrypted tables can contain cleartext data (`TRUE`) or are to cryptographically process every column (`FALSE`).  
Type: Boolean  
Required: Yes

 ** allowDuplicates **   <a name="API-Type-DataEncryptionMetadata-allowDuplicates"></a>
Indicates whether Fingerprint columns can contain duplicate entries (`TRUE`) or are to contain only non-repeated values (`FALSE`).  
Type: Boolean  
Required: Yes

 ** allowJoinsOnColumnsWithDifferentNames **   <a name="API-Type-DataEncryptionMetadata-allowJoinsOnColumnsWithDifferentNames"></a>
Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (`TRUE`) or can only be joined on Fingerprint columns of the same name (`FALSE`).  
Type: Boolean  
Required: Yes

 ** preserveNulls **   <a name="API-Type-DataEncryptionMetadata-preserveNulls"></a>
Indicates whether NULL values are to be copied as NULL to encrypted tables (`TRUE`) or cryptographically processed (`FALSE`).  
Type: Boolean  
Required: Yes

## See Also
<a name="API_DataEncryptionMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DataEncryptionMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DataEncryptionMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DataEncryptionMetadata) 

# DifferentialPrivacyColumn
<a name="API_DifferentialPrivacyColumn"></a>

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

## Contents
<a name="API_DifferentialPrivacyColumn_Contents"></a>

 ** name **   <a name="API-Type-DifferentialPrivacyColumn-name"></a>
The name of the column, such as user\$1id, that contains the unique identifier of your users, whose privacy you want to protect. If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?`   
Required: Yes

## See Also
<a name="API_DifferentialPrivacyColumn_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DifferentialPrivacyColumn) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DifferentialPrivacyColumn) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DifferentialPrivacyColumn) 

# DifferentialPrivacyConfiguration
<a name="API_DifferentialPrivacyConfiguration"></a>

Specifies the unique identifier for your users.

## Contents
<a name="API_DifferentialPrivacyConfiguration_Contents"></a>

 ** columns **   <a name="API-Type-DifferentialPrivacyConfiguration-columns"></a>
The name of the column (such as user\$1id) that contains the unique identifier of your users whose privacy you want to protect. If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules.  
Type: Array of [DifferentialPrivacyColumn](API_DifferentialPrivacyColumn.md) objects  
Array Members: Fixed number of 1 item.  
Required: Yes

## See Also
<a name="API_DifferentialPrivacyConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DifferentialPrivacyConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DifferentialPrivacyConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DifferentialPrivacyConfiguration) 

# DifferentialPrivacyParameters
<a name="API_DifferentialPrivacyParameters"></a>

An array that contains the sensitivity parameters.

## Contents
<a name="API_DifferentialPrivacyParameters_Contents"></a>

 ** sensitivityParameters **   <a name="API-Type-DifferentialPrivacyParameters-sensitivityParameters"></a>
Provides the sensitivity parameters that you can use to better understand the total amount of noise in query results.  
Type: Array of [DifferentialPrivacySensitivityParameters](API_DifferentialPrivacySensitivityParameters.md) objects  
Required: Yes

## See Also
<a name="API_DifferentialPrivacyParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DifferentialPrivacyParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DifferentialPrivacyParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DifferentialPrivacyParameters) 

# DifferentialPrivacyPreviewAggregation
<a name="API_DifferentialPrivacyPreviewAggregation"></a>

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

## Contents
<a name="API_DifferentialPrivacyPreviewAggregation_Contents"></a>

 ** maxCount **   <a name="API-Type-DifferentialPrivacyPreviewAggregation-maxCount"></a>
The maximum number of aggregations that the member who can query can run given the epsilon and noise parameters.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: Yes

 ** type **   <a name="API-Type-DifferentialPrivacyPreviewAggregation-type"></a>
The type of aggregation function.  
Type: String  
Valid Values: `AVG | COUNT | COUNT_DISTINCT | SUM | STDDEV`   
Required: Yes

## See Also
<a name="API_DifferentialPrivacyPreviewAggregation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DifferentialPrivacyPreviewAggregation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DifferentialPrivacyPreviewAggregation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DifferentialPrivacyPreviewAggregation) 

# DifferentialPrivacyPreviewParametersInput
<a name="API_DifferentialPrivacyPreviewParametersInput"></a>

The epsilon and noise parameters that you want to preview.

## Contents
<a name="API_DifferentialPrivacyPreviewParametersInput_Contents"></a>

 ** epsilon **   <a name="API-Type-DifferentialPrivacyPreviewParametersInput-epsilon"></a>
The epsilon value that you want to preview.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 20.  
Required: Yes

 ** usersNoisePerQuery **   <a name="API-Type-DifferentialPrivacyPreviewParametersInput-usersNoisePerQuery"></a>
Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.  
Type: Integer  
Valid Range: Minimum value of 10. Maximum value of 100.  
Required: Yes

## See Also
<a name="API_DifferentialPrivacyPreviewParametersInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DifferentialPrivacyPreviewParametersInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DifferentialPrivacyPreviewParametersInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DifferentialPrivacyPreviewParametersInput) 

# DifferentialPrivacyPrivacyBudget
<a name="API_DifferentialPrivacyPrivacyBudget"></a>

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

## Contents
<a name="API_DifferentialPrivacyPrivacyBudget_Contents"></a>

 ** aggregations **   <a name="API-Type-DifferentialPrivacyPrivacyBudget-aggregations"></a>
This information includes the configured epsilon value and the utility in terms of total aggregations, as well as the remaining aggregations.  
Type: Array of [DifferentialPrivacyPrivacyBudgetAggregation](API_DifferentialPrivacyPrivacyBudgetAggregation.md) objects  
Required: Yes

 ** epsilon **   <a name="API-Type-DifferentialPrivacyPrivacyBudget-epsilon"></a>
The epsilon value that you configured.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 20.  
Required: Yes

## See Also
<a name="API_DifferentialPrivacyPrivacyBudget_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DifferentialPrivacyPrivacyBudget) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DifferentialPrivacyPrivacyBudget) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DifferentialPrivacyPrivacyBudget) 

# DifferentialPrivacyPrivacyBudgetAggregation
<a name="API_DifferentialPrivacyPrivacyBudgetAggregation"></a>

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

## Contents
<a name="API_DifferentialPrivacyPrivacyBudgetAggregation_Contents"></a>

 ** maxCount **   <a name="API-Type-DifferentialPrivacyPrivacyBudgetAggregation-maxCount"></a>
The maximum number of aggregation functions that you can perform with the given privacy budget.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: Yes

 ** remainingCount **   <a name="API-Type-DifferentialPrivacyPrivacyBudgetAggregation-remainingCount"></a>
The remaining number of aggregation functions that can be run with the available privacy budget.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: Yes

 ** type **   <a name="API-Type-DifferentialPrivacyPrivacyBudgetAggregation-type"></a>
The different types of aggregation functions that you can perform.  
Type: String  
Valid Values: `AVG | COUNT | COUNT_DISTINCT | SUM | STDDEV`   
Required: Yes

## See Also
<a name="API_DifferentialPrivacyPrivacyBudgetAggregation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DifferentialPrivacyPrivacyBudgetAggregation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DifferentialPrivacyPrivacyBudgetAggregation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DifferentialPrivacyPrivacyBudgetAggregation) 

# DifferentialPrivacyPrivacyImpact
<a name="API_DifferentialPrivacyPrivacyImpact"></a>

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

## Contents
<a name="API_DifferentialPrivacyPrivacyImpact_Contents"></a>

 ** aggregations **   <a name="API-Type-DifferentialPrivacyPrivacyImpact-aggregations"></a>
The number of aggregation functions that you can perform.  
Type: Array of [DifferentialPrivacyPreviewAggregation](API_DifferentialPrivacyPreviewAggregation.md) objects  
Required: Yes

## See Also
<a name="API_DifferentialPrivacyPrivacyImpact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DifferentialPrivacyPrivacyImpact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DifferentialPrivacyPrivacyImpact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DifferentialPrivacyPrivacyImpact) 

# DifferentialPrivacySensitivityParameters
<a name="API_DifferentialPrivacySensitivityParameters"></a>

Provides the sensitivity parameters.

## Contents
<a name="API_DifferentialPrivacySensitivityParameters_Contents"></a>

 ** aggregationExpression **   <a name="API-Type-DifferentialPrivacySensitivityParameters-aggregationExpression"></a>
The aggregation expression that was run.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

 ** aggregationType **   <a name="API-Type-DifferentialPrivacySensitivityParameters-aggregationType"></a>
The type of aggregation function that was run.  
Type: String  
Valid Values: `AVG | COUNT | COUNT_DISTINCT | SUM | STDDEV`   
Required: Yes

 ** userContributionLimit **   <a name="API-Type-DifferentialPrivacySensitivityParameters-userContributionLimit"></a>
The maximum number of rows contributed by a user in a SQL query.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: Yes

 ** maxColumnValue **   <a name="API-Type-DifferentialPrivacySensitivityParameters-maxColumnValue"></a>
The upper bound of the aggregation expression.  
Type: Float  
Required: No

 ** minColumnValue **   <a name="API-Type-DifferentialPrivacySensitivityParameters-minColumnValue"></a>
The lower bound of the aggregation expression.  
Type: Float  
Required: No

## See Also
<a name="API_DifferentialPrivacySensitivityParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DifferentialPrivacySensitivityParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DifferentialPrivacySensitivityParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DifferentialPrivacySensitivityParameters) 

# DifferentialPrivacyTemplateParametersInput
<a name="API_DifferentialPrivacyTemplateParametersInput"></a>

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

## Contents
<a name="API_DifferentialPrivacyTemplateParametersInput_Contents"></a>

 ** epsilon **   <a name="API-Type-DifferentialPrivacyTemplateParametersInput-epsilon"></a>
The epsilon value that you want to use.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 20.  
Required: Yes

 ** usersNoisePerQuery **   <a name="API-Type-DifferentialPrivacyTemplateParametersInput-usersNoisePerQuery"></a>
Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.  
Type: Integer  
Valid Range: Minimum value of 10. Maximum value of 100.  
Required: Yes

## See Also
<a name="API_DifferentialPrivacyTemplateParametersInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DifferentialPrivacyTemplateParametersInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DifferentialPrivacyTemplateParametersInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DifferentialPrivacyTemplateParametersInput) 

# DifferentialPrivacyTemplateParametersOutput
<a name="API_DifferentialPrivacyTemplateParametersOutput"></a>

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

## Contents
<a name="API_DifferentialPrivacyTemplateParametersOutput_Contents"></a>

 ** epsilon **   <a name="API-Type-DifferentialPrivacyTemplateParametersOutput-epsilon"></a>
The epsilon value that you specified.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 20.  
Required: Yes

 ** usersNoisePerQuery **   <a name="API-Type-DifferentialPrivacyTemplateParametersOutput-usersNoisePerQuery"></a>
Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.  
Type: Integer  
Valid Range: Minimum value of 10. Maximum value of 100.  
Required: Yes

## See Also
<a name="API_DifferentialPrivacyTemplateParametersOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DifferentialPrivacyTemplateParametersOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DifferentialPrivacyTemplateParametersOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DifferentialPrivacyTemplateParametersOutput) 

# DifferentialPrivacyTemplateUpdateParameters
<a name="API_DifferentialPrivacyTemplateUpdateParameters"></a>

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

## Contents
<a name="API_DifferentialPrivacyTemplateUpdateParameters_Contents"></a>

 ** epsilon **   <a name="API-Type-DifferentialPrivacyTemplateUpdateParameters-epsilon"></a>
The updated epsilon value that you want to use.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 20.  
Required: No

 ** usersNoisePerQuery **   <a name="API-Type-DifferentialPrivacyTemplateUpdateParameters-usersNoisePerQuery"></a>
The updated value of noise added per query. It is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.  
Type: Integer  
Valid Range: Minimum value of 10. Maximum value of 100.  
Required: No

## See Also
<a name="API_DifferentialPrivacyTemplateUpdateParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DifferentialPrivacyTemplateUpdateParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DifferentialPrivacyTemplateUpdateParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DifferentialPrivacyTemplateUpdateParameters) 

# DirectAnalysisConfigurationDetails
<a name="API_DirectAnalysisConfigurationDetails"></a>

 The direct analysis configuration details.

## Contents
<a name="API_DirectAnalysisConfigurationDetails_Contents"></a>

 ** receiverAccountIds **   <a name="API-Type-DirectAnalysisConfigurationDetails-receiverAccountIds"></a>
 The account IDs for the member who received the results of a protected query.  
Type: Array of strings  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: No

## See Also
<a name="API_DirectAnalysisConfigurationDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/DirectAnalysisConfigurationDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/DirectAnalysisConfigurationDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/DirectAnalysisConfigurationDetails) 

# ErrorMessageConfiguration
<a name="API_ErrorMessageConfiguration"></a>

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.

## Contents
<a name="API_ErrorMessageConfiguration_Contents"></a>

 ** type **   <a name="API-Type-ErrorMessageConfiguration-type"></a>
The level of detail for error messages returned by the PySpark job. When set to DETAILED, error messages include more information to help troubleshoot issues with your PySpark job.  
Because this setting may expose sensitive data, it is recommended for development and testing environments.  
Type: String  
Valid Values: `DETAILED`   
Required: Yes

## See Also
<a name="API_ErrorMessageConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ErrorMessageConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ErrorMessageConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ErrorMessageConfiguration) 

# GlueTableReference
<a name="API_GlueTableReference"></a>

A reference to a table within an AWS Glue data catalog.

## Contents
<a name="API_GlueTableReference_Contents"></a>

 ** databaseName **   <a name="API-Type-GlueTableReference-databaseName"></a>
The name of the database the AWS Glue table belongs to.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_](([a-zA-Z0-9_]+-)*([a-zA-Z0-9_]+))?`   
Required: Yes

 ** tableName **   <a name="API-Type-GlueTableReference-tableName"></a>
The name of the AWS Glue table.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?`   
Required: Yes

 ** region **   <a name="API-Type-GlueTableReference-region"></a>
The AWS Region where the AWS Glue table is located. This parameter is required to uniquely identify and access tables across different Regions.  
Type: String  
Valid Values: `us-west-1 | us-west-2 | us-east-1 | us-east-2 | af-south-1 | ap-east-1 | ap-south-2 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ap-southeast-5 | ap-southeast-4 | ap-southeast-7 | ap-south-1 | ap-northeast-3 | ap-northeast-1 | ap-northeast-2 | ca-central-1 | ca-west-1 | eu-south-1 | eu-west-3 | eu-south-2 | eu-central-2 | eu-central-1 | eu-north-1 | eu-west-1 | eu-west-2 | me-south-1 | me-central-1 | il-central-1 | sa-east-1 | mx-central-1 | ap-east-2`   
Required: No

## See Also
<a name="API_GlueTableReference_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/GlueTableReference) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/GlueTableReference) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/GlueTableReference) 

# Hash
<a name="API_Hash"></a>

 Hash

## Contents
<a name="API_Hash_Contents"></a>

 ** sha256 **   <a name="API-Type-Hash-sha256"></a>
 The SHA-256 hash value.  
Type: String  
Required: No

## See Also
<a name="API_Hash_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/Hash) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/Hash) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/Hash) 

# IdMappingConfig
<a name="API_IdMappingConfig"></a>

The configuration settings for the ID mapping table.

## Contents
<a name="API_IdMappingConfig_Contents"></a>

 ** allowUseAsDimensionColumn **   <a name="API-Type-IdMappingConfig-allowUseAsDimensionColumn"></a>
An indicator as to whether you can use your column as a dimension column in the ID mapping table (`TRUE`) or not (`FALSE`).  
Default is `FALSE`.  
Type: Boolean  
Required: Yes

## See Also
<a name="API_IdMappingConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/IdMappingConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/IdMappingConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/IdMappingConfig) 

# IdMappingTable
<a name="API_IdMappingTable"></a>

Describes information about the ID mapping table.

## Contents
<a name="API_IdMappingTable_Contents"></a>

 ** arn **   <a name="API-Type-IdMappingTable-arn"></a>
The Amazon Resource Name (ARN) of the ID mapping table.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Pattern: `arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/idmappingtable/[\d\w-]+`   
Required: Yes

 ** collaborationArn **   <a name="API-Type-IdMappingTable-collaborationArn"></a>
The Amazon Resource Name (ARN) of the collaboration that contains this ID mapping table.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** collaborationId **   <a name="API-Type-IdMappingTable-collaborationId"></a>
The unique identifier of the collaboration that contains this ID mapping table.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** createTime **   <a name="API-Type-IdMappingTable-createTime"></a>
The time at which the ID mapping table was created.  
Type: Timestamp  
Required: Yes

 ** id **   <a name="API-Type-IdMappingTable-id"></a>
The unique identifier of the ID mapping table.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** inputReferenceConfig **   <a name="API-Type-IdMappingTable-inputReferenceConfig"></a>
The input reference configuration for the ID mapping table.  
Type: [IdMappingTableInputReferenceConfig](API_IdMappingTableInputReferenceConfig.md) object  
Required: Yes

 ** inputReferenceProperties **   <a name="API-Type-IdMappingTable-inputReferenceProperties"></a>
The input reference properties for the ID mapping table.  
Type: [IdMappingTableInputReferenceProperties](API_IdMappingTableInputReferenceProperties.md) object  
Required: Yes

 ** membershipArn **   <a name="API-Type-IdMappingTable-membershipArn"></a>
The Amazon Resource Name (ARN) of the membership resource for the ID mapping table.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+`   
Required: Yes

 ** membershipId **   <a name="API-Type-IdMappingTable-membershipId"></a>
The unique identifier of the membership resource for the ID mapping table.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** name **   <a name="API-Type-IdMappingTable-name"></a>
The name of the ID mapping table.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?`   
Required: Yes

 ** updateTime **   <a name="API-Type-IdMappingTable-updateTime"></a>
The most recent time at which the ID mapping table was updated.  
Type: Timestamp  
Required: Yes

 ** description **   <a name="API-Type-IdMappingTable-description"></a>
The description of the ID mapping table.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*`   
Required: No

 ** kmsKeyArn **   <a name="API-Type-IdMappingTable-kmsKeyArn"></a>
The Amazon Resource Name (ARN) of the AWS KMS key.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws:kms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:key/[a-zA-Z0-9-]+`   
Required: No

## See Also
<a name="API_IdMappingTable_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/IdMappingTable) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/IdMappingTable) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/IdMappingTable) 

# IdMappingTableInputReferenceConfig
<a name="API_IdMappingTableInputReferenceConfig"></a>

Provides the input reference configuration for the ID mapping table.

## Contents
<a name="API_IdMappingTableInputReferenceConfig_Contents"></a>

 ** inputReferenceArn **   <a name="API-Type-IdMappingTableInputReferenceConfig-inputReferenceArn"></a>
The Amazon Resource Name (ARN) of the referenced resource in AWS Entity Resolution. Valid values are ID mapping workflow ARNs.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(idmappingworkflow/.*)`   
Required: Yes

 ** manageResourcePolicies **   <a name="API-Type-IdMappingTableInputReferenceConfig-manageResourcePolicies"></a>
When `TRUE`, AWS Clean Rooms manages permissions for the ID mapping table resource.   
When `FALSE`, the resource owner manages permissions for the ID mapping table resource.  
Type: Boolean  
Required: Yes

## See Also
<a name="API_IdMappingTableInputReferenceConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/IdMappingTableInputReferenceConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/IdMappingTableInputReferenceConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/IdMappingTableInputReferenceConfig) 

# IdMappingTableInputReferenceProperties
<a name="API_IdMappingTableInputReferenceProperties"></a>

The input reference properties for the ID mapping table.

## Contents
<a name="API_IdMappingTableInputReferenceProperties_Contents"></a>

 ** idMappingTableInputSource **   <a name="API-Type-IdMappingTableInputReferenceProperties-idMappingTableInputSource"></a>
The input source of the ID mapping table.  
Type: Array of [IdMappingTableInputSource](API_IdMappingTableInputSource.md) objects  
Array Members: Fixed number of 2 items.  
Required: Yes

## See Also
<a name="API_IdMappingTableInputReferenceProperties_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/IdMappingTableInputReferenceProperties) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/IdMappingTableInputReferenceProperties) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/IdMappingTableInputReferenceProperties) 

# IdMappingTableInputSource
<a name="API_IdMappingTableInputSource"></a>

The input source of the ID mapping table.

## Contents
<a name="API_IdMappingTableInputSource_Contents"></a>

 ** idNamespaceAssociationId **   <a name="API-Type-IdMappingTableInputSource-idNamespaceAssociationId"></a>
The unique identifier of the ID namespace association.  
Type: String  
Required: Yes

 ** type **   <a name="API-Type-IdMappingTableInputSource-type"></a>
The type of the input source of the ID mapping table.  
Type: String  
Valid Values: `SOURCE | TARGET`   
Required: Yes

## See Also
<a name="API_IdMappingTableInputSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/IdMappingTableInputSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/IdMappingTableInputSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/IdMappingTableInputSource) 

# IdMappingTableSchemaTypeProperties
<a name="API_IdMappingTableSchemaTypeProperties"></a>

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

## Contents
<a name="API_IdMappingTableSchemaTypeProperties_Contents"></a>

 ** idMappingTableInputSource **   <a name="API-Type-IdMappingTableSchemaTypeProperties-idMappingTableInputSource"></a>
Defines which ID namespace associations are used to create the ID mapping table.  
Type: Array of [IdMappingTableInputSource](API_IdMappingTableInputSource.md) objects  
Array Members: Fixed number of 2 items.  
Required: Yes

## See Also
<a name="API_IdMappingTableSchemaTypeProperties_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/IdMappingTableSchemaTypeProperties) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/IdMappingTableSchemaTypeProperties) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/IdMappingTableSchemaTypeProperties) 

# IdMappingTableSummary
<a name="API_IdMappingTableSummary"></a>

Detailed information about the ID mapping table.

## Contents
<a name="API_IdMappingTableSummary_Contents"></a>

 ** arn **   <a name="API-Type-IdMappingTableSummary-arn"></a>
The Amazon Resource Name (ARN) of this ID mapping table.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Pattern: `arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/idmappingtable/[\d\w-]+`   
Required: Yes

 ** collaborationArn **   <a name="API-Type-IdMappingTableSummary-collaborationArn"></a>
The Amazon Resource Name (ARN) of the collaboration that contains this ID mapping table.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** collaborationId **   <a name="API-Type-IdMappingTableSummary-collaborationId"></a>
The unique identifier of the collaboration that contains this ID mapping table.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** createTime **   <a name="API-Type-IdMappingTableSummary-createTime"></a>
The time at which this ID mapping table was created.  
Type: Timestamp  
Required: Yes

 ** id **   <a name="API-Type-IdMappingTableSummary-id"></a>
The unique identifier of this ID mapping table.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** inputReferenceConfig **   <a name="API-Type-IdMappingTableSummary-inputReferenceConfig"></a>
The input reference configuration for the ID mapping table.  
Type: [IdMappingTableInputReferenceConfig](API_IdMappingTableInputReferenceConfig.md) object  
Required: Yes

 ** membershipArn **   <a name="API-Type-IdMappingTableSummary-membershipArn"></a>
The Amazon Resource Name (ARN) of the membership resource for this ID mapping table.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+`   
Required: Yes

 ** membershipId **   <a name="API-Type-IdMappingTableSummary-membershipId"></a>
The unique identifier of the membership resource for this ID mapping table.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** name **   <a name="API-Type-IdMappingTableSummary-name"></a>
The name of this ID mapping table.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?`   
Required: Yes

 ** updateTime **   <a name="API-Type-IdMappingTableSummary-updateTime"></a>
The most recent time at which this ID mapping table was updated.  
Type: Timestamp  
Required: Yes

 ** description **   <a name="API-Type-IdMappingTableSummary-description"></a>
The description of this ID mapping table.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*`   
Required: No

## See Also
<a name="API_IdMappingTableSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/IdMappingTableSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/IdMappingTableSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/IdMappingTableSummary) 

# IdNamespaceAssociation
<a name="API_IdNamespaceAssociation"></a>

Provides information to create the ID namespace association.

## Contents
<a name="API_IdNamespaceAssociation_Contents"></a>

 ** arn **   <a name="API-Type-IdNamespaceAssociation-arn"></a>
The Amazon Resource Name (ARN) of the ID namespace association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/idnamespaceassociation/[\d\w-]+`   
Required: Yes

 ** collaborationArn **   <a name="API-Type-IdNamespaceAssociation-collaborationArn"></a>
The Amazon Resource Name (ARN) of the collaboration that contains this ID namespace association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** collaborationId **   <a name="API-Type-IdNamespaceAssociation-collaborationId"></a>
The unique identifier of the collaboration that contains this ID namespace association.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** createTime **   <a name="API-Type-IdNamespaceAssociation-createTime"></a>
The time at which the ID namespace association was created.  
Type: Timestamp  
Required: Yes

 ** id **   <a name="API-Type-IdNamespaceAssociation-id"></a>
The unique identifier for this ID namespace association.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** inputReferenceConfig **   <a name="API-Type-IdNamespaceAssociation-inputReferenceConfig"></a>
The input reference configuration for the ID namespace association.  
Type: [IdNamespaceAssociationInputReferenceConfig](API_IdNamespaceAssociationInputReferenceConfig.md) object  
Required: Yes

 ** inputReferenceProperties **   <a name="API-Type-IdNamespaceAssociation-inputReferenceProperties"></a>
The input reference properties for the ID namespace association.  
Type: [IdNamespaceAssociationInputReferenceProperties](API_IdNamespaceAssociationInputReferenceProperties.md) object  
Required: Yes

 ** membershipArn **   <a name="API-Type-IdNamespaceAssociation-membershipArn"></a>
The Amazon Resource Name (ARN) of the membership resource for this ID namespace association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+`   
Required: Yes

 ** membershipId **   <a name="API-Type-IdNamespaceAssociation-membershipId"></a>
The unique identifier of the membership resource for this ID namespace association.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** name **   <a name="API-Type-IdNamespaceAssociation-name"></a>
The name of this ID namespace association.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*`   
Required: Yes

 ** updateTime **   <a name="API-Type-IdNamespaceAssociation-updateTime"></a>
The most recent time at which the ID namespace association was updated.  
Type: Timestamp  
Required: Yes

 ** description **   <a name="API-Type-IdNamespaceAssociation-description"></a>
The description of the ID namespace association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*`   
Required: No

 ** idMappingConfig **   <a name="API-Type-IdNamespaceAssociation-idMappingConfig"></a>
The configuration settings for the ID mapping table.  
Type: [IdMappingConfig](API_IdMappingConfig.md) object  
Required: No

## See Also
<a name="API_IdNamespaceAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/IdNamespaceAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/IdNamespaceAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/IdNamespaceAssociation) 

# IdNamespaceAssociationInputReferenceConfig
<a name="API_IdNamespaceAssociationInputReferenceConfig"></a>

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

## Contents
<a name="API_IdNamespaceAssociationInputReferenceConfig_Contents"></a>

 ** inputReferenceArn **   <a name="API-Type-IdNamespaceAssociationInputReferenceConfig-inputReferenceArn"></a>
The Amazon Resource Name (ARN) of the AWS Entity Resolution resource that is being associated to the collaboration. Valid resource ARNs are from the ID namespaces that you own.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `arn:aws:entityresolution:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:idnamespace/[\d\w-]+`   
Required: Yes

 ** manageResourcePolicies **   <a name="API-Type-IdNamespaceAssociationInputReferenceConfig-manageResourcePolicies"></a>
When `TRUE`, AWS Clean Rooms manages permissions for the ID namespace association resource.  
When `FALSE`, the resource owner manages permissions for the ID namespace association resource.  
Type: Boolean  
Required: Yes

## See Also
<a name="API_IdNamespaceAssociationInputReferenceConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/IdNamespaceAssociationInputReferenceConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/IdNamespaceAssociationInputReferenceConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/IdNamespaceAssociationInputReferenceConfig) 

# IdNamespaceAssociationInputReferenceProperties
<a name="API_IdNamespaceAssociationInputReferenceProperties"></a>

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

## Contents
<a name="API_IdNamespaceAssociationInputReferenceProperties_Contents"></a>

 ** idMappingWorkflowsSupported **   <a name="API-Type-IdNamespaceAssociationInputReferenceProperties-idMappingWorkflowsSupported"></a>
Defines how ID mapping workflows are supported for this ID namespace association.  
Type: Array of JSON values  
Required: Yes

 ** idNamespaceType **   <a name="API-Type-IdNamespaceAssociationInputReferenceProperties-idNamespaceType"></a>
The ID namespace type for this ID namespace association.  
Type: String  
Valid Values: `SOURCE | TARGET`   
Required: Yes

## See Also
<a name="API_IdNamespaceAssociationInputReferenceProperties_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/IdNamespaceAssociationInputReferenceProperties) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/IdNamespaceAssociationInputReferenceProperties) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/IdNamespaceAssociationInputReferenceProperties) 

# IdNamespaceAssociationInputReferencePropertiesSummary
<a name="API_IdNamespaceAssociationInputReferencePropertiesSummary"></a>

Detailed information about the ID namespace association input reference properties.

## Contents
<a name="API_IdNamespaceAssociationInputReferencePropertiesSummary_Contents"></a>

 ** idNamespaceType **   <a name="API-Type-IdNamespaceAssociationInputReferencePropertiesSummary-idNamespaceType"></a>
The ID namespace type for this ID namespace association.  
Type: String  
Valid Values: `SOURCE | TARGET`   
Required: Yes

## See Also
<a name="API_IdNamespaceAssociationInputReferencePropertiesSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/IdNamespaceAssociationInputReferencePropertiesSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/IdNamespaceAssociationInputReferencePropertiesSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/IdNamespaceAssociationInputReferencePropertiesSummary) 

# IdNamespaceAssociationSummary
<a name="API_IdNamespaceAssociationSummary"></a>

Detailed information about the ID namespace association.

## Contents
<a name="API_IdNamespaceAssociationSummary_Contents"></a>

 ** arn **   <a name="API-Type-IdNamespaceAssociationSummary-arn"></a>
The Amazon Resource Name (ARN) of this ID namespace association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/idnamespaceassociation/[\d\w-]+`   
Required: Yes

 ** collaborationArn **   <a name="API-Type-IdNamespaceAssociationSummary-collaborationArn"></a>
The Amazon Resource Name (ARN) of the collaboration that contains this ID namespace association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** collaborationId **   <a name="API-Type-IdNamespaceAssociationSummary-collaborationId"></a>
The unique identifier of the collaboration that contains this ID namespace association.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** createTime **   <a name="API-Type-IdNamespaceAssociationSummary-createTime"></a>
The time at which this ID namespace association was created.  
Type: Timestamp  
Required: Yes

 ** id **   <a name="API-Type-IdNamespaceAssociationSummary-id"></a>
The unique identifier of this ID namespace association.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** inputReferenceConfig **   <a name="API-Type-IdNamespaceAssociationSummary-inputReferenceConfig"></a>
The input reference configuration details for this ID namespace association.  
Type: [IdNamespaceAssociationInputReferenceConfig](API_IdNamespaceAssociationInputReferenceConfig.md) object  
Required: Yes

 ** inputReferenceProperties **   <a name="API-Type-IdNamespaceAssociationSummary-inputReferenceProperties"></a>
The input reference properties for this ID namespace association.  
Type: [IdNamespaceAssociationInputReferencePropertiesSummary](API_IdNamespaceAssociationInputReferencePropertiesSummary.md) object  
Required: Yes

 ** membershipArn **   <a name="API-Type-IdNamespaceAssociationSummary-membershipArn"></a>
The Amazon Resource Name (ARN) of the membership resource for this ID namespace association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+`   
Required: Yes

 ** membershipId **   <a name="API-Type-IdNamespaceAssociationSummary-membershipId"></a>
The unique identifier of the membership resource for this ID namespace association.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** name **   <a name="API-Type-IdNamespaceAssociationSummary-name"></a>
The name of the ID namespace association.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*`   
Required: Yes

 ** updateTime **   <a name="API-Type-IdNamespaceAssociationSummary-updateTime"></a>
The most recent time at which this ID namespace association has been updated.  
Type: Timestamp  
Required: Yes

 ** description **   <a name="API-Type-IdNamespaceAssociationSummary-description"></a>
The description of the ID namespace association.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*`   
Required: No

## See Also
<a name="API_IdNamespaceAssociationSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/IdNamespaceAssociationSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/IdNamespaceAssociationSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/IdNamespaceAssociationSummary) 

# JobComputePaymentConfig
<a name="API_JobComputePaymentConfig"></a>

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

## Contents
<a name="API_JobComputePaymentConfig_Contents"></a>

 ** isResponsible **   <a name="API-Type-JobComputePaymentConfig-isResponsible"></a>
Indicates whether the collaboration creator has configured the collaboration member to pay for query and job compute costs (`TRUE`) or has not configured the collaboration member to pay for query and job compute costs (`FALSE`).  
Exactly one member can be configured to pay for query and job compute costs. An error is returned if the collaboration creator sets a `TRUE` value for more than one member in the collaboration.   
An error is returned if the collaboration creator sets a `FALSE` value for the member who can run queries and jobs.  
Type: Boolean  
Required: Yes

## See Also
<a name="API_JobComputePaymentConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/JobComputePaymentConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/JobComputePaymentConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/JobComputePaymentConfig) 

# MemberChangeSpecification
<a name="API_MemberChangeSpecification"></a>

Specifies changes to collaboration membership, including adding new members with their abilities and display names.

## Contents
<a name="API_MemberChangeSpecification_Contents"></a>

 ** accountId **   <a name="API-Type-MemberChangeSpecification-accountId"></a>
The AWS account ID of the member to add to the collaboration.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: Yes

 ** memberAbilities **   <a name="API-Type-MemberChangeSpecification-memberAbilities"></a>
The abilities granted to the collaboration member. These determine what actions the member can perform within the collaboration.  
The following values are currently not supported: `CAN_QUERY` and `CAN_RUN_JOB`.   
Set the value of `memberAbilities` to `[]` to allow a member to contribute data.  
Set the value of `memberAbilities` to `[CAN_RECEIVE_RESULTS]` to allow a member to contribute data and receive results.
Type: Array of strings  
Valid Values: `CAN_QUERY | CAN_RECEIVE_RESULTS | CAN_RUN_JOB`   
Required: Yes

 ** displayName **   <a name="API-Type-MemberChangeSpecification-displayName"></a>
Specifies the display name that will be shown for this member in the collaboration. While this field is required when inviting new members, it becomes optional when modifying abilities of existing collaboration members.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*`   
Required: No

## See Also
<a name="API_MemberChangeSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/MemberChangeSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/MemberChangeSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/MemberChangeSpecification) 

# Membership
<a name="API_Membership"></a>

The membership object.

## Contents
<a name="API_Membership_Contents"></a>

 ** arn **   <a name="API-Type-Membership-arn"></a>
The unique ARN for the membership.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+`   
Required: Yes

 ** collaborationArn **   <a name="API-Type-Membership-collaborationArn"></a>
The unique ARN for the membership's associated collaboration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** collaborationCreatorAccountId **   <a name="API-Type-Membership-collaborationCreatorAccountId"></a>
The identifier used to reference members of the collaboration. Currently only supports AWS account ID.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: Yes

 ** collaborationCreatorDisplayName **   <a name="API-Type-Membership-collaborationCreatorDisplayName"></a>
The display name of the collaboration creator.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*`   
Required: Yes

 ** collaborationId **   <a name="API-Type-Membership-collaborationId"></a>
The unique ID for the membership's collaboration.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** collaborationName **   <a name="API-Type-Membership-collaborationName"></a>
The name of the membership's collaboration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*`   
Required: Yes

 ** createTime **   <a name="API-Type-Membership-createTime"></a>
The time when the membership was created.  
Type: Timestamp  
Required: Yes

 ** id **   <a name="API-Type-Membership-id"></a>
The unique ID of the membership.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** memberAbilities **   <a name="API-Type-Membership-memberAbilities"></a>
The abilities granted to the collaboration member.  
Type: Array of strings  
Valid Values: `CAN_QUERY | CAN_RECEIVE_RESULTS | CAN_RUN_JOB`   
Required: Yes

 ** paymentConfiguration **   <a name="API-Type-Membership-paymentConfiguration"></a>
The payment responsibilities accepted by the collaboration member.  
Type: [MembershipPaymentConfiguration](API_MembershipPaymentConfiguration.md) object  
Required: Yes

 ** queryLogStatus **   <a name="API-Type-Membership-queryLogStatus"></a>
An indicator as to whether query logging has been enabled or disabled for the membership.  
When `ENABLED`, AWS Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is `DISABLED`.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: Yes

 ** status **   <a name="API-Type-Membership-status"></a>
The status of the membership.  
Type: String  
Valid Values: `ACTIVE | REMOVED | COLLABORATION_DELETED`   
Required: Yes

 ** updateTime **   <a name="API-Type-Membership-updateTime"></a>
The time the membership metadata was last updated.  
Type: Timestamp  
Required: Yes

 ** defaultJobResultConfiguration **   <a name="API-Type-Membership-defaultJobResultConfiguration"></a>
 The default job result configuration for the membership.  
Type: [MembershipProtectedJobResultConfiguration](API_MembershipProtectedJobResultConfiguration.md) object  
Required: No

 ** defaultResultConfiguration **   <a name="API-Type-Membership-defaultResultConfiguration"></a>
The default protected query result configuration as specified by the member who can receive results.  
Type: [MembershipProtectedQueryResultConfiguration](API_MembershipProtectedQueryResultConfiguration.md) object  
Required: No

 ** isMetricsEnabled **   <a name="API-Type-Membership-isMetricsEnabled"></a>
An indicator as to whether Amazon CloudWatch metrics are enabled for the membership.  
When `true`, metrics about query execution are collected in Amazon CloudWatch.  
Type: Boolean  
Required: No

 ** jobLogStatus **   <a name="API-Type-Membership-jobLogStatus"></a>
An indicator as to whether job logging has been enabled or disabled for the collaboration.   
When `ENABLED`, AWS Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is `DISABLED`.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** mlMemberAbilities **   <a name="API-Type-Membership-mlMemberAbilities"></a>
Specifies the ML member abilities that are granted to a collaboration member.  
Type: [MLMemberAbilities](API_MLMemberAbilities.md) object  
Required: No

## See Also
<a name="API_Membership_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/Membership) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/Membership) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/Membership) 

# MembershipJobComputePaymentConfig
<a name="API_MembershipJobComputePaymentConfig"></a>

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

## Contents
<a name="API_MembershipJobComputePaymentConfig_Contents"></a>

 ** isResponsible **   <a name="API-Type-MembershipJobComputePaymentConfig-isResponsible"></a>
Indicates whether the collaboration member has accepted to pay for job compute costs (`TRUE`) or has not accepted to pay for query and job compute costs (`FALSE`).  
There is only one member who pays for queries and jobs.   
An error message is returned for the following reasons:   
+ If you set the value to `FALSE` but you are responsible to pay for query and job compute costs. 
+ If you set the value to `TRUE` but you are not responsible to pay for query and job compute costs. 
Type: Boolean  
Required: Yes

## See Also
<a name="API_MembershipJobComputePaymentConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/MembershipJobComputePaymentConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/MembershipJobComputePaymentConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/MembershipJobComputePaymentConfig) 

# MembershipMLPaymentConfig
<a name="API_MembershipMLPaymentConfig"></a>

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

## Contents
<a name="API_MembershipMLPaymentConfig_Contents"></a>

 ** modelInference **   <a name="API-Type-MembershipMLPaymentConfig-modelInference"></a>
The payment responsibilities accepted by the member for model inference.  
Type: [MembershipModelInferencePaymentConfig](API_MembershipModelInferencePaymentConfig.md) object  
Required: No

 ** modelTraining **   <a name="API-Type-MembershipMLPaymentConfig-modelTraining"></a>
The payment responsibilities accepted by the member for model training.  
Type: [MembershipModelTrainingPaymentConfig](API_MembershipModelTrainingPaymentConfig.md) object  
Required: No

 ** syntheticDataGeneration **   <a name="API-Type-MembershipMLPaymentConfig-syntheticDataGeneration"></a>
The payment configuration for synthetic data generation for this machine learning membership.  
Type: [MembershipSyntheticDataGenerationPaymentConfig](API_MembershipSyntheticDataGenerationPaymentConfig.md) object  
Required: No

## See Also
<a name="API_MembershipMLPaymentConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/MembershipMLPaymentConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/MembershipMLPaymentConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/MembershipMLPaymentConfig) 

# MembershipModelInferencePaymentConfig
<a name="API_MembershipModelInferencePaymentConfig"></a>

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

## Contents
<a name="API_MembershipModelInferencePaymentConfig_Contents"></a>

 ** isResponsible **   <a name="API-Type-MembershipModelInferencePaymentConfig-isResponsible"></a>
Indicates whether the collaboration member has accepted to pay for model inference costs (`TRUE`) or has not accepted to pay for model inference costs (`FALSE`).  
If the collaboration creator has not specified anyone to pay for model inference costs, then the member who can query is the default payer.   
An error message is returned for the following reasons:   
+ If you set the value to `FALSE` but you are responsible to pay for model inference costs. 
+ If you set the value to `TRUE` but you are not responsible to pay for model inference costs. 
Type: Boolean  
Required: Yes

## See Also
<a name="API_MembershipModelInferencePaymentConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/MembershipModelInferencePaymentConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/MembershipModelInferencePaymentConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/MembershipModelInferencePaymentConfig) 

# MembershipModelTrainingPaymentConfig
<a name="API_MembershipModelTrainingPaymentConfig"></a>

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

## Contents
<a name="API_MembershipModelTrainingPaymentConfig_Contents"></a>

 ** isResponsible **   <a name="API-Type-MembershipModelTrainingPaymentConfig-isResponsible"></a>
Indicates whether the collaboration member has accepted to pay for model training costs (`TRUE`) or has not accepted to pay for model training costs (`FALSE`).  
If the collaboration creator has not specified anyone to pay for model training costs, then the member who can query is the default payer.   
An error message is returned for the following reasons:   
+ If you set the value to `FALSE` but you are responsible to pay for model training costs. 
+ If you set the value to `TRUE` but you are not responsible to pay for model training costs. 
Type: Boolean  
Required: Yes

## See Also
<a name="API_MembershipModelTrainingPaymentConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/MembershipModelTrainingPaymentConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/MembershipModelTrainingPaymentConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/MembershipModelTrainingPaymentConfig) 

# MembershipPaymentConfiguration
<a name="API_MembershipPaymentConfiguration"></a>

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

## Contents
<a name="API_MembershipPaymentConfiguration_Contents"></a>

 ** queryCompute **   <a name="API-Type-MembershipPaymentConfiguration-queryCompute"></a>
The payment responsibilities accepted by the collaboration member for query compute costs.  
Type: [MembershipQueryComputePaymentConfig](API_MembershipQueryComputePaymentConfig.md) object  
Required: Yes

 ** jobCompute **   <a name="API-Type-MembershipPaymentConfiguration-jobCompute"></a>
The payment responsibilities accepted by the collaboration member for job compute costs.  
Type: [MembershipJobComputePaymentConfig](API_MembershipJobComputePaymentConfig.md) object  
Required: No

 ** machineLearning **   <a name="API-Type-MembershipPaymentConfiguration-machineLearning"></a>
The payment responsibilities accepted by the collaboration member for machine learning costs.  
Type: [MembershipMLPaymentConfig](API_MembershipMLPaymentConfig.md) object  
Required: No

## See Also
<a name="API_MembershipPaymentConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/MembershipPaymentConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/MembershipPaymentConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/MembershipPaymentConfiguration) 

# MembershipProtectedJobOutputConfiguration
<a name="API_MembershipProtectedJobOutputConfiguration"></a>

Contains configurations for protected job results.

## Contents
<a name="API_MembershipProtectedJobOutputConfiguration_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** s3 **   <a name="API-Type-MembershipProtectedJobOutputConfiguration-s3"></a>
Contains the configuration to write the job results to S3.  
Type: [ProtectedJobS3OutputConfigurationInput](API_ProtectedJobS3OutputConfigurationInput.md) object  
Required: No

## See Also
<a name="API_MembershipProtectedJobOutputConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/MembershipProtectedJobOutputConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/MembershipProtectedJobOutputConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/MembershipProtectedJobOutputConfiguration) 

# MembershipProtectedJobResultConfiguration
<a name="API_MembershipProtectedJobResultConfiguration"></a>

Contains configurations for protected job results.

## Contents
<a name="API_MembershipProtectedJobResultConfiguration_Contents"></a>

 ** outputConfiguration **   <a name="API-Type-MembershipProtectedJobResultConfiguration-outputConfiguration"></a>
 The output configuration for a protected job result.  
Type: [MembershipProtectedJobOutputConfiguration](API_MembershipProtectedJobOutputConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** roleArn **   <a name="API-Type-MembershipProtectedJobResultConfiguration-roleArn"></a>
The unique ARN for an IAM role that is used by AWS Clean Rooms to write protected job results to the result location, given by the member who can receive results.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 512.  
Pattern: `arn:aws:iam::[\w]+:role/[\w+=./@-]+`   
Required: Yes

## See Also
<a name="API_MembershipProtectedJobResultConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/MembershipProtectedJobResultConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/MembershipProtectedJobResultConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/MembershipProtectedJobResultConfiguration) 

# MembershipProtectedQueryOutputConfiguration
<a name="API_MembershipProtectedQueryOutputConfiguration"></a>

Contains configurations for protected query results.

## Contents
<a name="API_MembershipProtectedQueryOutputConfiguration_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** s3 **   <a name="API-Type-MembershipProtectedQueryOutputConfiguration-s3"></a>
Contains the configuration to write the query results to S3.  
Type: [ProtectedQueryS3OutputConfiguration](API_ProtectedQueryS3OutputConfiguration.md) object  
Required: No

## See Also
<a name="API_MembershipProtectedQueryOutputConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/MembershipProtectedQueryOutputConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/MembershipProtectedQueryOutputConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/MembershipProtectedQueryOutputConfiguration) 

# MembershipProtectedQueryResultConfiguration
<a name="API_MembershipProtectedQueryResultConfiguration"></a>

Contains configurations for protected query results.

## Contents
<a name="API_MembershipProtectedQueryResultConfiguration_Contents"></a>

 ** outputConfiguration **   <a name="API-Type-MembershipProtectedQueryResultConfiguration-outputConfiguration"></a>
Configuration for protected query results.  
Type: [MembershipProtectedQueryOutputConfiguration](API_MembershipProtectedQueryOutputConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** roleArn **   <a name="API-Type-MembershipProtectedQueryResultConfiguration-roleArn"></a>
The unique ARN for an IAM role that is used by AWS Clean Rooms to write protected query results to the result location, given by the member who can receive results.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 512.  
Pattern: `arn:aws:iam::[\w]+:role/[\w+=./@-]+`   
Required: No

## See Also
<a name="API_MembershipProtectedQueryResultConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/MembershipProtectedQueryResultConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/MembershipProtectedQueryResultConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/MembershipProtectedQueryResultConfiguration) 

# MembershipQueryComputePaymentConfig
<a name="API_MembershipQueryComputePaymentConfig"></a>

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

## Contents
<a name="API_MembershipQueryComputePaymentConfig_Contents"></a>

 ** isResponsible **   <a name="API-Type-MembershipQueryComputePaymentConfig-isResponsible"></a>
Indicates whether the collaboration member has accepted to pay for query compute costs (`TRUE`) or has not accepted to pay for query compute costs (`FALSE`).  
If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer.   
An error message is returned for the following reasons:   
+ If you set the value to `FALSE` but you are responsible to pay for query compute costs. 
+ If you set the value to `TRUE` but you are not responsible to pay for query compute costs. 
Type: Boolean  
Required: Yes

## See Also
<a name="API_MembershipQueryComputePaymentConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/MembershipQueryComputePaymentConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/MembershipQueryComputePaymentConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/MembershipQueryComputePaymentConfig) 

# MembershipSummary
<a name="API_MembershipSummary"></a>

The membership object listed by the request.

## Contents
<a name="API_MembershipSummary_Contents"></a>

 ** arn **   <a name="API-Type-MembershipSummary-arn"></a>
The unique ARN for the membership.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+`   
Required: Yes

 ** collaborationArn **   <a name="API-Type-MembershipSummary-collaborationArn"></a>
The unique ARN for the membership's associated collaboration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** collaborationCreatorAccountId **   <a name="API-Type-MembershipSummary-collaborationCreatorAccountId"></a>
The identifier of the AWS principal that created the collaboration. Currently only supports AWS account ID.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: Yes

 ** collaborationCreatorDisplayName **   <a name="API-Type-MembershipSummary-collaborationCreatorDisplayName"></a>
The display name of the collaboration creator.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*`   
Required: Yes

 ** collaborationId **   <a name="API-Type-MembershipSummary-collaborationId"></a>
The unique ID for the membership's collaboration.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** collaborationName **   <a name="API-Type-MembershipSummary-collaborationName"></a>
The name for the membership's collaboration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*`   
Required: Yes

 ** createTime **   <a name="API-Type-MembershipSummary-createTime"></a>
The time when the membership was created.  
Type: Timestamp  
Required: Yes

 ** id **   <a name="API-Type-MembershipSummary-id"></a>
The unique ID for the membership's collaboration.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** memberAbilities **   <a name="API-Type-MembershipSummary-memberAbilities"></a>
The abilities granted to the collaboration member.  
Type: Array of strings  
Valid Values: `CAN_QUERY | CAN_RECEIVE_RESULTS | CAN_RUN_JOB`   
Required: Yes

 ** paymentConfiguration **   <a name="API-Type-MembershipSummary-paymentConfiguration"></a>
The payment responsibilities accepted by the collaboration member.  
Type: [MembershipPaymentConfiguration](API_MembershipPaymentConfiguration.md) object  
Required: Yes

 ** status **   <a name="API-Type-MembershipSummary-status"></a>
The status of the membership.  
Type: String  
Valid Values: `ACTIVE | REMOVED | COLLABORATION_DELETED`   
Required: Yes

 ** updateTime **   <a name="API-Type-MembershipSummary-updateTime"></a>
The time the membership metadata was last updated.  
Type: Timestamp  
Required: Yes

 ** mlMemberAbilities **   <a name="API-Type-MembershipSummary-mlMemberAbilities"></a>
Provides a summary of the ML abilities for the collaboration member.  
Type: [MLMemberAbilities](API_MLMemberAbilities.md) object  
Required: No

## See Also
<a name="API_MembershipSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/MembershipSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/MembershipSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/MembershipSummary) 

# MembershipSyntheticDataGenerationPaymentConfig
<a name="API_MembershipSyntheticDataGenerationPaymentConfig"></a>

Configuration for payment for synthetic data generation in a membership.

## Contents
<a name="API_MembershipSyntheticDataGenerationPaymentConfig_Contents"></a>

 ** isResponsible **   <a name="API-Type-MembershipSyntheticDataGenerationPaymentConfig-isResponsible"></a>
Indicates if this membership is responsible for paying for synthetic data generation.  
Type: Boolean  
Required: Yes

## See Also
<a name="API_MembershipSyntheticDataGenerationPaymentConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/MembershipSyntheticDataGenerationPaymentConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/MembershipSyntheticDataGenerationPaymentConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/MembershipSyntheticDataGenerationPaymentConfig) 

# MemberSpecification
<a name="API_MemberSpecification"></a>

Basic metadata used to construct a new member.

## Contents
<a name="API_MemberSpecification_Contents"></a>

 ** accountId **   <a name="API-Type-MemberSpecification-accountId"></a>
The identifier used to reference members of the collaboration. Currently only supports AWS account ID.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: Yes

 ** displayName **   <a name="API-Type-MemberSpecification-displayName"></a>
The member's display name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*`   
Required: Yes

 ** memberAbilities **   <a name="API-Type-MemberSpecification-memberAbilities"></a>
The abilities granted to the collaboration member.  
Type: Array of strings  
Valid Values: `CAN_QUERY | CAN_RECEIVE_RESULTS | CAN_RUN_JOB`   
Required: Yes

 ** mlMemberAbilities **   <a name="API-Type-MemberSpecification-mlMemberAbilities"></a>
The ML abilities granted to the collaboration member.  
Type: [MLMemberAbilities](API_MLMemberAbilities.md) object  
Required: No

 ** paymentConfiguration **   <a name="API-Type-MemberSpecification-paymentConfiguration"></a>
The collaboration member's payment responsibilities set by the collaboration creator.   
If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer.  
Type: [PaymentConfiguration](API_PaymentConfiguration.md) object  
Required: No

## See Also
<a name="API_MemberSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/MemberSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/MemberSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/MemberSpecification) 

# MemberSummary
<a name="API_MemberSummary"></a>

The member object listed by the request.

## Contents
<a name="API_MemberSummary_Contents"></a>

 ** abilities **   <a name="API-Type-MemberSummary-abilities"></a>
The abilities granted to the collaboration member.  
Type: Array of strings  
Valid Values: `CAN_QUERY | CAN_RECEIVE_RESULTS | CAN_RUN_JOB`   
Required: Yes

 ** accountId **   <a name="API-Type-MemberSummary-accountId"></a>
The identifier used to reference members of the collaboration. Currently only supports AWS account ID.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: Yes

 ** createTime **   <a name="API-Type-MemberSummary-createTime"></a>
The time when the member was created.  
Type: Timestamp  
Required: Yes

 ** displayName **   <a name="API-Type-MemberSummary-displayName"></a>
The member's display name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*`   
Required: Yes

 ** paymentConfiguration **   <a name="API-Type-MemberSummary-paymentConfiguration"></a>
The collaboration member's payment responsibilities set by the collaboration creator.   
Type: [PaymentConfiguration](API_PaymentConfiguration.md) object  
Required: Yes

 ** status **   <a name="API-Type-MemberSummary-status"></a>
The status of the member.   
Type: String  
Valid Values: `INVITED | ACTIVE | LEFT | REMOVED`   
Required: Yes

 ** updateTime **   <a name="API-Type-MemberSummary-updateTime"></a>
The time the member metadata was last updated.  
Type: Timestamp  
Required: Yes

 ** membershipArn **   <a name="API-Type-MemberSummary-membershipArn"></a>
The unique ARN for the member's associated membership, if present.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+`   
Required: No

 ** membershipId **   <a name="API-Type-MemberSummary-membershipId"></a>
The unique ID for the member's associated membership, if present.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

 ** mlAbilities **   <a name="API-Type-MemberSummary-mlAbilities"></a>
Provides a summary of the ML abilities for the collaboration member.  
Type: [MLMemberAbilities](API_MLMemberAbilities.md) object  
Required: No

## See Also
<a name="API_MemberSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/MemberSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/MemberSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/MemberSummary) 

# MLMemberAbilities
<a name="API_MLMemberAbilities"></a>

The ML member abilities for a collaboration member.

## Contents
<a name="API_MLMemberAbilities_Contents"></a>

 ** customMLMemberAbilities **   <a name="API-Type-MLMemberAbilities-customMLMemberAbilities"></a>
The custom ML member abilities for a collaboration member.   
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Valid Values: `CAN_RECEIVE_MODEL_OUTPUT | CAN_RECEIVE_INFERENCE_OUTPUT`   
Required: Yes

## See Also
<a name="API_MLMemberAbilities_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/MLMemberAbilities) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/MLMemberAbilities) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/MLMemberAbilities) 

# MLPaymentConfig
<a name="API_MLPaymentConfig"></a>

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

## Contents
<a name="API_MLPaymentConfig_Contents"></a>

 ** modelInference **   <a name="API-Type-MLPaymentConfig-modelInference"></a>
The payment responsibilities accepted by the member for model inference.  
Type: [ModelInferencePaymentConfig](API_ModelInferencePaymentConfig.md) object  
Required: No

 ** modelTraining **   <a name="API-Type-MLPaymentConfig-modelTraining"></a>
The payment responsibilities accepted by the member for model training.  
Type: [ModelTrainingPaymentConfig](API_ModelTrainingPaymentConfig.md) object  
Required: No

 ** syntheticDataGeneration **   <a name="API-Type-MLPaymentConfig-syntheticDataGeneration"></a>
The payment configuration for machine learning synthetic data generation.  
Type: [SyntheticDataGenerationPaymentConfig](API_SyntheticDataGenerationPaymentConfig.md) object  
Required: No

## See Also
<a name="API_MLPaymentConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/MLPaymentConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/MLPaymentConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/MLPaymentConfig) 

# MLSyntheticDataParameters
<a name="API_MLSyntheticDataParameters"></a>

Parameters that control the generation of synthetic data for machine learning, including privacy settings and column classification details.

## Contents
<a name="API_MLSyntheticDataParameters_Contents"></a>

 ** columnClassification **   <a name="API-Type-MLSyntheticDataParameters-columnClassification"></a>
Classification details for data columns that specify how each column should be treated during synthetic data generation.  
Type: [ColumnClassificationDetails](API_ColumnClassificationDetails.md) object  
Required: Yes

 ** epsilon **   <a name="API-Type-MLSyntheticDataParameters-epsilon"></a>
The epsilon value for differential privacy when generating synthetic data. Lower values provide stronger privacy guarantees but may reduce data utility.  
Type: Double  
Valid Range: Minimum value of 0.0001. Maximum value of 10.  
Required: Yes

 ** maxMembershipInferenceAttackScore **   <a name="API-Type-MLSyntheticDataParameters-maxMembershipInferenceAttackScore"></a>
The maximum acceptable score for membership inference attack vulnerability. Synthetic data generation fails if the score for the resulting data exceeds this threshold.  
Type: Double  
Valid Range: Minimum value of 0.5. Maximum value of 1.  
Required: Yes

## See Also
<a name="API_MLSyntheticDataParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/MLSyntheticDataParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/MLSyntheticDataParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/MLSyntheticDataParameters) 

# ModelInferencePaymentConfig
<a name="API_ModelInferencePaymentConfig"></a>

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

## Contents
<a name="API_ModelInferencePaymentConfig_Contents"></a>

 ** isResponsible **   <a name="API-Type-ModelInferencePaymentConfig-isResponsible"></a>
Indicates whether the collaboration creator has configured the collaboration member to pay for model inference costs (`TRUE`) or has not configured the collaboration member to pay for model inference costs (`FALSE`).  
Exactly one member can be configured to pay for model inference costs. An error is returned if the collaboration creator sets a `TRUE` value for more than one member in the collaboration.   
If the collaboration creator hasn't specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a `FALSE` value for the member who can query.  
Type: Boolean  
Required: Yes

## See Also
<a name="API_ModelInferencePaymentConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ModelInferencePaymentConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ModelInferencePaymentConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ModelInferencePaymentConfig) 

# ModelTrainingPaymentConfig
<a name="API_ModelTrainingPaymentConfig"></a>

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

## Contents
<a name="API_ModelTrainingPaymentConfig_Contents"></a>

 ** isResponsible **   <a name="API-Type-ModelTrainingPaymentConfig-isResponsible"></a>
Indicates whether the collaboration creator has configured the collaboration member to pay for model training costs (`TRUE`) or has not configured the collaboration member to pay for model training costs (`FALSE`).  
Exactly one member can be configured to pay for model training costs. An error is returned if the collaboration creator sets a `TRUE` value for more than one member in the collaboration.   
If the collaboration creator hasn't specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a `FALSE` value for the member who can query.  
Type: Boolean  
Required: Yes

## See Also
<a name="API_ModelTrainingPaymentConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ModelTrainingPaymentConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ModelTrainingPaymentConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ModelTrainingPaymentConfig) 

# PaymentConfiguration
<a name="API_PaymentConfiguration"></a>

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

## Contents
<a name="API_PaymentConfiguration_Contents"></a>

 ** queryCompute **   <a name="API-Type-PaymentConfiguration-queryCompute"></a>
The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.  
Type: [QueryComputePaymentConfig](API_QueryComputePaymentConfig.md) object  
Required: Yes

 ** jobCompute **   <a name="API-Type-PaymentConfiguration-jobCompute"></a>
 The compute configuration for the job.  
Type: [JobComputePaymentConfig](API_JobComputePaymentConfig.md) object  
Required: No

 ** machineLearning **   <a name="API-Type-PaymentConfiguration-machineLearning"></a>
An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.  
Type: [MLPaymentConfig](API_MLPaymentConfig.md) object  
Required: No

## See Also
<a name="API_PaymentConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/PaymentConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/PaymentConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/PaymentConfiguration) 

# PreviewPrivacyImpactParametersInput
<a name="API_PreviewPrivacyImpactParametersInput"></a>

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.

## Contents
<a name="API_PreviewPrivacyImpactParametersInput_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** differentialPrivacy **   <a name="API-Type-PreviewPrivacyImpactParametersInput-differentialPrivacy"></a>
An array that specifies the epsilon and noise parameters.  
Type: [DifferentialPrivacyPreviewParametersInput](API_DifferentialPrivacyPreviewParametersInput.md) object  
Required: No

## See Also
<a name="API_PreviewPrivacyImpactParametersInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/PreviewPrivacyImpactParametersInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/PreviewPrivacyImpactParametersInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/PreviewPrivacyImpactParametersInput) 

# PrivacyBudget
<a name="API_PrivacyBudget"></a>

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

## Contents
<a name="API_PrivacyBudget_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** accessBudget **   <a name="API-Type-PrivacyBudget-accessBudget"></a>
Access budget information associated with this privacy budget.  
Type: [AccessBudget](API_AccessBudget.md) object  
Required: No

 ** differentialPrivacy **   <a name="API-Type-PrivacyBudget-differentialPrivacy"></a>
An object that specifies the epsilon parameter and the utility in terms of total aggregations, as well as the remaining aggregations available.  
Type: [DifferentialPrivacyPrivacyBudget](API_DifferentialPrivacyPrivacyBudget.md) object  
Required: No

## See Also
<a name="API_PrivacyBudget_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/PrivacyBudget) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/PrivacyBudget) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/PrivacyBudget) 

# PrivacyBudgetSummary
<a name="API_PrivacyBudgetSummary"></a>

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

## Contents
<a name="API_PrivacyBudgetSummary_Contents"></a>

 ** budget **   <a name="API-Type-PrivacyBudgetSummary-budget"></a>
The provided privacy budget.  
Type: [PrivacyBudget](API_PrivacyBudget.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** collaborationArn **   <a name="API-Type-PrivacyBudgetSummary-collaborationArn"></a>
The ARN of the collaboration that contains this privacy budget.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** collaborationId **   <a name="API-Type-PrivacyBudgetSummary-collaborationId"></a>
The unique identifier of the collaboration that contains this privacy budget.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** createTime **   <a name="API-Type-PrivacyBudgetSummary-createTime"></a>
The time at which the privacy budget was created.  
Type: Timestamp  
Required: Yes

 ** id **   <a name="API-Type-PrivacyBudgetSummary-id"></a>
The unique identifier of the privacy budget.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** membershipArn **   <a name="API-Type-PrivacyBudgetSummary-membershipArn"></a>
The Amazon Resource Name (ARN) of the member who created the privacy budget summary.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+`   
Required: Yes

 ** membershipId **   <a name="API-Type-PrivacyBudgetSummary-membershipId"></a>
The identifier for a membership resource.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** privacyBudgetTemplateArn **   <a name="API-Type-PrivacyBudgetSummary-privacyBudgetTemplateArn"></a>
The ARN of the privacy budget template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:privacybudgettemplate/[\d\w-]+`   
Required: Yes

 ** privacyBudgetTemplateId **   <a name="API-Type-PrivacyBudgetSummary-privacyBudgetTemplateId"></a>
The unique identifier of the privacy budget template.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** type **   <a name="API-Type-PrivacyBudgetSummary-type"></a>
Specifies the type of the privacy budget.  
Type: String  
Valid Values: `DIFFERENTIAL_PRIVACY | ACCESS_BUDGET`   
Required: Yes

 ** updateTime **   <a name="API-Type-PrivacyBudgetSummary-updateTime"></a>
The most recent time at which the privacy budget was updated.  
Type: Timestamp  
Required: Yes

## See Also
<a name="API_PrivacyBudgetSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/PrivacyBudgetSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/PrivacyBudgetSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/PrivacyBudgetSummary) 

# PrivacyBudgetTemplate
<a name="API_PrivacyBudgetTemplate"></a>

An object that defines the privacy budget template.

## Contents
<a name="API_PrivacyBudgetTemplate_Contents"></a>

 ** arn **   <a name="API-Type-PrivacyBudgetTemplate-arn"></a>
The ARN of the privacy budget template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:privacybudgettemplate/[\d\w-]+`   
Required: Yes

 ** autoRefresh **   <a name="API-Type-PrivacyBudgetTemplate-autoRefresh"></a>
How often the privacy budget refreshes.  
If you plan to regularly bring new data into the collaboration, use `CALENDAR_MONTH` to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.
Type: String  
Valid Values: `CALENDAR_MONTH | NONE`   
Required: Yes

 ** collaborationArn **   <a name="API-Type-PrivacyBudgetTemplate-collaborationArn"></a>
The ARN of the collaboration that contains this privacy budget template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** collaborationId **   <a name="API-Type-PrivacyBudgetTemplate-collaborationId"></a>
The unique ID of the collaboration that contains this privacy budget template.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** createTime **   <a name="API-Type-PrivacyBudgetTemplate-createTime"></a>
The time at which the privacy budget template was created.  
Type: Timestamp  
Required: Yes

 ** id **   <a name="API-Type-PrivacyBudgetTemplate-id"></a>
The unique identifier of the privacy budget template.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** membershipArn **   <a name="API-Type-PrivacyBudgetTemplate-membershipArn"></a>
The Amazon Resource Name (ARN) of the member who created the privacy budget template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+`   
Required: Yes

 ** membershipId **   <a name="API-Type-PrivacyBudgetTemplate-membershipId"></a>
The identifier for a membership resource.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** parameters **   <a name="API-Type-PrivacyBudgetTemplate-parameters"></a>
Specifies the epsilon and noise parameters for the privacy budget template.  
Type: [PrivacyBudgetTemplateParametersOutput](API_PrivacyBudgetTemplateParametersOutput.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** privacyBudgetType **   <a name="API-Type-PrivacyBudgetTemplate-privacyBudgetType"></a>
Specifies the type of the privacy budget template.  
Type: String  
Valid Values: `DIFFERENTIAL_PRIVACY | ACCESS_BUDGET`   
Required: Yes

 ** updateTime **   <a name="API-Type-PrivacyBudgetTemplate-updateTime"></a>
The most recent time at which the privacy budget template was updated.  
Type: Timestamp  
Required: Yes

## See Also
<a name="API_PrivacyBudgetTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/PrivacyBudgetTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/PrivacyBudgetTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/PrivacyBudgetTemplate) 

# PrivacyBudgetTemplateParametersInput
<a name="API_PrivacyBudgetTemplateParametersInput"></a>

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

## Contents
<a name="API_PrivacyBudgetTemplateParametersInput_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** accessBudget **   <a name="API-Type-PrivacyBudgetTemplateParametersInput-accessBudget"></a>
Access budget configuration for the privacy budget template input, enabling integration with access budget functionality.  
Type: [AccessBudgetsPrivacyTemplateParametersInput](API_AccessBudgetsPrivacyTemplateParametersInput.md) object  
Required: No

 ** differentialPrivacy **   <a name="API-Type-PrivacyBudgetTemplateParametersInput-differentialPrivacy"></a>
An object that specifies the epsilon and noise parameters.  
Type: [DifferentialPrivacyTemplateParametersInput](API_DifferentialPrivacyTemplateParametersInput.md) object  
Required: No

## See Also
<a name="API_PrivacyBudgetTemplateParametersInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/PrivacyBudgetTemplateParametersInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/PrivacyBudgetTemplateParametersInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/PrivacyBudgetTemplateParametersInput) 

# PrivacyBudgetTemplateParametersOutput
<a name="API_PrivacyBudgetTemplateParametersOutput"></a>

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

## Contents
<a name="API_PrivacyBudgetTemplateParametersOutput_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** accessBudget **   <a name="API-Type-PrivacyBudgetTemplateParametersOutput-accessBudget"></a>
Access budget configuration returned from the privacy budget template, containing the configured access budget settings.  
Type: [AccessBudgetsPrivacyTemplateParametersOutput](API_AccessBudgetsPrivacyTemplateParametersOutput.md) object  
Required: No

 ** differentialPrivacy **   <a name="API-Type-PrivacyBudgetTemplateParametersOutput-differentialPrivacy"></a>
The epsilon and noise parameters.  
Type: [DifferentialPrivacyTemplateParametersOutput](API_DifferentialPrivacyTemplateParametersOutput.md) object  
Required: No

## See Also
<a name="API_PrivacyBudgetTemplateParametersOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/PrivacyBudgetTemplateParametersOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/PrivacyBudgetTemplateParametersOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/PrivacyBudgetTemplateParametersOutput) 

# PrivacyBudgetTemplateSummary
<a name="API_PrivacyBudgetTemplateSummary"></a>

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

## Contents
<a name="API_PrivacyBudgetTemplateSummary_Contents"></a>

 ** arn **   <a name="API-Type-PrivacyBudgetTemplateSummary-arn"></a>
The ARN of the privacy budget template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:privacybudgettemplate/[\d\w-]+`   
Required: Yes

 ** collaborationArn **   <a name="API-Type-PrivacyBudgetTemplateSummary-collaborationArn"></a>
The ARN of the collaboration that contains this privacy budget template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** collaborationId **   <a name="API-Type-PrivacyBudgetTemplateSummary-collaborationId"></a>
The unique ID of the collaboration that contains this privacy budget template.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** createTime **   <a name="API-Type-PrivacyBudgetTemplateSummary-createTime"></a>
The time at which the privacy budget template was created.  
Type: Timestamp  
Required: Yes

 ** id **   <a name="API-Type-PrivacyBudgetTemplateSummary-id"></a>
The unique identifier of the privacy budget template.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** membershipArn **   <a name="API-Type-PrivacyBudgetTemplateSummary-membershipArn"></a>
The Amazon Resource Name (ARN) of the member who created the privacy budget template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+`   
Required: Yes

 ** membershipId **   <a name="API-Type-PrivacyBudgetTemplateSummary-membershipId"></a>
The identifier for a membership resource.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** privacyBudgetType **   <a name="API-Type-PrivacyBudgetTemplateSummary-privacyBudgetType"></a>
The type of the privacy budget template.  
Type: String  
Valid Values: `DIFFERENTIAL_PRIVACY | ACCESS_BUDGET`   
Required: Yes

 ** updateTime **   <a name="API-Type-PrivacyBudgetTemplateSummary-updateTime"></a>
The most recent time at which the privacy budget template was updated.  
Type: Timestamp  
Required: Yes

## See Also
<a name="API_PrivacyBudgetTemplateSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/PrivacyBudgetTemplateSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/PrivacyBudgetTemplateSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/PrivacyBudgetTemplateSummary) 

# PrivacyBudgetTemplateUpdateParameters
<a name="API_PrivacyBudgetTemplateUpdateParameters"></a>

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

## Contents
<a name="API_PrivacyBudgetTemplateUpdateParameters_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** accessBudget **   <a name="API-Type-PrivacyBudgetTemplateUpdateParameters-accessBudget"></a>
 The new access budget configuration that completely replaces the existing access budget settings in the privacy budget template.  
Type: [AccessBudgetsPrivacyTemplateUpdateParameters](API_AccessBudgetsPrivacyTemplateUpdateParameters.md) object  
Required: No

 ** differentialPrivacy **   <a name="API-Type-PrivacyBudgetTemplateUpdateParameters-differentialPrivacy"></a>
An object that specifies the new values for the epsilon and noise parameters.  
Type: [DifferentialPrivacyTemplateUpdateParameters](API_DifferentialPrivacyTemplateUpdateParameters.md) object  
Required: No

## See Also
<a name="API_PrivacyBudgetTemplateUpdateParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/PrivacyBudgetTemplateUpdateParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/PrivacyBudgetTemplateUpdateParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/PrivacyBudgetTemplateUpdateParameters) 

# PrivacyImpact
<a name="API_PrivacyImpact"></a>

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

## Contents
<a name="API_PrivacyImpact_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** differentialPrivacy **   <a name="API-Type-PrivacyImpact-differentialPrivacy"></a>
An object that lists the number and type of aggregation functions you can perform.  
Type: [DifferentialPrivacyPrivacyImpact](API_DifferentialPrivacyPrivacyImpact.md) object  
Required: No

## See Also
<a name="API_PrivacyImpact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/PrivacyImpact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/PrivacyImpact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/PrivacyImpact) 

# ProtectedJob
<a name="API_ProtectedJob"></a>

The parameters for an AWS Clean Rooms protected job.

## Contents
<a name="API_ProtectedJob_Contents"></a>

 ** createTime **   <a name="API-Type-ProtectedJob-createTime"></a>
 The creation time of the protected job.  
Type: Timestamp  
Required: Yes

 ** id **   <a name="API-Type-ProtectedJob-id"></a>
The identifier for a protected job instance.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** membershipArn **   <a name="API-Type-ProtectedJob-membershipArn"></a>
The ARN of the membership.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+`   
Required: Yes

 ** membershipId **   <a name="API-Type-ProtectedJob-membershipId"></a>
he identifier for the membership.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** status **   <a name="API-Type-ProtectedJob-status"></a>
 The status of the protected job.  
Type: String  
Valid Values: `SUBMITTED | STARTED | CANCELLED | CANCELLING | FAILED | SUCCESS`   
Required: Yes

 ** computeConfiguration **   <a name="API-Type-ProtectedJob-computeConfiguration"></a>
The compute configuration for the protected job.  
Type: [ProtectedJobComputeConfiguration](API_ProtectedJobComputeConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** error **   <a name="API-Type-ProtectedJob-error"></a>
 The error from the protected job.  
Type: [ProtectedJobError](API_ProtectedJobError.md) object  
Required: No

 ** jobParameters **   <a name="API-Type-ProtectedJob-jobParameters"></a>
 The job parameters for the protected job.  
Type: [ProtectedJobParameters](API_ProtectedJobParameters.md) object  
Required: No

 ** result **   <a name="API-Type-ProtectedJob-result"></a>
 The result of the protected job.  
Type: [ProtectedJobResult](API_ProtectedJobResult.md) object  
Required: No

 ** resultConfiguration **   <a name="API-Type-ProtectedJob-resultConfiguration"></a>
Contains any details needed to write the job results.  
Type: [ProtectedJobResultConfigurationOutput](API_ProtectedJobResultConfigurationOutput.md) object  
Required: No

 ** statistics **   <a name="API-Type-ProtectedJob-statistics"></a>
 The statistics of the protected job.  
Type: [ProtectedJobStatistics](API_ProtectedJobStatistics.md) object  
Required: No

## See Also
<a name="API_ProtectedJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedJob) 

# ProtectedJobComputeConfiguration
<a name="API_ProtectedJobComputeConfiguration"></a>

The configuration of the compute resources for a PySpark job.

## Contents
<a name="API_ProtectedJobComputeConfiguration_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** worker **   <a name="API-Type-ProtectedJobComputeConfiguration-worker"></a>
The worker configuration for the compute environment.  
Type: [ProtectedJobWorkerComputeConfiguration](API_ProtectedJobWorkerComputeConfiguration.md) object  
Required: No

## See Also
<a name="API_ProtectedJobComputeConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedJobComputeConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedJobComputeConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedJobComputeConfiguration) 

# ProtectedJobConfigurationDetails
<a name="API_ProtectedJobConfigurationDetails"></a>

The protected job configuration details.

## Contents
<a name="API_ProtectedJobConfigurationDetails_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** directAnalysisConfigurationDetails **   <a name="API-Type-ProtectedJobConfigurationDetails-directAnalysisConfigurationDetails"></a>
The details needed to configure the direct analysis.  
Type: [ProtectedJobDirectAnalysisConfigurationDetails](API_ProtectedJobDirectAnalysisConfigurationDetails.md) object  
Required: No

## See Also
<a name="API_ProtectedJobConfigurationDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedJobConfigurationDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedJobConfigurationDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedJobConfigurationDetails) 

# ProtectedJobDirectAnalysisConfigurationDetails
<a name="API_ProtectedJobDirectAnalysisConfigurationDetails"></a>

The protected job direct analysis configuration details.

## Contents
<a name="API_ProtectedJobDirectAnalysisConfigurationDetails_Contents"></a>

 ** receiverAccountIds **   <a name="API-Type-ProtectedJobDirectAnalysisConfigurationDetails-receiverAccountIds"></a>
 The receiver account IDs.  
Type: Array of strings  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: No

## See Also
<a name="API_ProtectedJobDirectAnalysisConfigurationDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedJobDirectAnalysisConfigurationDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedJobDirectAnalysisConfigurationDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedJobDirectAnalysisConfigurationDetails) 

# ProtectedJobError
<a name="API_ProtectedJobError"></a>

The protected job error.

## Contents
<a name="API_ProtectedJobError_Contents"></a>

 ** code **   <a name="API-Type-ProtectedJobError-code"></a>
 The error code for the protected job.  
Type: String  
Required: Yes

 ** message **   <a name="API-Type-ProtectedJobError-message"></a>
 The message for the protected job error.  
Type: String  
Required: Yes

## See Also
<a name="API_ProtectedJobError_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedJobError) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedJobError) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedJobError) 

# ProtectedJobMemberOutputConfigurationInput
<a name="API_ProtectedJobMemberOutputConfigurationInput"></a>

 The protected job member output configuration input.

## Contents
<a name="API_ProtectedJobMemberOutputConfigurationInput_Contents"></a>

 ** accountId **   <a name="API-Type-ProtectedJobMemberOutputConfigurationInput-accountId"></a>
 The account ID.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: Yes

## See Also
<a name="API_ProtectedJobMemberOutputConfigurationInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedJobMemberOutputConfigurationInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedJobMemberOutputConfigurationInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedJobMemberOutputConfigurationInput) 

# ProtectedJobMemberOutputConfigurationOutput
<a name="API_ProtectedJobMemberOutputConfigurationOutput"></a>

 The protected job member output configuration output.

## Contents
<a name="API_ProtectedJobMemberOutputConfigurationOutput_Contents"></a>

 ** accountId **   <a name="API-Type-ProtectedJobMemberOutputConfigurationOutput-accountId"></a>
 The account ID.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: Yes

## See Also
<a name="API_ProtectedJobMemberOutputConfigurationOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedJobMemberOutputConfigurationOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedJobMemberOutputConfigurationOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedJobMemberOutputConfigurationOutput) 

# ProtectedJobOutput
<a name="API_ProtectedJobOutput"></a>

Contains details about the protected job output.

## Contents
<a name="API_ProtectedJobOutput_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** memberList **   <a name="API-Type-ProtectedJobOutput-memberList"></a>
The list of member AWS account(s) that received the results of the job.   
Type: Array of [ProtectedJobSingleMemberOutput](API_ProtectedJobSingleMemberOutput.md) objects  
Required: No

 ** s3 **   <a name="API-Type-ProtectedJobOutput-s3"></a>
If present, the output for a protected job with an `S3` output type.  
Type: [ProtectedJobS3Output](API_ProtectedJobS3Output.md) object  
Required: No

## See Also
<a name="API_ProtectedJobOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedJobOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedJobOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedJobOutput) 

# ProtectedJobOutputConfigurationInput
<a name="API_ProtectedJobOutputConfigurationInput"></a>

 The protected job output configuration input.

## Contents
<a name="API_ProtectedJobOutputConfigurationInput_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** member **   <a name="API-Type-ProtectedJobOutputConfigurationInput-member"></a>
 The member of the protected job output configuration input.  
Type: [ProtectedJobMemberOutputConfigurationInput](API_ProtectedJobMemberOutputConfigurationInput.md) object  
Required: No

## See Also
<a name="API_ProtectedJobOutputConfigurationInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedJobOutputConfigurationInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedJobOutputConfigurationInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedJobOutputConfigurationInput) 

# ProtectedJobOutputConfigurationOutput
<a name="API_ProtectedJobOutputConfigurationOutput"></a>

 The protected job output configuration output.

## Contents
<a name="API_ProtectedJobOutputConfigurationOutput_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** member **   <a name="API-Type-ProtectedJobOutputConfigurationOutput-member"></a>
 The member output configuration for a protected job.  
Type: [ProtectedJobMemberOutputConfigurationOutput](API_ProtectedJobMemberOutputConfigurationOutput.md) object  
Required: No

 ** s3 **   <a name="API-Type-ProtectedJobOutputConfigurationOutput-s3"></a>
If present, the output for a protected job with an `S3` output type.  
Type: [ProtectedJobS3OutputConfigurationOutput](API_ProtectedJobS3OutputConfigurationOutput.md) object  
Required: No

## See Also
<a name="API_ProtectedJobOutputConfigurationOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedJobOutputConfigurationOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedJobOutputConfigurationOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedJobOutputConfigurationOutput) 

# ProtectedJobParameters
<a name="API_ProtectedJobParameters"></a>

The parameters for the protected job.

## Contents
<a name="API_ProtectedJobParameters_Contents"></a>

 ** analysisTemplateArn **   <a name="API-Type-ProtectedJobParameters-analysisTemplateArn"></a>
 The ARN of the analysis template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Pattern: `arn:aws[-a-z]*:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/analysistemplate/[\d\w-]+`   
Required: Yes

 ** parameters **   <a name="API-Type-ProtectedJobParameters-parameters"></a>
Runtime configuration values passed to the PySpark analysis script. Parameter names and types must match those defined in the analysis template.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 100.  
Key Pattern: `[0-9a-zA-Z_]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 1000.  
Required: No

## See Also
<a name="API_ProtectedJobParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedJobParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedJobParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedJobParameters) 

# ProtectedJobReceiverConfiguration
<a name="API_ProtectedJobReceiverConfiguration"></a>

The protected job receiver configuration.

## Contents
<a name="API_ProtectedJobReceiverConfiguration_Contents"></a>

 ** analysisType **   <a name="API-Type-ProtectedJobReceiverConfiguration-analysisType"></a>
 The analysis type for the protected job receiver configuration.  
Type: String  
Valid Values: `DIRECT_ANALYSIS`   
Required: Yes

 ** configurationDetails **   <a name="API-Type-ProtectedJobReceiverConfiguration-configurationDetails"></a>
 The configuration details for the protected job receiver.  
Type: [ProtectedJobConfigurationDetails](API_ProtectedJobConfigurationDetails.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## See Also
<a name="API_ProtectedJobReceiverConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedJobReceiverConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedJobReceiverConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedJobReceiverConfiguration) 

# ProtectedJobResult
<a name="API_ProtectedJobResult"></a>

Details about the job results.

## Contents
<a name="API_ProtectedJobResult_Contents"></a>

 ** output **   <a name="API-Type-ProtectedJobResult-output"></a>
 The output of the protected job.  
Type: [ProtectedJobOutput](API_ProtectedJobOutput.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## See Also
<a name="API_ProtectedJobResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedJobResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedJobResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedJobResult) 

# ProtectedJobResultConfigurationInput
<a name="API_ProtectedJobResultConfigurationInput"></a>

The protected job result configuration input.

## Contents
<a name="API_ProtectedJobResultConfigurationInput_Contents"></a>

 ** outputConfiguration **   <a name="API-Type-ProtectedJobResultConfigurationInput-outputConfiguration"></a>
 The output configuration for a protected job result.  
Type: [ProtectedJobOutputConfigurationInput](API_ProtectedJobOutputConfigurationInput.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## See Also
<a name="API_ProtectedJobResultConfigurationInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedJobResultConfigurationInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedJobResultConfigurationInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedJobResultConfigurationInput) 

# ProtectedJobResultConfigurationOutput
<a name="API_ProtectedJobResultConfigurationOutput"></a>

The output configuration for a protected job result.

## Contents
<a name="API_ProtectedJobResultConfigurationOutput_Contents"></a>

 ** outputConfiguration **   <a name="API-Type-ProtectedJobResultConfigurationOutput-outputConfiguration"></a>
The output configuration.  
Type: [ProtectedJobOutputConfigurationOutput](API_ProtectedJobOutputConfigurationOutput.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## See Also
<a name="API_ProtectedJobResultConfigurationOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedJobResultConfigurationOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedJobResultConfigurationOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedJobResultConfigurationOutput) 

# ProtectedJobS3Output
<a name="API_ProtectedJobS3Output"></a>

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

## Contents
<a name="API_ProtectedJobS3Output_Contents"></a>

 ** location **   <a name="API-Type-ProtectedJobS3Output-location"></a>
 The S3 location for the protected job output.  
Type: String  
Required: Yes

## See Also
<a name="API_ProtectedJobS3Output_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedJobS3Output) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedJobS3Output) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedJobS3Output) 

# ProtectedJobS3OutputConfigurationInput
<a name="API_ProtectedJobS3OutputConfigurationInput"></a>

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

## Contents
<a name="API_ProtectedJobS3OutputConfigurationInput_Contents"></a>

 ** bucket **   <a name="API-Type-ProtectedJobS3OutputConfigurationInput-bucket"></a>
 The S3 bucket for job output.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `.*(?!^(\d+\.)+\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])\.)*([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])$).*`   
Required: Yes

 ** keyPrefix **   <a name="API-Type-ProtectedJobS3OutputConfigurationInput-keyPrefix"></a>
The S3 prefix to unload the protected job results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 512.  
Pattern: `[\w!.=*/-]*`   
Required: No

## See Also
<a name="API_ProtectedJobS3OutputConfigurationInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedJobS3OutputConfigurationInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedJobS3OutputConfigurationInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedJobS3OutputConfigurationInput) 

# ProtectedJobS3OutputConfigurationOutput
<a name="API_ProtectedJobS3OutputConfigurationOutput"></a>

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

## Contents
<a name="API_ProtectedJobS3OutputConfigurationOutput_Contents"></a>

 ** bucket **   <a name="API-Type-ProtectedJobS3OutputConfigurationOutput-bucket"></a>
 The S3 bucket for job output.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `.*(?!^(\d+\.)+\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])\.)*([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])$).*`   
Required: Yes

 ** keyPrefix **   <a name="API-Type-ProtectedJobS3OutputConfigurationOutput-keyPrefix"></a>
The S3 prefix to unload the protected job results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 512.  
Pattern: `[\w!.=*/-]*`   
Required: No

## See Also
<a name="API_ProtectedJobS3OutputConfigurationOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedJobS3OutputConfigurationOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedJobS3OutputConfigurationOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedJobS3OutputConfigurationOutput) 

# ProtectedJobSingleMemberOutput
<a name="API_ProtectedJobSingleMemberOutput"></a>

Details about the member who received the job result.

## Contents
<a name="API_ProtectedJobSingleMemberOutput_Contents"></a>

 ** accountId **   <a name="API-Type-ProtectedJobSingleMemberOutput-accountId"></a>
The AWS account ID of the member in the collaboration who can receive results from analyses.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: Yes

## See Also
<a name="API_ProtectedJobSingleMemberOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedJobSingleMemberOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedJobSingleMemberOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedJobSingleMemberOutput) 

# ProtectedJobStatistics
<a name="API_ProtectedJobStatistics"></a>

Contains statistics about the execution of the protected job.

## Contents
<a name="API_ProtectedJobStatistics_Contents"></a>

 ** billedResourceUtilization **   <a name="API-Type-ProtectedJobStatistics-billedResourceUtilization"></a>
 The billed resource utilization for the protected job.  
Type: [BilledJobResourceUtilization](API_BilledJobResourceUtilization.md) object  
Required: No

 ** totalDurationInMillis **   <a name="API-Type-ProtectedJobStatistics-totalDurationInMillis"></a>
The duration of the protected job, from creation until job completion, in milliseconds.  
Type: Long  
Required: No

## See Also
<a name="API_ProtectedJobStatistics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedJobStatistics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedJobStatistics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedJobStatistics) 

# ProtectedJobSummary
<a name="API_ProtectedJobSummary"></a>

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

## Contents
<a name="API_ProtectedJobSummary_Contents"></a>

 ** createTime **   <a name="API-Type-ProtectedJobSummary-createTime"></a>
The time the protected job was created.  
Type: Timestamp  
Required: Yes

 ** id **   <a name="API-Type-ProtectedJobSummary-id"></a>
 The ID of the protected job.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** membershipArn **   <a name="API-Type-ProtectedJobSummary-membershipArn"></a>
The unique ARN for the membership that initiated the protected job.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+`   
Required: Yes

 ** membershipId **   <a name="API-Type-ProtectedJobSummary-membershipId"></a>
The unique ID for the membership that initiated the protected job.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** receiverConfigurations **   <a name="API-Type-ProtectedJobSummary-receiverConfigurations"></a>
 The receiver configurations for the protected job.  
Type: Array of [ProtectedJobReceiverConfiguration](API_ProtectedJobReceiverConfiguration.md) objects  
Required: Yes

 ** status **   <a name="API-Type-ProtectedJobSummary-status"></a>
The status of the protected job.  
Type: String  
Valid Values: `SUBMITTED | STARTED | CANCELLED | CANCELLING | FAILED | SUCCESS`   
Required: Yes

## See Also
<a name="API_ProtectedJobSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedJobSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedJobSummary) 

# ProtectedJobWorkerComputeConfiguration
<a name="API_ProtectedJobWorkerComputeConfiguration"></a>

The configuration of the compute resources for a PySpark job.

## Contents
<a name="API_ProtectedJobWorkerComputeConfiguration_Contents"></a>

 ** number **   <a name="API-Type-ProtectedJobWorkerComputeConfiguration-number"></a>
The number of workers for a PySpark job.  
Type: Integer  
Valid Range: Minimum value of 4. Maximum value of 1024.  
Required: Yes

 ** type **   <a name="API-Type-ProtectedJobWorkerComputeConfiguration-type"></a>
The worker compute configuration type.  
Type: String  
Valid Values: `CR.1X | CR.4X`   
Required: Yes

 ** properties **   <a name="API-Type-ProtectedJobWorkerComputeConfiguration-properties"></a>
The configuration properties for the worker compute environment. These properties allow you to customize the compute settings for your AWS Clean Rooms workloads.  
Type: [WorkerComputeConfigurationProperties](API_WorkerComputeConfigurationProperties.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## See Also
<a name="API_ProtectedJobWorkerComputeConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedJobWorkerComputeConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedJobWorkerComputeConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedJobWorkerComputeConfiguration) 

# ProtectedQuery
<a name="API_ProtectedQuery"></a>

The parameters for an AWS Clean Rooms protected query.

## Contents
<a name="API_ProtectedQuery_Contents"></a>

 ** createTime **   <a name="API-Type-ProtectedQuery-createTime"></a>
The time at which the protected query was created.  
Type: Timestamp  
Required: Yes

 ** id **   <a name="API-Type-ProtectedQuery-id"></a>
The identifier for a protected query instance.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** membershipArn **   <a name="API-Type-ProtectedQuery-membershipArn"></a>
The ARN of the membership.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+`   
Required: Yes

 ** membershipId **   <a name="API-Type-ProtectedQuery-membershipId"></a>
The identifier for the membership.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** status **   <a name="API-Type-ProtectedQuery-status"></a>
The status of the query.  
Type: String  
Valid Values: `SUBMITTED | STARTED | CANCELLED | CANCELLING | FAILED | SUCCESS | TIMED_OUT`   
Required: Yes

 ** computeConfiguration **   <a name="API-Type-ProtectedQuery-computeConfiguration"></a>
 The compute configuration for the protected query.  
Type: [ComputeConfiguration](API_ComputeConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** differentialPrivacy **   <a name="API-Type-ProtectedQuery-differentialPrivacy"></a>
The sensitivity parameters of the differential privacy results of the protected query.  
Type: [DifferentialPrivacyParameters](API_DifferentialPrivacyParameters.md) object  
Required: No

 ** error **   <a name="API-Type-ProtectedQuery-error"></a>
An error thrown by the protected query.  
Type: [ProtectedQueryError](API_ProtectedQueryError.md) object  
Required: No

 ** result **   <a name="API-Type-ProtectedQuery-result"></a>
The result of the protected query.  
Type: [ProtectedQueryResult](API_ProtectedQueryResult.md) object  
Required: No

 ** resultConfiguration **   <a name="API-Type-ProtectedQuery-resultConfiguration"></a>
Contains any details needed to write the query results.  
Type: [ProtectedQueryResultConfiguration](API_ProtectedQueryResultConfiguration.md) object  
Required: No

 ** sqlParameters **   <a name="API-Type-ProtectedQuery-sqlParameters"></a>
The protected query SQL parameters.  
Type: [ProtectedQuerySQLParameters](API_ProtectedQuerySQLParameters.md) object  
Required: No

 ** statistics **   <a name="API-Type-ProtectedQuery-statistics"></a>
Statistics about protected query execution.  
Type: [ProtectedQueryStatistics](API_ProtectedQueryStatistics.md) object  
Required: No

## See Also
<a name="API_ProtectedQuery_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedQuery) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedQuery) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedQuery) 

# ProtectedQueryDistributeOutput
<a name="API_ProtectedQueryDistributeOutput"></a>

 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.

## Contents
<a name="API_ProtectedQueryDistributeOutput_Contents"></a>

 ** memberList **   <a name="API-Type-ProtectedQueryDistributeOutput-memberList"></a>
 Contains the output results for each member location specified in the distribute output configuration. Each entry provides details about the result distribution to a specific collaboration member.   
Type: Array of [ProtectedQuerySingleMemberOutput](API_ProtectedQuerySingleMemberOutput.md) objects  
Required: No

 ** s3 **   <a name="API-Type-ProtectedQueryDistributeOutput-s3"></a>
Contains output information for protected queries with an S3 output type.  
Type: [ProtectedQueryS3Output](API_ProtectedQueryS3Output.md) object  
Required: No

## See Also
<a name="API_ProtectedQueryDistributeOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedQueryDistributeOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedQueryDistributeOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedQueryDistributeOutput) 

# ProtectedQueryDistributeOutputConfiguration
<a name="API_ProtectedQueryDistributeOutputConfiguration"></a>

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

## Contents
<a name="API_ProtectedQueryDistributeOutputConfiguration_Contents"></a>

 ** locations **   <a name="API-Type-ProtectedQueryDistributeOutputConfiguration-locations"></a>
 A list of locations where you want to distribute the protected query results. Each location must specify either an S3 destination or a collaboration member destination.  
You can't specify more than one S3 location.  
You can't specify the query runner's account as a member location.  
You must include either an S3 or member output configuration for each location, but not both.
Type: Array of [ProtectedQueryDistributeOutputConfigurationLocation](API_ProtectedQueryDistributeOutputConfigurationLocation.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## See Also
<a name="API_ProtectedQueryDistributeOutputConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedQueryDistributeOutputConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedQueryDistributeOutputConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedQueryDistributeOutputConfiguration) 

# ProtectedQueryDistributeOutputConfigurationLocation
<a name="API_ProtectedQueryDistributeOutputConfigurationLocation"></a>

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

## Contents
<a name="API_ProtectedQueryDistributeOutputConfigurationLocation_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** member **   <a name="API-Type-ProtectedQueryDistributeOutputConfigurationLocation-member"></a>
 Contains configuration details for the protected query member output.  
Type: [ProtectedQueryMemberOutputConfiguration](API_ProtectedQueryMemberOutputConfiguration.md) object  
Required: No

 ** s3 **   <a name="API-Type-ProtectedQueryDistributeOutputConfigurationLocation-s3"></a>
Contains the configuration to write the query results to S3.  
Type: [ProtectedQueryS3OutputConfiguration](API_ProtectedQueryS3OutputConfiguration.md) object  
Required: No

## See Also
<a name="API_ProtectedQueryDistributeOutputConfigurationLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedQueryDistributeOutputConfigurationLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedQueryDistributeOutputConfigurationLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedQueryDistributeOutputConfigurationLocation) 

# ProtectedQueryError
<a name="API_ProtectedQueryError"></a>

Details of errors thrown by the protected query.

## Contents
<a name="API_ProtectedQueryError_Contents"></a>

 ** code **   <a name="API-Type-ProtectedQueryError-code"></a>
An error code for the error.  
Type: String  
Required: Yes

 ** message **   <a name="API-Type-ProtectedQueryError-message"></a>
A description of why the query failed.  
Type: String  
Required: Yes

## See Also
<a name="API_ProtectedQueryError_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedQueryError) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedQueryError) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedQueryError) 

# ProtectedQueryMemberOutputConfiguration
<a name="API_ProtectedQueryMemberOutputConfiguration"></a>

 Contains configuration details for the protected query member output.

## Contents
<a name="API_ProtectedQueryMemberOutputConfiguration_Contents"></a>

 ** accountId **   <a name="API-Type-ProtectedQueryMemberOutputConfiguration-accountId"></a>
The unique identifier for the account.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: Yes

## See Also
<a name="API_ProtectedQueryMemberOutputConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedQueryMemberOutputConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedQueryMemberOutputConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedQueryMemberOutputConfiguration) 

# ProtectedQueryOutput
<a name="API_ProtectedQueryOutput"></a>

Contains details about the protected query output.

## Contents
<a name="API_ProtectedQueryOutput_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** distribute **   <a name="API-Type-ProtectedQueryOutput-distribute"></a>
Contains output information for protected queries that use a `distribute` output type. This output type lets you send query results to multiple locations - either to S3 or to collaboration members.   
 You can only use the `distribute` output type with the Spark analytics engine. 
Type: [ProtectedQueryDistributeOutput](API_ProtectedQueryDistributeOutput.md) object  
Required: No

 ** memberList **   <a name="API-Type-ProtectedQueryOutput-memberList"></a>
The list of member AWS account(s) that received the results of the query.   
Type: Array of [ProtectedQuerySingleMemberOutput](API_ProtectedQuerySingleMemberOutput.md) objects  
Required: No

 ** s3 **   <a name="API-Type-ProtectedQueryOutput-s3"></a>
If present, the output for a protected query with an `S3` output type.  
Type: [ProtectedQueryS3Output](API_ProtectedQueryS3Output.md) object  
Required: No

## See Also
<a name="API_ProtectedQueryOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedQueryOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedQueryOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedQueryOutput) 

# ProtectedQueryOutputConfiguration
<a name="API_ProtectedQueryOutputConfiguration"></a>

Contains configuration details for protected query output.

## Contents
<a name="API_ProtectedQueryOutputConfiguration_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** distribute **   <a name="API-Type-ProtectedQueryOutputConfiguration-distribute"></a>
 Required configuration for a protected query with a `distribute` output type.  
Type: [ProtectedQueryDistributeOutputConfiguration](API_ProtectedQueryDistributeOutputConfiguration.md) object  
Required: No

 ** member **   <a name="API-Type-ProtectedQueryOutputConfiguration-member"></a>
 Required configuration for a protected query with a `member` output type.  
Type: [ProtectedQueryMemberOutputConfiguration](API_ProtectedQueryMemberOutputConfiguration.md) object  
Required: No

 ** s3 **   <a name="API-Type-ProtectedQueryOutputConfiguration-s3"></a>
Required configuration for a protected query with an `s3` output type.  
Type: [ProtectedQueryS3OutputConfiguration](API_ProtectedQueryS3OutputConfiguration.md) object  
Required: No

## See Also
<a name="API_ProtectedQueryOutputConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedQueryOutputConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedQueryOutputConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedQueryOutputConfiguration) 

# ProtectedQueryResult
<a name="API_ProtectedQueryResult"></a>

Details about the query results.

## Contents
<a name="API_ProtectedQueryResult_Contents"></a>

 ** output **   <a name="API-Type-ProtectedQueryResult-output"></a>
The output of the protected query.  
Type: [ProtectedQueryOutput](API_ProtectedQueryOutput.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## See Also
<a name="API_ProtectedQueryResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedQueryResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedQueryResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedQueryResult) 

# ProtectedQueryResultConfiguration
<a name="API_ProtectedQueryResultConfiguration"></a>

Contains configurations for protected query results.

## Contents
<a name="API_ProtectedQueryResultConfiguration_Contents"></a>

 ** outputConfiguration **   <a name="API-Type-ProtectedQueryResultConfiguration-outputConfiguration"></a>
Configuration for protected query results.  
Type: [ProtectedQueryOutputConfiguration](API_ProtectedQueryOutputConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## See Also
<a name="API_ProtectedQueryResultConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedQueryResultConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedQueryResultConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedQueryResultConfiguration) 

# ProtectedQueryS3Output
<a name="API_ProtectedQueryS3Output"></a>

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

## Contents
<a name="API_ProtectedQueryS3Output_Contents"></a>

 ** location **   <a name="API-Type-ProtectedQueryS3Output-location"></a>
The S3 location of the result.  
Type: String  
Required: Yes

## See Also
<a name="API_ProtectedQueryS3Output_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedQueryS3Output) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedQueryS3Output) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedQueryS3Output) 

# ProtectedQueryS3OutputConfiguration
<a name="API_ProtectedQueryS3OutputConfiguration"></a>

Contains the configuration to write the query results to S3.

## Contents
<a name="API_ProtectedQueryS3OutputConfiguration_Contents"></a>

 ** bucket **   <a name="API-Type-ProtectedQueryS3OutputConfiguration-bucket"></a>
The S3 bucket to unload the protected query results.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `.*(?!^(\d+\.)+\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])\.)*([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])$).*`   
Required: Yes

 ** resultFormat **   <a name="API-Type-ProtectedQueryS3OutputConfiguration-resultFormat"></a>
Intended file format of the result.  
Type: String  
Valid Values: `CSV | PARQUET`   
Required: Yes

 ** keyPrefix **   <a name="API-Type-ProtectedQueryS3OutputConfiguration-keyPrefix"></a>
The S3 prefix to unload the protected query results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 512.  
Pattern: `[\w!.=*/-]*`   
Required: No

 ** singleFileOutput **   <a name="API-Type-ProtectedQueryS3OutputConfiguration-singleFileOutput"></a>
Indicates whether files should be output as a single file (`TRUE`) or output as multiple files (`FALSE`). This parameter is only supported for analyses with the Spark analytics engine.  
Type: Boolean  
Required: No

## See Also
<a name="API_ProtectedQueryS3OutputConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedQueryS3OutputConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedQueryS3OutputConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedQueryS3OutputConfiguration) 

# ProtectedQuerySingleMemberOutput
<a name="API_ProtectedQuerySingleMemberOutput"></a>

Details about the member who received the query result.

## Contents
<a name="API_ProtectedQuerySingleMemberOutput_Contents"></a>

 ** accountId **   <a name="API-Type-ProtectedQuerySingleMemberOutput-accountId"></a>
The AWS account ID of the member in the collaboration who can receive results for the query.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: Yes

## See Also
<a name="API_ProtectedQuerySingleMemberOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedQuerySingleMemberOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedQuerySingleMemberOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedQuerySingleMemberOutput) 

# ProtectedQuerySQLParameters
<a name="API_ProtectedQuerySQLParameters"></a>

The parameters for the SQL type Protected Query.

## Contents
<a name="API_ProtectedQuerySQLParameters_Contents"></a>

 ** analysisTemplateArn **   <a name="API-Type-ProtectedQuerySQLParameters-analysisTemplateArn"></a>
The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Pattern: `arn:aws[-a-z]*:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/analysistemplate/[\d\w-]+`   
Required: No

 ** parameters **   <a name="API-Type-ProtectedQuerySQLParameters-parameters"></a>
The protected query SQL parameters.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 100.  
Key Pattern: `[0-9a-zA-Z_]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 1000.  
Required: No

 ** queryString **   <a name="API-Type-ProtectedQuerySQLParameters-queryString"></a>
The query string to be submitted.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500000.  
Required: No

## See Also
<a name="API_ProtectedQuerySQLParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedQuerySQLParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedQuerySQLParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedQuerySQLParameters) 

# ProtectedQueryStatistics
<a name="API_ProtectedQueryStatistics"></a>

Contains statistics about the execution of the protected query.

## Contents
<a name="API_ProtectedQueryStatistics_Contents"></a>

 ** billedResourceUtilization **   <a name="API-Type-ProtectedQueryStatistics-billedResourceUtilization"></a>
 The billed resource utilization.  
Type: [BilledResourceUtilization](API_BilledResourceUtilization.md) object  
Required: No

 ** totalDurationInMillis **   <a name="API-Type-ProtectedQueryStatistics-totalDurationInMillis"></a>
The duration of the protected query, from creation until query completion, in milliseconds.  
Type: Long  
Required: No

## See Also
<a name="API_ProtectedQueryStatistics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedQueryStatistics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedQueryStatistics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedQueryStatistics) 

# ProtectedQuerySummary
<a name="API_ProtectedQuerySummary"></a>

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

## Contents
<a name="API_ProtectedQuerySummary_Contents"></a>

 ** createTime **   <a name="API-Type-ProtectedQuerySummary-createTime"></a>
The time the protected query was created.  
Type: Timestamp  
Required: Yes

 ** id **   <a name="API-Type-ProtectedQuerySummary-id"></a>
The unique ID of the protected query.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** membershipArn **   <a name="API-Type-ProtectedQuerySummary-membershipArn"></a>
The unique ARN for the membership that initiated the protected query.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+`   
Required: Yes

 ** membershipId **   <a name="API-Type-ProtectedQuerySummary-membershipId"></a>
The unique ID for the membership that initiated the protected query.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** receiverConfigurations **   <a name="API-Type-ProtectedQuerySummary-receiverConfigurations"></a>
 The receiver configuration.  
Type: Array of [ReceiverConfiguration](API_ReceiverConfiguration.md) objects  
Required: Yes

 ** status **   <a name="API-Type-ProtectedQuerySummary-status"></a>
The status of the protected query.  
Type: String  
Valid Values: `SUBMITTED | STARTED | CANCELLED | CANCELLING | FAILED | SUCCESS | TIMED_OUT`   
Required: Yes

## See Also
<a name="API_ProtectedQuerySummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ProtectedQuerySummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ProtectedQuerySummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ProtectedQuerySummary) 

# QueryComputePaymentConfig
<a name="API_QueryComputePaymentConfig"></a>

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

## Contents
<a name="API_QueryComputePaymentConfig_Contents"></a>

 ** isResponsible **   <a name="API-Type-QueryComputePaymentConfig-isResponsible"></a>
Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs (`TRUE`) or has not configured the collaboration member to pay for query compute costs (`FALSE`).  
Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a `TRUE` value for more than one member in the collaboration.   
If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a `FALSE` value for the member who can query.  
Type: Boolean  
Required: Yes

## See Also
<a name="API_QueryComputePaymentConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/QueryComputePaymentConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/QueryComputePaymentConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/QueryComputePaymentConfig) 

# QueryConstraint
<a name="API_QueryConstraint"></a>

Provides any necessary query constraint information.

## Contents
<a name="API_QueryConstraint_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** requireOverlap **   <a name="API-Type-QueryConstraint-requireOverlap"></a>
An array of column names that specifies which columns are required in the JOIN statement.  
Type: [QueryConstraintRequireOverlap](API_QueryConstraintRequireOverlap.md) object  
Required: No

## See Also
<a name="API_QueryConstraint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/QueryConstraint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/QueryConstraint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/QueryConstraint) 

# QueryConstraintRequireOverlap
<a name="API_QueryConstraintRequireOverlap"></a>

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

## Contents
<a name="API_QueryConstraintRequireOverlap_Contents"></a>

 ** columns **   <a name="API-Type-QueryConstraintRequireOverlap-columns"></a>
The columns that are required to overlap.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?`   
Required: No

## See Also
<a name="API_QueryConstraintRequireOverlap_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/QueryConstraintRequireOverlap) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/QueryConstraintRequireOverlap) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/QueryConstraintRequireOverlap) 

# ReceiverConfiguration
<a name="API_ReceiverConfiguration"></a>

 The receiver configuration for a protected query.

## Contents
<a name="API_ReceiverConfiguration_Contents"></a>

 ** analysisType **   <a name="API-Type-ReceiverConfiguration-analysisType"></a>
 The type of analysis for the protected query. The results of the query can be analyzed directly (`DIRECT_ANALYSIS`) or used as input into additional analyses (`ADDITIONAL_ANALYSIS`), such as a query that is a seed for a lookalike ML model.  
Type: String  
Valid Values: `DIRECT_ANALYSIS | ADDITIONAL_ANALYSIS`   
Required: Yes

 ** configurationDetails **   <a name="API-Type-ReceiverConfiguration-configurationDetails"></a>
 The configuration details of the receiver configuration.  
Type: [ConfigurationDetails](API_ConfigurationDetails.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## See Also
<a name="API_ReceiverConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ReceiverConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ReceiverConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ReceiverConfiguration) 

# S3Location
<a name="API_S3Location"></a>

The S3 location.

## Contents
<a name="API_S3Location_Contents"></a>

 ** bucket **   <a name="API-Type-S3Location-bucket"></a>
 The bucket name.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `.*(?!^(\d+\.)+\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])\.)*([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])$).*`   
Required: Yes

 ** key **   <a name="API-Type-S3Location-key"></a>
 The object key.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `[a-zA-Z0-9!_.*'()-/]+`   
Required: Yes

## See Also
<a name="API_S3Location_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/S3Location) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/S3Location) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/S3Location) 

# Schema
<a name="API_Schema"></a>

A schema is a relation within a collaboration.

## Contents
<a name="API_Schema_Contents"></a>

 ** analysisRuleTypes **   <a name="API-Type-Schema-analysisRuleTypes"></a>
The analysis rule types that are associated with the schema. Currently, only one entry is present.  
Type: Array of strings  
Valid Values: `AGGREGATION | LIST | CUSTOM | ID_MAPPING_TABLE`   
Required: Yes

 ** collaborationArn **   <a name="API-Type-Schema-collaborationArn"></a>
The unique Amazon Resource Name (ARN) for the collaboration that the schema belongs to.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** collaborationId **   <a name="API-Type-Schema-collaborationId"></a>
The unique ID for the collaboration that the schema belongs to.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** columns **   <a name="API-Type-Schema-columns"></a>
The columns for the relation that this schema represents.  
Type: Array of [Column](API_Column.md) objects  
Required: Yes

 ** createTime **   <a name="API-Type-Schema-createTime"></a>
The time at which the schema was created.  
Type: Timestamp  
Required: Yes

 ** creatorAccountId **   <a name="API-Type-Schema-creatorAccountId"></a>
The unique account ID for the AWS account that owns the schema.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: Yes

 ** description **   <a name="API-Type-Schema-description"></a>
A description for the schema.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*`   
Required: Yes

 ** name **   <a name="API-Type-Schema-name"></a>
A name for the schema. The schema relation is referred to by this name when queried by a protected query.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?`   
Required: Yes

 ** partitionKeys **   <a name="API-Type-Schema-partitionKeys"></a>
The partition keys for the dataset underlying this schema.  
Type: Array of [Column](API_Column.md) objects  
Required: Yes

 ** schemaStatusDetails **   <a name="API-Type-Schema-schemaStatusDetails"></a>
Details about the status of the schema. Currently, only one entry is present.  
Type: Array of [SchemaStatusDetail](API_SchemaStatusDetail.md) objects  
Required: Yes

 ** type **   <a name="API-Type-Schema-type"></a>
The type of schema.  
Type: String  
Valid Values: `TABLE | ID_MAPPING_TABLE`   
Required: Yes

 ** updateTime **   <a name="API-Type-Schema-updateTime"></a>
The most recent time at which the schema was updated.  
Type: Timestamp  
Required: Yes

 ** analysisMethod **   <a name="API-Type-Schema-analysisMethod"></a>
The analysis method for the schema.   
 `DIRECT_QUERY` allows SQL queries to be run directly on this table.  
 `DIRECT_JOB` allows PySpark jobs to be run directly on this table.  
 `MULTIPLE` allows both SQL queries and PySpark jobs to be run directly on this table.  
Type: String  
Valid Values: `DIRECT_QUERY | DIRECT_JOB | MULTIPLE`   
Required: No

 ** resourceArn **   <a name="API-Type-Schema-resourceArn"></a>
The Amazon Resource Name (ARN) of the schema resource.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Pattern: `arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership\/[\d\w-]+\/(configuredtableassociation|idmappingtable)\/[\d\w-]+`   
Required: No

 ** schemaTypeProperties **   <a name="API-Type-Schema-schemaTypeProperties"></a>
The schema type properties.  
Type: [SchemaTypeProperties](API_SchemaTypeProperties.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** selectedAnalysisMethods **   <a name="API-Type-Schema-selectedAnalysisMethods"></a>
 The selected analysis methods for the schema.  
Type: Array of strings  
Valid Values: `DIRECT_QUERY | DIRECT_JOB`   
Required: No

## See Also
<a name="API_Schema_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/Schema) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/Schema) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/Schema) 

# SchemaAnalysisRuleRequest
<a name="API_SchemaAnalysisRuleRequest"></a>

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.

## Contents
<a name="API_SchemaAnalysisRuleRequest_Contents"></a>

 ** name **   <a name="API-Type-SchemaAnalysisRuleRequest-name"></a>
The name of the analysis rule schema that you are requesting.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?`   
Required: Yes

 ** type **   <a name="API-Type-SchemaAnalysisRuleRequest-type"></a>
The type of analysis rule schema that you are requesting.  
Type: String  
Valid Values: `AGGREGATION | LIST | CUSTOM | ID_MAPPING_TABLE`   
Required: Yes

## See Also
<a name="API_SchemaAnalysisRuleRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/SchemaAnalysisRuleRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/SchemaAnalysisRuleRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/SchemaAnalysisRuleRequest) 

# SchemaStatusDetail
<a name="API_SchemaStatusDetail"></a>

Information about the schema status.

A status of `READY` means that based on the schema analysis rule, queries of the given analysis rule type are properly configured to run queries on this schema.

## Contents
<a name="API_SchemaStatusDetail_Contents"></a>

 ** analysisType **   <a name="API-Type-SchemaStatusDetail-analysisType"></a>
The type of analysis that can be performed on the schema.  
A schema can have an `analysisType` of `DIRECT_ANALYSIS`, `ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION`, or both.  
Type: String  
Valid Values: `DIRECT_ANALYSIS | ADDITIONAL_ANALYSIS`   
Required: Yes

 ** status **   <a name="API-Type-SchemaStatusDetail-status"></a>
The status of the schema, indicating if it is ready to query.  
Type: String  
Valid Values: `READY | NOT_READY`   
Required: Yes

 ** analysisRuleType **   <a name="API-Type-SchemaStatusDetail-analysisRuleType"></a>
The analysis rule type for which the schema status has been evaluated.  
Type: String  
Valid Values: `AGGREGATION | LIST | CUSTOM | ID_MAPPING_TABLE`   
Required: No

 ** configurations **   <a name="API-Type-SchemaStatusDetail-configurations"></a>
The configuration details of the schema analysis rule for the given type.  
Type: Array of strings  
Valid Values: `DIFFERENTIAL_PRIVACY`   
Required: No

 ** reasons **   <a name="API-Type-SchemaStatusDetail-reasons"></a>
The reasons why the schema status is set to its current state.  
Type: Array of [SchemaStatusReason](API_SchemaStatusReason.md) objects  
Required: No

## See Also
<a name="API_SchemaStatusDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/SchemaStatusDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/SchemaStatusDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/SchemaStatusDetail) 

# SchemaStatusReason
<a name="API_SchemaStatusReason"></a>

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

## Contents
<a name="API_SchemaStatusReason_Contents"></a>

 ** code **   <a name="API-Type-SchemaStatusReason-code"></a>
The schema status reason code.  
Type: String  
Valid Values: `ANALYSIS_RULE_MISSING | ANALYSIS_TEMPLATES_NOT_CONFIGURED | ANALYSIS_PROVIDERS_NOT_CONFIGURED | DIFFERENTIAL_PRIVACY_POLICY_NOT_CONFIGURED | ID_MAPPING_TABLE_NOT_POPULATED | COLLABORATION_ANALYSIS_RULE_NOT_CONFIGURED | ADDITIONAL_ANALYSES_NOT_CONFIGURED | RESULT_RECEIVERS_NOT_CONFIGURED | ADDITIONAL_ANALYSES_NOT_ALLOWED | RESULT_RECEIVERS_NOT_ALLOWED | ANALYSIS_RULE_TYPES_NOT_COMPATIBLE`   
Required: Yes

 ** message **   <a name="API-Type-SchemaStatusReason-message"></a>
An explanation of the schema status reason code.  
Type: String  
Required: Yes

## See Also
<a name="API_SchemaStatusReason_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/SchemaStatusReason) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/SchemaStatusReason) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/SchemaStatusReason) 

# SchemaSummary
<a name="API_SchemaSummary"></a>

The schema summary for the objects listed by the request.

## Contents
<a name="API_SchemaSummary_Contents"></a>

 ** analysisRuleTypes **   <a name="API-Type-SchemaSummary-analysisRuleTypes"></a>
The types of analysis rules that are associated with this schema object.  
Type: Array of strings  
Valid Values: `AGGREGATION | LIST | CUSTOM | ID_MAPPING_TABLE`   
Required: Yes

 ** collaborationArn **   <a name="API-Type-SchemaSummary-collaborationArn"></a>
The unique ARN for the collaboration that the schema belongs to.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** collaborationId **   <a name="API-Type-SchemaSummary-collaborationId"></a>
The unique ID for the collaboration that the schema belongs to.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** createTime **   <a name="API-Type-SchemaSummary-createTime"></a>
The time the schema object was created.  
Type: Timestamp  
Required: Yes

 ** creatorAccountId **   <a name="API-Type-SchemaSummary-creatorAccountId"></a>
The unique account ID for the AWS account that owns the schema.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: Yes

 ** name **   <a name="API-Type-SchemaSummary-name"></a>
The name for the schema object.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?`   
Required: Yes

 ** type **   <a name="API-Type-SchemaSummary-type"></a>
The type of schema object.  
Type: String  
Valid Values: `TABLE | ID_MAPPING_TABLE`   
Required: Yes

 ** updateTime **   <a name="API-Type-SchemaSummary-updateTime"></a>
The time the schema object was last updated.  
Type: Timestamp  
Required: Yes

 ** analysisMethod **   <a name="API-Type-SchemaSummary-analysisMethod"></a>
The analysis method for the associated schema.  
 `DIRECT_QUERY` allows SQL queries to be run directly on this table.  
 `DIRECT_JOB` allows PySpark jobs to be run directly on this table.  
 `MULTIPLE` allows both SQL queries and PySpark jobs to be run directly on this table.  
Type: String  
Valid Values: `DIRECT_QUERY | DIRECT_JOB | MULTIPLE`   
Required: No

 ** resourceArn **   <a name="API-Type-SchemaSummary-resourceArn"></a>
The Amazon Resource Name (ARN) of the schema summary resource.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Pattern: `arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership\/[\d\w-]+\/(configuredtableassociation|idmappingtable)\/[\d\w-]+`   
Required: No

 ** selectedAnalysisMethods **   <a name="API-Type-SchemaSummary-selectedAnalysisMethods"></a>
 The selected analysis methods for the schema.  
Type: Array of strings  
Valid Values: `DIRECT_QUERY | DIRECT_JOB`   
Required: No

## See Also
<a name="API_SchemaSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/SchemaSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/SchemaSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/SchemaSummary) 

# SchemaTypeProperties
<a name="API_SchemaTypeProperties"></a>

Information about the schema type properties.

## Contents
<a name="API_SchemaTypeProperties_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** idMappingTable **   <a name="API-Type-SchemaTypeProperties-idMappingTable"></a>
The ID mapping table for the schema type properties.  
Type: [IdMappingTableSchemaTypeProperties](API_IdMappingTableSchemaTypeProperties.md) object  
Required: No

## See Also
<a name="API_SchemaTypeProperties_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/SchemaTypeProperties) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/SchemaTypeProperties) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/SchemaTypeProperties) 

# SnowflakeTableReference
<a name="API_SnowflakeTableReference"></a>

 A reference to a table within Snowflake.

## Contents
<a name="API_SnowflakeTableReference_Contents"></a>

 ** accountIdentifier **   <a name="API-Type-SnowflakeTableReference-accountIdentifier"></a>
 The account identifier for the Snowflake table reference.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 256.  
Pattern: `[\p{L}\p{M}\p{N}\p{Pc}\p{Pd}\p{Zs}.]+`   
Required: Yes

 ** databaseName **   <a name="API-Type-SnowflakeTableReference-databaseName"></a>
 The name of the database the Snowflake table belongs to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}\p{M}\p{N}\p{Pc}\p{Pd}\p{Zs}]+`   
Required: Yes

 ** schemaName **   <a name="API-Type-SnowflakeTableReference-schemaName"></a>
 The schema name of the Snowflake table reference.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}\p{M}\p{N}\p{Pc}\p{Pd}\p{Zs}]+`   
Required: Yes

 ** secretArn **   <a name="API-Type-SnowflakeTableReference-secretArn"></a>
 The secret ARN of the Snowflake table reference.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `arn:aws:secretsmanager:[a-z]{2}-[a-z]+-[0-9]:\d{12}:secret:.*`   
Required: Yes

 ** tableName **   <a name="API-Type-SnowflakeTableReference-tableName"></a>
 The name of the Snowflake table.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}\p{M}\p{N}\p{Pc}\p{Pd}\p{Zs}]+`   
Required: Yes

 ** tableSchema **   <a name="API-Type-SnowflakeTableReference-tableSchema"></a>
 The schema of the Snowflake table.  
Type: [SnowflakeTableSchema](API_SnowflakeTableSchema.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## See Also
<a name="API_SnowflakeTableReference_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/SnowflakeTableReference) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/SnowflakeTableReference) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/SnowflakeTableReference) 

# SnowflakeTableSchema
<a name="API_SnowflakeTableSchema"></a>

 The schema of a Snowflake table.

## Contents
<a name="API_SnowflakeTableSchema_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** v1 **   <a name="API-Type-SnowflakeTableSchema-v1"></a>
 The schema of a Snowflake table.  
Type: Array of [SnowflakeTableSchemaV1](API_SnowflakeTableSchemaV1.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 250 items.  
Required: No

## See Also
<a name="API_SnowflakeTableSchema_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/SnowflakeTableSchema) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/SnowflakeTableSchema) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/SnowflakeTableSchema) 

# SnowflakeTableSchemaV1
<a name="API_SnowflakeTableSchemaV1"></a>

 The Snowflake table schema.

## Contents
<a name="API_SnowflakeTableSchemaV1_Contents"></a>

 ** columnName **   <a name="API-Type-SnowflakeTableSchemaV1-columnName"></a>
 The column name.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?`   
Required: Yes

 ** columnType **   <a name="API-Type-SnowflakeTableSchemaV1-columnType"></a>
 The column's data type. Supported data types: `ARRAY`, `BIGINT`, `BOOLEAN`, `CHAR`, `DATE`, `DECIMAL`, `DOUBLE`, `DOUBLE PRECISION`, `FLOAT`, `FLOAT4`, `INT`, `INTEGER`, `MAP`, `NUMERIC`, `NUMBER`, `REAL`, `SMALLINT`, `STRING`, `TIMESTAMP`, `TIMESTAMP_LTZ`, `TIMESTAMP_NTZ`, `DATETIME`, `TINYINT`, `VARCHAR`, `TEXT`, `CHARACTER`.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*`   
Required: Yes

## See Also
<a name="API_SnowflakeTableSchemaV1_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/SnowflakeTableSchemaV1) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/SnowflakeTableSchemaV1) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/SnowflakeTableSchemaV1) 

# SyntheticDataColumnProperties
<a name="API_SyntheticDataColumnProperties"></a>

Properties that define how a specific data column should be handled during synthetic data generation, including its name, type, and role in predictive modeling.

## Contents
<a name="API_SyntheticDataColumnProperties_Contents"></a>

 ** columnName **   <a name="API-Type-SyntheticDataColumnProperties-columnName"></a>
The name of the data column as it appears in the dataset.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-z0-9_](([a-z0-9_]+-)*([a-z0-9_]+))?`   
Required: Yes

 ** columnType **   <a name="API-Type-SyntheticDataColumnProperties-columnType"></a>
The data type of the column, which determines how the synthetic data generation algorithm processes and synthesizes values for this column.  
Type: String  
Valid Values: `CATEGORICAL | NUMERICAL`   
Required: Yes

 ** isPredictiveValue **   <a name="API-Type-SyntheticDataColumnProperties-isPredictiveValue"></a>
Indicates if this column contains predictive values that should be treated as target variables in machine learning models. This affects how the synthetic data generation preserves statistical relationships.  
Type: Boolean  
Required: Yes

## See Also
<a name="API_SyntheticDataColumnProperties_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/SyntheticDataColumnProperties) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/SyntheticDataColumnProperties) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/SyntheticDataColumnProperties) 

# SyntheticDataGenerationPaymentConfig
<a name="API_SyntheticDataGenerationPaymentConfig"></a>

Payment configuration for synthetic data generation.

## Contents
<a name="API_SyntheticDataGenerationPaymentConfig_Contents"></a>

 ** isResponsible **   <a name="API-Type-SyntheticDataGenerationPaymentConfig-isResponsible"></a>
Indicates who is responsible for paying for synthetic data generation.  
Type: Boolean  
Required: Yes

## See Also
<a name="API_SyntheticDataGenerationPaymentConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/SyntheticDataGenerationPaymentConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/SyntheticDataGenerationPaymentConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/SyntheticDataGenerationPaymentConfig) 

# SyntheticDataParameters
<a name="API_SyntheticDataParameters"></a>

The parameters that control how synthetic data is generated, including privacy settings, column classifications, and other configuration options that affect the data synthesis process.

## Contents
<a name="API_SyntheticDataParameters_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** mlSyntheticDataParameters **   <a name="API-Type-SyntheticDataParameters-mlSyntheticDataParameters"></a>
The machine learning-specific parameters for synthetic data generation.  
Type: [MLSyntheticDataParameters](API_MLSyntheticDataParameters.md) object  
Required: No

## See Also
<a name="API_SyntheticDataParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/SyntheticDataParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/SyntheticDataParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/SyntheticDataParameters) 

# TableReference
<a name="API_TableReference"></a>

A pointer to the dataset that underlies this table.

## Contents
<a name="API_TableReference_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** athena **   <a name="API-Type-TableReference-athena"></a>
 If present, a reference to the Athena table referred to by this table reference.  
Type: [AthenaTableReference](API_AthenaTableReference.md) object  
Required: No

 ** glue **   <a name="API-Type-TableReference-glue"></a>
If present, a reference to the AWS Glue table referred to by this table reference.  
Type: [GlueTableReference](API_GlueTableReference.md) object  
Required: No

 ** snowflake **   <a name="API-Type-TableReference-snowflake"></a>
 If present, a reference to the Snowflake table referred to by this table reference.  
Type: [SnowflakeTableReference](API_SnowflakeTableReference.md) object  
Required: No

## See Also
<a name="API_TableReference_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/TableReference) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/TableReference) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/TableReference) 

# ValidationExceptionField
<a name="API_ValidationExceptionField"></a>

Describes validation errors for specific input parameters.

## Contents
<a name="API_ValidationExceptionField_Contents"></a>

 ** message **   <a name="API-Type-ValidationExceptionField-message"></a>
A message for the input validation error.  
Type: String  
Required: Yes

 ** name **   <a name="API-Type-ValidationExceptionField-name"></a>
The name of the input parameter.  
Type: String  
Required: Yes

## See Also
<a name="API_ValidationExceptionField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/ValidationExceptionField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/ValidationExceptionField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/ValidationExceptionField) 

# WorkerComputeConfiguration
<a name="API_WorkerComputeConfiguration"></a>

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

## Contents
<a name="API_WorkerComputeConfiguration_Contents"></a>

 ** number **   <a name="API-Type-WorkerComputeConfiguration-number"></a>
 The number of workers.  
SQL queries support a minimum value of 2 and a maximum value of 400.   
PySpark jobs support a minimum value of 4 and a maximum value of 128.  
Type: Integer  
Valid Range: Minimum value of 2. Maximum value of 400.  
Required: No

 ** properties **   <a name="API-Type-WorkerComputeConfiguration-properties"></a>
The configuration properties for the worker compute environment. These properties allow you to customize the compute settings for your AWS Clean Rooms workloads.  
Type: [WorkerComputeConfigurationProperties](API_WorkerComputeConfigurationProperties.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** type **   <a name="API-Type-WorkerComputeConfiguration-type"></a>
 The worker compute configuration type.  
Type: String  
Valid Values: `CR.1X | CR.4X`   
Required: No

## See Also
<a name="API_WorkerComputeConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/WorkerComputeConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/WorkerComputeConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/WorkerComputeConfiguration) 

# WorkerComputeConfigurationProperties
<a name="API_WorkerComputeConfigurationProperties"></a>

The configuration properties that define the compute environment settings for workers in AWS Clean Rooms. These properties enable customization of the underlying compute environment to optimize performance for your specific workloads.

## Contents
<a name="API_WorkerComputeConfigurationProperties_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** spark **   <a name="API-Type-WorkerComputeConfigurationProperties-spark"></a>
The Spark configuration properties for SQL and PySpark workloads. This map contains key-value pairs that configure Apache Spark settings to optimize performance for your data processing jobs. You can specify up to 50 Spark properties, with each key being 1-200 characters and each value being 0-500 characters. These properties allow you to adjust compute capacity for large datasets and complex workloads.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 200.  
Value Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

## See Also
<a name="API_WorkerComputeConfigurationProperties_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/WorkerComputeConfigurationProperties) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/WorkerComputeConfigurationProperties) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/WorkerComputeConfigurationProperties)