Module: Aws::CleanRooms::Types

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

Defined Under Namespace

Instance Attribute Summary collapse

#access_budget ⇒ Types::AccessBudgetsPrivacyTemplateUpdateParameters
The new access budget configuration that completely replaces the existing access budget settings in the privacy budget template.
#aggregation ⇒ Types::ConsolidatedPolicyAggregation
The aggregation setting for the consolidated policy.
#artifacts ⇒ Types::AnalysisTemplateArtifactMetadata
The artifacts of the analysis source metadata.
#athena ⇒ Types::AthenaTableReference
If present, a reference to the Athena table referred to by this table reference.
#collaboration ⇒ Types::CollaborationChangeSpecification
The collaboration configuration changes being requested.
#custom ⇒ Types::ConsolidatedPolicyCustom
Custom policy.
#differential_privacy ⇒ Types::DifferentialPrivacyPrivacyImpact
An object that lists the number and type of aggregation functions you can perform.
#direct_analysis_configuration_details ⇒ Types::ProtectedJobDirectAnalysisConfigurationDetails
The details needed to configure the direct analysis.
#distribute ⇒ Types::ProtectedQueryDistributeOutputConfiguration
Required configuration for a protected query with a distribute output type.
#glue ⇒ Types::GlueTableReference
If present, a reference to the Glue table referred to by this table reference.
#id_mapping_table ⇒ Types::IdMappingTableSchemaTypeProperties
The ID mapping table for the schema type properties.
#list ⇒ Types::ConsolidatedPolicyList
The list of consolidated policies.
#member ⇒ Types::ProtectedQueryMemberOutputConfiguration
Required configuration for a protected query with a member output type.
#member_list ⇒ Array<Types::ProtectedQuerySingleMemberOutput>
The list of member Amazon Web Services account(s) that received the results of the query.
#ml_synthetic_data_parameters ⇒ Types::MLSyntheticDataParameters
The machine learning-specific parameters for synthetic data generation.
#require_overlap ⇒ Types::QueryConstraintRequireOverlap
An array of column names that specifies which columns are required in the JOIN statement.
#s3 ⇒ Types::ProtectedQueryS3OutputConfiguration
Required configuration for a protected query with an s3 output type.
#snowflake ⇒ Types::SnowflakeTableReference
If present, a reference to the Snowflake table referred to by this table reference.
#spark ⇒ Hash<String,String>
The Spark configuration properties for SQL workloads.
#text ⇒ String
The query text.
#v1 ⇒ Array<Types::SnowflakeTableSchemaV1>
The schema of a Snowflake table.
#worker ⇒ Types::ProtectedJobWorkerComputeConfiguration
The worker configuration for the compute environment.

Instance Attribute Details

#access_budget ⇒ `Types::AccessBudgetsPrivacyTemplateUpdateParameters`

The new access budget configuration that completely replaces the existing access budget settings in the privacy budget template.

Returns:

(Types::AccessBudgetsPrivacyTemplateUpdateParameters)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 7511

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

  class DifferentialPrivacy < PrivacyBudget; end
  class AccessBudget < PrivacyBudget; end
  class Unknown < PrivacyBudget; end
end

#aggregation ⇒ `Types::ConsolidatedPolicyAggregation`

The aggregation setting for the consolidated policy.

Returns:

(Types::ConsolidatedPolicyAggregation)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 530

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

#artifacts ⇒ `Types::AnalysisTemplateArtifactMetadata`

The artifacts of the analysis source metadata.

Returns:

(Types::AnalysisTemplateArtifactMetadata)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 577

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

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

#athena ⇒ `Types::AthenaTableReference`

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

Returns:

(Types::AthenaTableReference)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 9450

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

  class Glue < TableReference; end
  class Snowflake < TableReference; end
  class Athena < TableReference; end
  class Unknown < TableReference; end
end

#collaboration ⇒ `Types::CollaborationChangeSpecification`

The collaboration configuration changes being requested. Currently, this only supports modifying which change types are auto-approved for the collaboration.

Returns:

(Types::CollaborationChangeSpecification)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 1261

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

  class Member < ChangeSpecification; end
  class Collaboration < ChangeSpecification; end
  class Unknown < ChangeSpecification; end
end

#custom ⇒ `Types::ConsolidatedPolicyCustom`

Custom policy

Returns:

(Types::ConsolidatedPolicyCustom)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 530

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:

(Types::DifferentialPrivacyPrivacyImpact)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 7483

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::ProtectedJobDirectAnalysisConfigurationDetails`

The details needed to configure the direct analysis.

Returns:

(Types::ProtectedJobDirectAnalysisConfigurationDetails)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 2292

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

#distribute ⇒ `Types::ProtectedQueryDistributeOutputConfiguration`

Required configuration for a protected query with a distribute output type.

Returns:

(Types::ProtectedQueryDistributeOutputConfiguration)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 8522

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

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

#glue ⇒ `Types::GlueTableReference`

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

Returns:

(Types::GlueTableReference)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 9450

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

  class Glue < TableReference; end
  class Snowflake < TableReference; end
  class Athena < TableReference; end
  class Unknown < TableReference; end
end

#id_mapping_table ⇒ `Types::IdMappingTableSchemaTypeProperties`

The ID mapping table for the schema type properties.

Returns:

(Types::IdMappingTableSchemaTypeProperties)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 530

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::ConsolidatedPolicyList`

The list of consolidated policies.

Returns:

(Types::ConsolidatedPolicyList)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 530

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:

(Types::ProtectedQueryMemberOutputConfiguration)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 1261

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

  class Member < ChangeSpecification; end
  class Collaboration < ChangeSpecification; end
  class Unknown < ChangeSpecification; end
end

#member_list ⇒ `Array<Types::ProtectedQuerySingleMemberOutput>`

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

Returns:

(Array<Types::ProtectedQuerySingleMemberOutput>)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 8025

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

  class S3 < ProtectedJobOutput; end
  class MemberList < ProtectedJobOutput; end
  class Unknown < ProtectedJobOutput; end
end

#ml_synthetic_data_parameters ⇒ `Types::MLSyntheticDataParameters`

The machine learning-specific parameters for synthetic data generation.

Returns:

(Types::MLSyntheticDataParameters)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 9416

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

  class MlSyntheticDataParameters < SyntheticDataParameters; end
  class Unknown < SyntheticDataParameters; end
end

#require_overlap ⇒ `Types::QueryConstraintRequireOverlap`

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

Returns:

(Types::QueryConstraintRequireOverlap)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 8788

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:

(Types::ProtectedQueryS3OutputConfiguration)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 7105

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

  class S3 < MembershipProtectedJobOutputConfiguration; end
  class Unknown < MembershipProtectedJobOutputConfiguration; end
end

#snowflake ⇒ `Types::SnowflakeTableReference`

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

Returns:

(Types::SnowflakeTableReference)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 9450

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

  class Glue < TableReference; end
  class Snowflake < TableReference; end
  class Athena < TableReference; end
  class Unknown < TableReference; end
end

#spark ⇒ `Hash<String,String>`

The Spark configuration properties for SQL 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.

Returns:

(Hash<String,String>)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 10222

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

  class Spark < WorkerComputeConfigurationProperties; end
  class Unknown < WorkerComputeConfigurationProperties; end
end

#text ⇒ `String`

The query text.

Returns:

(String)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 577

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

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

#v1 ⇒ `Array<Types::SnowflakeTableSchemaV1>`

The schema of a Snowflake table.

Returns:

(Array<Types::SnowflakeTableSchemaV1>)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 493

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::ProtectedJobWorkerComputeConfiguration`

The worker configuration for the compute environment.

Returns:

(Types::ProtectedJobWorkerComputeConfiguration)

# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 2271

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

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

Module: Aws::CleanRooms::Types

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#access_budget ⇒ Types::AccessBudgetsPrivacyTemplateUpdateParameters

#aggregation ⇒ Types::ConsolidatedPolicyAggregation

#artifacts ⇒ Types::AnalysisTemplateArtifactMetadata

#athena ⇒ Types::AthenaTableReference

#collaboration ⇒ Types::CollaborationChangeSpecification

#custom ⇒ Types::ConsolidatedPolicyCustom

#differential_privacy ⇒ Types::DifferentialPrivacyPrivacyImpact

#direct_analysis_configuration_details ⇒ Types::ProtectedJobDirectAnalysisConfigurationDetails

#distribute ⇒ Types::ProtectedQueryDistributeOutputConfiguration

#glue ⇒ Types::GlueTableReference

#id_mapping_table ⇒ Types::IdMappingTableSchemaTypeProperties

#list ⇒ Types::ConsolidatedPolicyList

#member ⇒ Types::ProtectedQueryMemberOutputConfiguration

#member_list ⇒ Array<Types::ProtectedQuerySingleMemberOutput>

#ml_synthetic_data_parameters ⇒ Types::MLSyntheticDataParameters

#require_overlap ⇒ Types::QueryConstraintRequireOverlap

#s3 ⇒ Types::ProtectedQueryS3OutputConfiguration

#snowflake ⇒ Types::SnowflakeTableReference

#spark ⇒ Hash<String,String>

#text ⇒ String

#v1 ⇒ Array<Types::SnowflakeTableSchemaV1>

#worker ⇒ Types::ProtectedJobWorkerComputeConfiguration

#access_budget ⇒ `Types::AccessBudgetsPrivacyTemplateUpdateParameters`

#aggregation ⇒ `Types::ConsolidatedPolicyAggregation`

#artifacts ⇒ `Types::AnalysisTemplateArtifactMetadata`

#athena ⇒ `Types::AthenaTableReference`

#collaboration ⇒ `Types::CollaborationChangeSpecification`

#custom ⇒ `Types::ConsolidatedPolicyCustom`

#differential_privacy ⇒ `Types::DifferentialPrivacyPrivacyImpact`

#direct_analysis_configuration_details ⇒ `Types::ProtectedJobDirectAnalysisConfigurationDetails`

#distribute ⇒ `Types::ProtectedQueryDistributeOutputConfiguration`

#glue ⇒ `Types::GlueTableReference`

#id_mapping_table ⇒ `Types::IdMappingTableSchemaTypeProperties`

#list ⇒ `Types::ConsolidatedPolicyList`

#member ⇒ `Types::ProtectedQueryMemberOutputConfiguration`

#member_list ⇒ `Array<Types::ProtectedQuerySingleMemberOutput>`

#ml_synthetic_data_parameters ⇒ `Types::MLSyntheticDataParameters`

#require_overlap ⇒ `Types::QueryConstraintRequireOverlap`

#s3 ⇒ `Types::ProtectedQueryS3OutputConfiguration`

#snowflake ⇒ `Types::SnowflakeTableReference`

#spark ⇒ `Hash<String,String>`

#text ⇒ `String`

#v1 ⇒ `Array<Types::SnowflakeTableSchemaV1>`

#worker ⇒ `Types::ProtectedJobWorkerComputeConfiguration`