Module: Aws::CleanRooms::Types

Defined in:
lib/aws-sdk-cleanrooms/types.rb

Defined Under Namespace

Classes: AccessDeniedException, AggregateColumn, AggregationConstraint, AnalysisParameter, AnalysisRule, AnalysisRuleAggregation, AnalysisRuleCustom, AnalysisRuleIdMappingTable, AnalysisRuleList, AnalysisRulePolicy, AnalysisRulePolicyV1, AnalysisSchema, AnalysisSource, AnalysisTemplate, AnalysisTemplateSummary, AnalysisTemplateValidationStatusDetail, AnalysisTemplateValidationStatusReason, BatchGetCollaborationAnalysisTemplateError, BatchGetCollaborationAnalysisTemplateInput, BatchGetCollaborationAnalysisTemplateOutput, BatchGetSchemaAnalysisRuleError, BatchGetSchemaAnalysisRuleInput, BatchGetSchemaAnalysisRuleOutput, BatchGetSchemaError, BatchGetSchemaInput, BatchGetSchemaOutput, BilledResourceUtilization, Collaboration, CollaborationAnalysisTemplate, CollaborationAnalysisTemplateSummary, CollaborationConfiguredAudienceModelAssociation, CollaborationConfiguredAudienceModelAssociationSummary, CollaborationIdNamespaceAssociation, CollaborationIdNamespaceAssociationSummary, CollaborationPrivacyBudgetSummary, CollaborationPrivacyBudgetTemplate, CollaborationPrivacyBudgetTemplateSummary, CollaborationSummary, Column, ComputeConfiguration, ConfigurationDetails, ConfiguredAudienceModelAssociation, ConfiguredAudienceModelAssociationSummary, ConfiguredTable, ConfiguredTableAnalysisRule, ConfiguredTableAnalysisRulePolicy, ConfiguredTableAnalysisRulePolicyV1, ConfiguredTableAssociation, ConfiguredTableAssociationAnalysisRule, ConfiguredTableAssociationAnalysisRuleAggregation, ConfiguredTableAssociationAnalysisRuleCustom, ConfiguredTableAssociationAnalysisRuleList, ConfiguredTableAssociationAnalysisRulePolicy, ConfiguredTableAssociationAnalysisRulePolicyV1, ConfiguredTableAssociationSummary, ConfiguredTableSummary, ConflictException, CreateAnalysisTemplateInput, CreateAnalysisTemplateOutput, CreateCollaborationInput, CreateCollaborationOutput, CreateConfiguredAudienceModelAssociationInput, CreateConfiguredAudienceModelAssociationOutput, CreateConfiguredTableAnalysisRuleInput, CreateConfiguredTableAnalysisRuleOutput, CreateConfiguredTableAssociationAnalysisRuleInput, CreateConfiguredTableAssociationAnalysisRuleOutput, CreateConfiguredTableAssociationInput, CreateConfiguredTableAssociationOutput, CreateConfiguredTableInput, CreateConfiguredTableOutput, CreateIdMappingTableInput, CreateIdMappingTableOutput, CreateIdNamespaceAssociationInput, CreateIdNamespaceAssociationOutput, CreateMembershipInput, CreateMembershipOutput, CreatePrivacyBudgetTemplateInput, CreatePrivacyBudgetTemplateOutput, DataEncryptionMetadata, DeleteAnalysisTemplateInput, DeleteAnalysisTemplateOutput, DeleteCollaborationInput, DeleteCollaborationOutput, DeleteConfiguredAudienceModelAssociationInput, DeleteConfiguredAudienceModelAssociationOutput, DeleteConfiguredTableAnalysisRuleInput, DeleteConfiguredTableAnalysisRuleOutput, DeleteConfiguredTableAssociationAnalysisRuleInput, DeleteConfiguredTableAssociationAnalysisRuleOutput, DeleteConfiguredTableAssociationInput, DeleteConfiguredTableAssociationOutput, DeleteConfiguredTableInput, DeleteConfiguredTableOutput, DeleteIdMappingTableInput, DeleteIdMappingTableOutput, DeleteIdNamespaceAssociationInput, DeleteIdNamespaceAssociationOutput, DeleteMemberInput, DeleteMemberOutput, DeleteMembershipInput, DeleteMembershipOutput, DeletePrivacyBudgetTemplateInput, DeletePrivacyBudgetTemplateOutput, DifferentialPrivacyColumn, DifferentialPrivacyConfiguration, DifferentialPrivacyParameters, DifferentialPrivacyPreviewAggregation, DifferentialPrivacyPreviewParametersInput, DifferentialPrivacyPrivacyBudget, DifferentialPrivacyPrivacyBudgetAggregation, DifferentialPrivacyPrivacyImpact, DifferentialPrivacySensitivityParameters, DifferentialPrivacyTemplateParametersInput, DifferentialPrivacyTemplateParametersOutput, DifferentialPrivacyTemplateUpdateParameters, DirectAnalysisConfigurationDetails, GetAnalysisTemplateInput, GetAnalysisTemplateOutput, GetCollaborationAnalysisTemplateInput, GetCollaborationAnalysisTemplateOutput, GetCollaborationConfiguredAudienceModelAssociationInput, GetCollaborationConfiguredAudienceModelAssociationOutput, GetCollaborationIdNamespaceAssociationInput, GetCollaborationIdNamespaceAssociationOutput, GetCollaborationInput, GetCollaborationOutput, GetCollaborationPrivacyBudgetTemplateInput, GetCollaborationPrivacyBudgetTemplateOutput, GetConfiguredAudienceModelAssociationInput, GetConfiguredAudienceModelAssociationOutput, GetConfiguredTableAnalysisRuleInput, GetConfiguredTableAnalysisRuleOutput, GetConfiguredTableAssociationAnalysisRuleInput, GetConfiguredTableAssociationAnalysisRuleOutput, GetConfiguredTableAssociationInput, GetConfiguredTableAssociationOutput, GetConfiguredTableInput, GetConfiguredTableOutput, GetIdMappingTableInput, GetIdMappingTableOutput, GetIdNamespaceAssociationInput, GetIdNamespaceAssociationOutput, GetMembershipInput, GetMembershipOutput, GetPrivacyBudgetTemplateInput, GetPrivacyBudgetTemplateOutput, GetProtectedQueryInput, GetProtectedQueryOutput, GetSchemaAnalysisRuleInput, GetSchemaAnalysisRuleOutput, GetSchemaInput, GetSchemaOutput, GlueTableReference, IdMappingConfig, IdMappingTable, IdMappingTableInputReferenceConfig, IdMappingTableInputReferenceProperties, IdMappingTableInputSource, IdMappingTableSchemaTypeProperties, IdMappingTableSummary, IdNamespaceAssociation, IdNamespaceAssociationInputReferenceConfig, IdNamespaceAssociationInputReferenceProperties, IdNamespaceAssociationInputReferencePropertiesSummary, IdNamespaceAssociationSummary, InternalServerException, ListAnalysisTemplatesInput, ListAnalysisTemplatesOutput, ListCollaborationAnalysisTemplatesInput, ListCollaborationAnalysisTemplatesOutput, ListCollaborationConfiguredAudienceModelAssociationsInput, ListCollaborationConfiguredAudienceModelAssociationsOutput, ListCollaborationIdNamespaceAssociationsInput, ListCollaborationIdNamespaceAssociationsOutput, ListCollaborationPrivacyBudgetTemplatesInput, ListCollaborationPrivacyBudgetTemplatesOutput, ListCollaborationPrivacyBudgetsInput, ListCollaborationPrivacyBudgetsOutput, ListCollaborationsInput, ListCollaborationsOutput, ListConfiguredAudienceModelAssociationsInput, ListConfiguredAudienceModelAssociationsOutput, ListConfiguredTableAssociationsInput, ListConfiguredTableAssociationsOutput, ListConfiguredTablesInput, ListConfiguredTablesOutput, ListIdMappingTablesInput, ListIdMappingTablesOutput, ListIdNamespaceAssociationsInput, ListIdNamespaceAssociationsOutput, ListMembersInput, ListMembersOutput, ListMembershipsInput, ListMembershipsOutput, ListPrivacyBudgetTemplatesInput, ListPrivacyBudgetTemplatesOutput, ListPrivacyBudgetsInput, ListPrivacyBudgetsOutput, ListProtectedQueriesInput, ListProtectedQueriesOutput, ListSchemasInput, ListSchemasOutput, ListTagsForResourceInput, ListTagsForResourceOutput, MLMemberAbilities, MLPaymentConfig, MemberSpecification, MemberSummary, Membership, MembershipMLPaymentConfig, MembershipModelInferencePaymentConfig, MembershipModelTrainingPaymentConfig, MembershipPaymentConfiguration, MembershipProtectedQueryOutputConfiguration, MembershipProtectedQueryResultConfiguration, MembershipQueryComputePaymentConfig, MembershipSummary, ModelInferencePaymentConfig, ModelTrainingPaymentConfig, PaymentConfiguration, PopulateIdMappingTableInput, PopulateIdMappingTableOutput, PreviewPrivacyImpactInput, PreviewPrivacyImpactOutput, PreviewPrivacyImpactParametersInput, PrivacyBudget, PrivacyBudgetSummary, PrivacyBudgetTemplate, PrivacyBudgetTemplateParametersInput, PrivacyBudgetTemplateParametersOutput, PrivacyBudgetTemplateSummary, PrivacyBudgetTemplateUpdateParameters, PrivacyImpact, ProtectedQuery, ProtectedQueryError, ProtectedQueryMemberOutputConfiguration, ProtectedQueryOutput, ProtectedQueryOutputConfiguration, ProtectedQueryResult, ProtectedQueryResultConfiguration, ProtectedQueryS3Output, ProtectedQueryS3OutputConfiguration, ProtectedQuerySQLParameters, ProtectedQuerySingleMemberOutput, ProtectedQueryStatistics, ProtectedQuerySummary, QueryComputePaymentConfig, QueryConstraint, QueryConstraintRequireOverlap, ReceiverConfiguration, ResourceNotFoundException, Schema, SchemaAnalysisRuleRequest, SchemaStatusDetail, SchemaStatusReason, SchemaSummary, SchemaTypeProperties, ServiceQuotaExceededException, StartProtectedQueryInput, StartProtectedQueryOutput, TableReference, TagResourceInput, TagResourceOutput, ThrottlingException, UntagResourceInput, UntagResourceOutput, UpdateAnalysisTemplateInput, UpdateAnalysisTemplateOutput, UpdateCollaborationInput, UpdateCollaborationOutput, UpdateConfiguredAudienceModelAssociationInput, UpdateConfiguredAudienceModelAssociationOutput, UpdateConfiguredTableAnalysisRuleInput, UpdateConfiguredTableAnalysisRuleOutput, UpdateConfiguredTableAssociationAnalysisRuleInput, UpdateConfiguredTableAssociationAnalysisRuleOutput, UpdateConfiguredTableAssociationInput, UpdateConfiguredTableAssociationOutput, UpdateConfiguredTableInput, UpdateConfiguredTableOutput, UpdateIdMappingTableInput, UpdateIdMappingTableOutput, UpdateIdNamespaceAssociationInput, UpdateIdNamespaceAssociationOutput, UpdateMembershipInput, UpdateMembershipOutput, UpdatePrivacyBudgetTemplateInput, UpdatePrivacyBudgetTemplateOutput, UpdateProtectedQueryInput, UpdateProtectedQueryOutput, ValidationException, ValidationExceptionField, WorkerComputeConfiguration

Instance Attribute Summary collapse

Instance Attribute Details

#aggregation ⇒ Types::ConfiguredTableAssociationAnalysisRuleAggregation

Analysis rule type that enables only aggregation queries on a configured table.

Returns:



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 363

class AnalysisRulePolicyV1 < Struct.new(
  :list,
  :aggregation,
  :custom,
  :id_mapping_table,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class List < AnalysisRulePolicyV1; end
  class Aggregation < AnalysisRulePolicyV1; end
  class Custom < AnalysisRulePolicyV1; end
  class IdMappingTable < AnalysisRulePolicyV1; end
  class Unknown < AnalysisRulePolicyV1; end
end

#custom ⇒ Types::ConfiguredTableAssociationAnalysisRuleCustom

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

Returns:



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 363

class AnalysisRulePolicyV1 < Struct.new(
  :list,
  :aggregation,
  :custom,
  :id_mapping_table,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class List < AnalysisRulePolicyV1; end
  class Aggregation < AnalysisRulePolicyV1; end
  class Custom < AnalysisRulePolicyV1; end
  class IdMappingTable < AnalysisRulePolicyV1; end
  class Unknown < AnalysisRulePolicyV1; end
end

#differential_privacy ⇒ Types::DifferentialPrivacyPrivacyImpact

An object that lists the number and type of aggregation functions you can perform.

Returns:



6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 6081

class PreviewPrivacyImpactParametersInput < Struct.new(
  :differential_privacy,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class DifferentialPrivacy < PreviewPrivacyImpactParametersInput; end
  class Unknown < PreviewPrivacyImpactParametersInput; end
end

#direct_analysis_configuration_details ⇒ Types::DirectAnalysisConfigurationDetails

The direct analysis configuration details.

Returns:



1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 1638

class ConfigurationDetails < Struct.new(
  :direct_analysis_configuration_details,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class DirectAnalysisConfigurationDetails < ConfigurationDetails; end
  class Unknown < ConfigurationDetails; end
end

#glue ⇒ Types::GlueTableReference

If present, a reference to the Glue table referred to by this table reference.

Returns:



7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 7186

class TableReference < Struct.new(
  :glue,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Glue < TableReference; end
  class Unknown < TableReference; end
end

#id_mapping_table ⇒ Types::IdMappingTableSchemaTypeProperties

The ID mapping table for the schema type properties.

Returns:



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 363

class AnalysisRulePolicyV1 < Struct.new(
  :list,
  :aggregation,
  :custom,
  :id_mapping_table,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class List < AnalysisRulePolicyV1; end
  class Aggregation < AnalysisRulePolicyV1; end
  class Custom < AnalysisRulePolicyV1; end
  class IdMappingTable < AnalysisRulePolicyV1; end
  class Unknown < AnalysisRulePolicyV1; end
end

#list ⇒ Types::ConfiguredTableAssociationAnalysisRuleList

Analysis rule type that enables only list queries on a configured table.

Returns:



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 363

class AnalysisRulePolicyV1 < Struct.new(
  :list,
  :aggregation,
  :custom,
  :id_mapping_table,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class List < AnalysisRulePolicyV1; end
  class Aggregation < AnalysisRulePolicyV1; end
  class Custom < AnalysisRulePolicyV1; end
  class IdMappingTable < AnalysisRulePolicyV1; end
  class Unknown < AnalysisRulePolicyV1; end
end

#member ⇒ Types::ProtectedQueryMemberOutputConfiguration

Required configuration for a protected query with a ‘member` output type.

Returns:



6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 6561

class ProtectedQueryOutputConfiguration < Struct.new(
  :s3,
  :member,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class S3 < ProtectedQueryOutputConfiguration; end
  class Member < ProtectedQueryOutputConfiguration; end
  class Unknown < ProtectedQueryOutputConfiguration; end
end

#member_list ⇒ Array<Types::ProtectedQuerySingleMemberOutput>

The list of member Amazon Web Services account(s) that received the results of the query.

Returns:



6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 6530

class ProtectedQueryOutput < Struct.new(
  :s3,
  :member_list,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class S3 < ProtectedQueryOutput; end
  class MemberList < ProtectedQueryOutput; end
  class Unknown < ProtectedQueryOutput; end
end

#require_overlap ⇒ Types::QueryConstraintRequireOverlap

An array of column names that specifies which columns are required in the JOIN statement.

Returns:



6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 6787

class QueryConstraint < Struct.new(
  :require_overlap,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class RequireOverlap < QueryConstraint; end
  class Unknown < QueryConstraint; end
end

#s3 ⇒ Types::ProtectedQueryS3OutputConfiguration

Required configuration for a protected query with an ‘s3` output type.

Returns:



5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 5784

class MembershipProtectedQueryOutputConfiguration < Struct.new(
  :s3,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class S3 < MembershipProtectedQueryOutputConfiguration; end
  class Unknown < MembershipProtectedQueryOutputConfiguration; end
end

#text ⇒ String

The query text.

Returns:

  • (String) 


406
407
408
409
410
411
412
413
414
415
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 406

class AnalysisSource < Struct.new(
  :text,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Text < AnalysisSource; end
  class Unknown < AnalysisSource; end
end

#v1 ⇒ Types::ConfiguredTableAssociationAnalysisRulePolicyV1

The policy for the configured table association analysis rule.

Returns:



326
327
328
329
330
331
332
333
334
335
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 326

class AnalysisRulePolicy < Struct.new(
  :v1,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class V1 < AnalysisRulePolicy; end
  class Unknown < AnalysisRulePolicy; end
end

#worker ⇒ Types::WorkerComputeConfiguration

The worker configuration for the compute environment.

Returns:



1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 1617

class ComputeConfiguration < Struct.new(
  :worker,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Worker < ComputeConfiguration; end
  class Unknown < ComputeConfiguration; end
end