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

Inherits:

Struct

• Object
• Struct
• Aws::CleanRooms::Types::CollaborationAnalysisTemplate

Defined in:

gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb

Overview

The analysis template within a collaboration.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:analysis_parameters]

Instance Attribute Summary

• #analysis_parameters ⇒ Array<Types::AnalysisParameter>

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

• #arn ⇒ String

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

• #collaboration_arn ⇒ String

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

• #collaboration_id ⇒ String

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

• #create_time ⇒ Time

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

• #creator_account_id ⇒ String

  The identifier used to reference members of the collaboration.

• #description ⇒ String

  The description of the analysis template.

• #error_message_configuration ⇒ Types::ErrorMessageConfiguration

  The configuration that specifies the level of detail in error messages returned by analyses using this template.

• #format ⇒ String

  The format of the analysis template in the collaboration.

• #id ⇒ String

  The identifier of the analysis template.

• #name ⇒ String

  The name of the analysis template.

• #schema ⇒ Types::AnalysisSchema

  The entire schema object.

• #source ⇒ Types::AnalysisSource

  The source of the analysis template within a collaboration.

• #source_metadata ⇒ Types::AnalysisSourceMetadata

  The source metadata for the collaboration analysis template.

• #update_time ⇒ Time

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

• #validations ⇒ Array<Types::AnalysisTemplateValidationStatusDetail>

  The validations that were performed.

Instance Attribute Details

#analysis_parameters ⇒ Array<Types::AnalysisParameter>

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

Returns:

• (Array<Types::AnalysisParameter>)

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

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)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#arn ⇒ String

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

Returns:

• (String)

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

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)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#collaboration_arn ⇒ String

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

Returns:

• (String)

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

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)
  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)

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

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)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#create_time ⇒ Time

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

Returns:

• (Time)

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

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)
  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)

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

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)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#description ⇒ String

The description of the analysis template.

Returns:

• (String)

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

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)
  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:

• (Types::ErrorMessageConfiguration)

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

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)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#format ⇒ String

The format of the analysis template in the collaboration.

Returns:

• (String)

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

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)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#id ⇒ String

The identifier of the analysis template.

Returns:

• (String)

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

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)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#name ⇒ String

The name of the analysis template.

Returns:

• (String)

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

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)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#schema ⇒ Types::AnalysisSchema

The entire schema object.

Returns:

• (Types::AnalysisSchema)

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

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)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#source ⇒ Types::AnalysisSource

The source of the analysis template within a collaboration.

Returns:

• (Types::AnalysisSource)

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

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)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#source_metadata ⇒ Types::AnalysisSourceMetadata

The source metadata for the collaboration analysis template.

Returns:

• (Types::AnalysisSourceMetadata)

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

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)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#update_time ⇒ Time

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

Returns:

• (Time)

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

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)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end

#validations ⇒ Array<Types::AnalysisTemplateValidationStatusDetail>

The validations that were performed.

Returns:

• (Array<Types::AnalysisTemplateValidationStatusDetail>)

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

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)
  SENSITIVE = [:analysis_parameters]
  include Aws::Structure
end