Class: Aws::CleanRooms::Types::CreateAnalysisTemplateInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cleanrooms/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:analysis_parameters]

Instance Attribute Summary collapse

Instance Attribute Details

#analysis_parameters ⇒ Array<Types::AnalysisParameter>

The parameters of the analysis template.

Returns:



3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 3302

class CreateAnalysisTemplateInput < Struct.new(
  :description,
  :membership_identifier,
  :name,
  :format,
  :source,
  :tags,
  :analysis_parameters,
  :schema,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#description ⇒ String

The description of the analysis template.

Returns:

  • (String) 


3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 3302

class CreateAnalysisTemplateInput < Struct.new(
  :description,
  :membership_identifier,
  :name,
  :format,
  :source,
  :tags,
  :analysis_parameters,
  :schema,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#error_message_configuration ⇒ Types::ErrorMessageConfiguration

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.

Returns:



3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 3302

class CreateAnalysisTemplateInput < Struct.new(
  :description,
  :membership_identifier,
  :name,
  :format,
  :source,
  :tags,
  :analysis_parameters,
  :schema,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#format ⇒ String

The format of the analysis template.

Returns:

  • (String) 


3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 3302

class CreateAnalysisTemplateInput < Struct.new(
  :description,
  :membership_identifier,
  :name,
  :format,
  :source,
  :tags,
  :analysis_parameters,
  :schema,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#membership_identifier ⇒ String

The identifier for a membership resource.

Returns:

  • (String) 


3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 3302

class CreateAnalysisTemplateInput < Struct.new(
  :description,
  :membership_identifier,
  :name,
  :format,
  :source,
  :tags,
  :analysis_parameters,
  :schema,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#name ⇒ String

The name of the analysis template.

Returns:

  • (String) 


3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 3302

class CreateAnalysisTemplateInput < Struct.new(
  :description,
  :membership_identifier,
  :name,
  :format,
  :source,
  :tags,
  :analysis_parameters,
  :schema,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#schema ⇒ Types::AnalysisSchema

A relation within an analysis.

Returns:



3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 3302

class CreateAnalysisTemplateInput < Struct.new(
  :description,
  :membership_identifier,
  :name,
  :format,
  :source,
  :tags,
  :analysis_parameters,
  :schema,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#source ⇒ Types::AnalysisSource

The information in the analysis template.

Returns:



3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 3302

class CreateAnalysisTemplateInput < Struct.new(
  :description,
  :membership_identifier,
  :name,
  :format,
  :source,
  :tags,
  :analysis_parameters,
  :schema,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#synthetic_data_parameters ⇒ Types::SyntheticDataParameters

The parameters for generating synthetic data when running the analysis template.

Returns:



3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 3302

class CreateAnalysisTemplateInput < Struct.new(
  :description,
  :membership_identifier,
  :name,
  :format,
  :source,
  :tags,
  :analysis_parameters,
  :schema,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

Returns:

  • (Hash<String,String>) 


3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 3302

class CreateAnalysisTemplateInput < Struct.new(
  :description,
  :membership_identifier,
  :name,
  :format,
  :source,
  :tags,
  :analysis_parameters,
  :schema,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end