Class: Aws::CleanRooms::Types::CollaborationAnalysisTemplate

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

Overview

The analysis template within a collaboration.

See Also:

Constant Summary collapse

SENSITIVE = 
[:analysis_parameters]

Instance Attribute Summary collapse

Instance Attribute Details

#analysis_parameters ⇒ Array<Types::AnalysisParameter>

The analysis parameters that have been specified in the analysis template.

Returns:



1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 1450

class CollaborationAnalysisTemplate < Struct.new(
  :id,
  :arn,
  :collaboration_id,
  :collaboration_arn,
  :description,
  :creator_account_id,
  :name,
  :create_time,
  :update_time,
  :schema,
  :format,
  :source,
  :source_metadata,
  :analysis_parameters,
  :validations,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#arn ⇒ String

The Amazon Resource Name (ARN) of the analysis template.

Returns:

  • (String) 


1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 1450

class CollaborationAnalysisTemplate < Struct.new(
  :id,
  :arn,
  :collaboration_id,
  :collaboration_arn,
  :description,
  :creator_account_id,
  :name,
  :create_time,
  :update_time,
  :schema,
  :format,
  :source,
  :source_metadata,
  :analysis_parameters,
  :validations,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#collaboration_arn ⇒ String

The unique ARN for the analysis template’s associated collaboration.

Returns:

  • (String) 


1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 1450

class CollaborationAnalysisTemplate < Struct.new(
  :id,
  :arn,
  :collaboration_id,
  :collaboration_arn,
  :description,
  :creator_account_id,
  :name,
  :create_time,
  :update_time,
  :schema,
  :format,
  :source,
  :source_metadata,
  :analysis_parameters,
  :validations,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#collaboration_id ⇒ String

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

Returns:

  • (String) 


1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 1450

class CollaborationAnalysisTemplate < Struct.new(
  :id,
  :arn,
  :collaboration_id,
  :collaboration_arn,
  :description,
  :creator_account_id,
  :name,
  :create_time,
  :update_time,
  :schema,
  :format,
  :source,
  :source_metadata,
  :analysis_parameters,
  :validations,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#create_time ⇒ Time

The time that the analysis template within a collaboration was created.

Returns:

  • (Time) 


1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 1450

class CollaborationAnalysisTemplate < Struct.new(
  :id,
  :arn,
  :collaboration_id,
  :collaboration_arn,
  :description,
  :creator_account_id,
  :name,
  :create_time,
  :update_time,
  :schema,
  :format,
  :source,
  :source_metadata,
  :analysis_parameters,
  :validations,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#creator_account_id ⇒ String

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

Returns:

  • (String) 


1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 1450

class CollaborationAnalysisTemplate < Struct.new(
  :id,
  :arn,
  :collaboration_id,
  :collaboration_arn,
  :description,
  :creator_account_id,
  :name,
  :create_time,
  :update_time,
  :schema,
  :format,
  :source,
  :source_metadata,
  :analysis_parameters,
  :validations,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#description ⇒ String

The description of the analysis template.

Returns:

  • (String) 


1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 1450

class CollaborationAnalysisTemplate < Struct.new(
  :id,
  :arn,
  :collaboration_id,
  :collaboration_arn,
  :description,
  :creator_account_id,
  :name,
  :create_time,
  :update_time,
  :schema,
  :format,
  :source,
  :source_metadata,
  :analysis_parameters,
  :validations,
  :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:



1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 1450

class CollaborationAnalysisTemplate < Struct.new(
  :id,
  :arn,
  :collaboration_id,
  :collaboration_arn,
  :description,
  :creator_account_id,
  :name,
  :create_time,
  :update_time,
  :schema,
  :format,
  :source,
  :source_metadata,
  :analysis_parameters,
  :validations,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#format ⇒ String

The format of the analysis template in the collaboration.

Returns:

  • (String) 


1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 1450

class CollaborationAnalysisTemplate < Struct.new(
  :id,
  :arn,
  :collaboration_id,
  :collaboration_arn,
  :description,
  :creator_account_id,
  :name,
  :create_time,
  :update_time,
  :schema,
  :format,
  :source,
  :source_metadata,
  :analysis_parameters,
  :validations,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#id ⇒ String

The identifier of the analysis template.

Returns:

  • (String) 


1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 1450

class CollaborationAnalysisTemplate < Struct.new(
  :id,
  :arn,
  :collaboration_id,
  :collaboration_arn,
  :description,
  :creator_account_id,
  :name,
  :create_time,
  :update_time,
  :schema,
  :format,
  :source,
  :source_metadata,
  :analysis_parameters,
  :validations,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#name ⇒ String

The name of the analysis template.

Returns:

  • (String) 


1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 1450

class CollaborationAnalysisTemplate < Struct.new(
  :id,
  :arn,
  :collaboration_id,
  :collaboration_arn,
  :description,
  :creator_account_id,
  :name,
  :create_time,
  :update_time,
  :schema,
  :format,
  :source,
  :source_metadata,
  :analysis_parameters,
  :validations,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#schema ⇒ Types::AnalysisSchema

The entire schema object.

Returns:



1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 1450

class CollaborationAnalysisTemplate < Struct.new(
  :id,
  :arn,
  :collaboration_id,
  :collaboration_arn,
  :description,
  :creator_account_id,
  :name,
  :create_time,
  :update_time,
  :schema,
  :format,
  :source,
  :source_metadata,
  :analysis_parameters,
  :validations,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#source ⇒ Types::AnalysisSource

The source of the analysis template within a collaboration.

Returns:



1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 1450

class CollaborationAnalysisTemplate < Struct.new(
  :id,
  :arn,
  :collaboration_id,
  :collaboration_arn,
  :description,
  :creator_account_id,
  :name,
  :create_time,
  :update_time,
  :schema,
  :format,
  :source,
  :source_metadata,
  :analysis_parameters,
  :validations,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#source_metadata ⇒ Types::AnalysisSourceMetadata

The source metadata for the collaboration analysis template.

Returns:



1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 1450

class CollaborationAnalysisTemplate < Struct.new(
  :id,
  :arn,
  :collaboration_id,
  :collaboration_arn,
  :description,
  :creator_account_id,
  :name,
  :create_time,
  :update_time,
  :schema,
  :format,
  :source,
  :source_metadata,
  :analysis_parameters,
  :validations,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#synthetic_data_parameters ⇒ Types::SyntheticDataParameters

The synthetic data generation parameters configured for this collaboration analysis template.

Returns:



1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 1450

class CollaborationAnalysisTemplate < Struct.new(
  :id,
  :arn,
  :collaboration_id,
  :collaboration_arn,
  :description,
  :creator_account_id,
  :name,
  :create_time,
  :update_time,
  :schema,
  :format,
  :source,
  :source_metadata,
  :analysis_parameters,
  :validations,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#update_time ⇒ Time

The time that the analysis template in the collaboration was last updated.

Returns:

  • (Time) 


1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 1450

class CollaborationAnalysisTemplate < Struct.new(
  :id,
  :arn,
  :collaboration_id,
  :collaboration_arn,
  :description,
  :creator_account_id,
  :name,
  :create_time,
  :update_time,
  :schema,
  :format,
  :source,
  :source_metadata,
  :analysis_parameters,
  :validations,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#validations ⇒ Array<Types::AnalysisTemplateValidationStatusDetail>

The validations that were performed.

Returns:



1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/aws-sdk-cleanrooms/types.rb', line 1450

class CollaborationAnalysisTemplate < Struct.new(
  :id,
  :arn,
  :collaboration_id,
  :collaboration_arn,
  :description,
  :creator_account_id,
  :name,
  :create_time,
  :update_time,
  :schema,
  :format,
  :source,
  :source_metadata,
  :analysis_parameters,
  :validations,
  :error_message_configuration,
  :synthetic_data_parameters)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end