Class: Aws::SageMaker::Types::ModelCard

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::ModelCard

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

An Amazon SageMaker Model Card.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:content]

Instance Attribute Summary

• #content ⇒ String

  The content of the model card.

• #created_by ⇒ Types::UserContext

  Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

• #creation_time ⇒ Time

  The date and time that the model card was created.

• #last_modified_by ⇒ Types::UserContext

  Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

• #last_modified_time ⇒ Time

  The date and time that the model card was last modified.

• #model_card_arn ⇒ String

  The Amazon Resource Name (ARN) of the model card.

• #model_card_name ⇒ String

  The unique name of the model card.

• #model_card_status ⇒ String

  The approval status of the model card within your organization.

• #model_card_version ⇒ Integer

  The version of the model card.

• #model_id ⇒ String

  The unique name (ID) of the model.

• #model_package_group_name ⇒ String

  The model package group that contains the model package.

• #risk_rating ⇒ String

  The risk rating of the model.

• #security_config ⇒ Types::ModelCardSecurityConfig

  The security configuration used to protect model card data.

• #tags ⇒ Array<Types::Tag>

  Key-value pairs used to manage metadata for the model card.

Instance Attribute Details

#content ⇒ String

The content of the model card. Content uses the [model card JSON schema] and provided as a string.

[1]: docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 32105

class ModelCard < Struct.new(
  :model_card_arn,
  :model_card_name,
  :model_card_version,
  :content,
  :model_card_status,
  :security_config,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :tags,
  :model_id,
  :risk_rating,
  :model_package_group_name)
  SENSITIVE = [:content]
  include Aws::Structure
end

#created_by ⇒ Types::UserContext

Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

Returns:

• (Types::UserContext)

# File 'lib/aws-sdk-sagemaker/types.rb', line 32105

class ModelCard < Struct.new(
  :model_card_arn,
  :model_card_name,
  :model_card_version,
  :content,
  :model_card_status,
  :security_config,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :tags,
  :model_id,
  :risk_rating,
  :model_package_group_name)
  SENSITIVE = [:content]
  include Aws::Structure
end

#creation_time ⇒ Time

The date and time that the model card was created.

Returns:

• (Time)

# File 'lib/aws-sdk-sagemaker/types.rb', line 32105

class ModelCard < Struct.new(
  :model_card_arn,
  :model_card_name,
  :model_card_version,
  :content,
  :model_card_status,
  :security_config,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :tags,
  :model_id,
  :risk_rating,
  :model_package_group_name)
  SENSITIVE = [:content]
  include Aws::Structure
end

#last_modified_by ⇒ Types::UserContext

Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

Returns:

• (Types::UserContext)

# File 'lib/aws-sdk-sagemaker/types.rb', line 32105

class ModelCard < Struct.new(
  :model_card_arn,
  :model_card_name,
  :model_card_version,
  :content,
  :model_card_status,
  :security_config,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :tags,
  :model_id,
  :risk_rating,
  :model_package_group_name)
  SENSITIVE = [:content]
  include Aws::Structure
end

#last_modified_time ⇒ Time

The date and time that the model card was last modified.

Returns:

• (Time)

# File 'lib/aws-sdk-sagemaker/types.rb', line 32105

class ModelCard < Struct.new(
  :model_card_arn,
  :model_card_name,
  :model_card_version,
  :content,
  :model_card_status,
  :security_config,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :tags,
  :model_id,
  :risk_rating,
  :model_package_group_name)
  SENSITIVE = [:content]
  include Aws::Structure
end

#model_card_arn ⇒ String

The Amazon Resource Name (ARN) of the model card.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 32105

class ModelCard < Struct.new(
  :model_card_arn,
  :model_card_name,
  :model_card_version,
  :content,
  :model_card_status,
  :security_config,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :tags,
  :model_id,
  :risk_rating,
  :model_package_group_name)
  SENSITIVE = [:content]
  include Aws::Structure
end

#model_card_name ⇒ String

The unique name of the model card.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 32105

class ModelCard < Struct.new(
  :model_card_arn,
  :model_card_name,
  :model_card_version,
  :content,
  :model_card_status,
  :security_config,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :tags,
  :model_id,
  :risk_rating,
  :model_package_group_name)
  SENSITIVE = [:content]
  include Aws::Structure
end

#model_card_status ⇒ String

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

• ‘Draft`: The model card is a work in progress.

• ‘PendingReview`: The model card is pending review.

• ‘Approved`: The model card is approved.

• ‘Archived`: The model card is archived. No more updates should be made to the model card, but it can still be exported.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 32105

class ModelCard < Struct.new(
  :model_card_arn,
  :model_card_name,
  :model_card_version,
  :content,
  :model_card_status,
  :security_config,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :tags,
  :model_id,
  :risk_rating,
  :model_package_group_name)
  SENSITIVE = [:content]
  include Aws::Structure
end

#model_card_version ⇒ Integer

The version of the model card.

Returns:

• (Integer)

# File 'lib/aws-sdk-sagemaker/types.rb', line 32105

class ModelCard < Struct.new(
  :model_card_arn,
  :model_card_name,
  :model_card_version,
  :content,
  :model_card_status,
  :security_config,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :tags,
  :model_id,
  :risk_rating,
  :model_package_group_name)
  SENSITIVE = [:content]
  include Aws::Structure
end

#model_id ⇒ String

The unique name (ID) of the model.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 32105

class ModelCard < Struct.new(
  :model_card_arn,
  :model_card_name,
  :model_card_version,
  :content,
  :model_card_status,
  :security_config,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :tags,
  :model_id,
  :risk_rating,
  :model_package_group_name)
  SENSITIVE = [:content]
  include Aws::Structure
end

#model_package_group_name ⇒ String

The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 32105

class ModelCard < Struct.new(
  :model_card_arn,
  :model_card_name,
  :model_card_version,
  :content,
  :model_card_status,
  :security_config,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :tags,
  :model_id,
  :risk_rating,
  :model_package_group_name)
  SENSITIVE = [:content]
  include Aws::Structure
end

#risk_rating ⇒ String

The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see [Risk ratings].

[1]: docs.aws.amazon.com/sagemaker/latest/dg/model-cards-risk-rating.html

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 32105

class ModelCard < Struct.new(
  :model_card_arn,
  :model_card_name,
  :model_card_version,
  :content,
  :model_card_status,
  :security_config,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :tags,
  :model_id,
  :risk_rating,
  :model_package_group_name)
  SENSITIVE = [:content]
  include Aws::Structure
end

#security_config ⇒ Types::ModelCardSecurityConfig

The security configuration used to protect model card data.

Returns:

• (Types::ModelCardSecurityConfig)

# File 'lib/aws-sdk-sagemaker/types.rb', line 32105

class ModelCard < Struct.new(
  :model_card_arn,
  :model_card_name,
  :model_card_version,
  :content,
  :model_card_status,
  :security_config,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :tags,
  :model_id,
  :risk_rating,
  :model_package_group_name)
  SENSITIVE = [:content]
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Key-value pairs used to manage metadata for the model card.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-sagemaker/types.rb', line 32105

class ModelCard < Struct.new(
  :model_card_arn,
  :model_card_name,
  :model_card_version,
  :content,
  :model_card_status,
  :security_config,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :tags,
  :model_id,
  :risk_rating,
  :model_package_group_name)
  SENSITIVE = [:content]
  include Aws::Structure
end