ModelCard (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.sagemaker.model

Class ModelCard

java.lang.Object
- com.amazonaws.services.sagemaker.model.ModelCard

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ModelCard
extends Object
implements Serializable, Cloneable, StructuredPojo

An Amazon SageMaker Model Card.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ModelCard ()

Constructors
Constructor and Description
`ModelCard ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`ModelCard`	`clone ()`
`boolean`	`equals (Object obj)`
`String`	`getContent ()` The content of the model card.
`UserContext`	`getCreatedBy ()`
`Date`	`getCreationTime ()` The date and time that the model card was created.
`UserContext`	`getLastModifiedBy ()`
`Date`	`getLastModifiedTime ()` The date and time that the model card was last modified.
`String`	`getModelCardArn ()` The Amazon Resource Name (ARN) of the model card.
`String`	`getModelCardName ()` The unique name of the model card.
`String`	`getModelCardStatus ()` The approval status of the model card within your organization.
`Integer`	`getModelCardVersion ()` The version of the model card.
`String`	`getModelId ()` The unique name (ID) of the model.
`String`	`getModelPackageGroupName ()` The model package group that contains the model package.
`String`	`getRiskRating ()` The risk rating of the model.
`ModelCardSecurityConfig`	`getSecurityConfig ()` The security configuration used to protect model card data.
`List<Tag>`	`getTags ()` Key-value pairs used to manage metadata for the model card.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setContent (String content)` The content of the model card.
`void`	`setCreatedBy (UserContext createdBy)`
`void`	`setCreationTime (Date creationTime)` The date and time that the model card was created.
`void`	`setLastModifiedBy (UserContext lastModifiedBy)`
`void`	`setLastModifiedTime (Date lastModifiedTime)` The date and time that the model card was last modified.
`void`	`setModelCardArn (String modelCardArn)` The Amazon Resource Name (ARN) of the model card.
`void`	`setModelCardName (String modelCardName)` The unique name of the model card.
`void`	`setModelCardStatus (String modelCardStatus)` The approval status of the model card within your organization.
`void`	`setModelCardVersion (Integer modelCardVersion)` The version of the model card.
`void`	`setModelId (String modelId)` The unique name (ID) of the model.
`void`	`setModelPackageGroupName (String modelPackageGroupName)` The model package group that contains the model package.
`void`	`setRiskRating (String riskRating)` The risk rating of the model.
`void`	`setSecurityConfig (ModelCardSecurityConfig securityConfig)` The security configuration used to protect model card data.
`void`	`setTags (Collection<Tag> tags)` Key-value pairs used to manage metadata for the model card.
`String`	`toString ()` Returns a string representation of this object.
`ModelCard`	`withContent (String content)` The content of the model card.
`ModelCard`	`withCreatedBy (UserContext createdBy)`
`ModelCard`	`withCreationTime (Date creationTime)` The date and time that the model card was created.
`ModelCard`	`withLastModifiedBy (UserContext lastModifiedBy)`
`ModelCard`	`withLastModifiedTime (Date lastModifiedTime)` The date and time that the model card was last modified.
`ModelCard`	`withModelCardArn (String modelCardArn)` The Amazon Resource Name (ARN) of the model card.
`ModelCard`	`withModelCardName (String modelCardName)` The unique name of the model card.
`ModelCard`	`withModelCardStatus (ModelCardStatus modelCardStatus)` The approval status of the model card within your organization.
`ModelCard`	`withModelCardStatus (String modelCardStatus)` The approval status of the model card within your organization.
`ModelCard`	`withModelCardVersion (Integer modelCardVersion)` The version of the model card.
`ModelCard`	`withModelId (String modelId)` The unique name (ID) of the model.
`ModelCard`	`withModelPackageGroupName (String modelPackageGroupName)` The model package group that contains the model package.
`ModelCard`	`withRiskRating (String riskRating)` The risk rating of the model.
`ModelCard`	`withSecurityConfig (ModelCardSecurityConfig securityConfig)` The security configuration used to protect model card data.
`ModelCard`	`withTags (Collection<Tag> tags)` Key-value pairs used to manage metadata for the model card.
`ModelCard`	`withTags (Tag... tags)` Key-value pairs used to manage metadata for the model card.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ModelCard
```
public ModelCard()
```
- Method Detail
  - setModelCardArn
```
public void setModelCardArn(String modelCardArn)
```
    The Amazon Resource Name (ARN) of the model card.
    
    Parameters:
    
    modelCardArn - The Amazon Resource Name (ARN) of the model card.
  - getModelCardArn
```
public String getModelCardArn()
```
    The Amazon Resource Name (ARN) of the model card.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the model card.
  - withModelCardArn
```
public ModelCard withModelCardArn(String modelCardArn)
```
    The Amazon Resource Name (ARN) of the model card.
    
    Parameters:
    
    modelCardArn - The Amazon Resource Name (ARN) of the model card.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModelCardName
```
public void setModelCardName(String modelCardName)
```
    The unique name of the model card.
    
    Parameters:
    
    modelCardName - The unique name of the model card.
  - getModelCardName
```
public String getModelCardName()
```
    The unique name of the model card.
    
    Returns:
    
    The unique name of the model card.
  - withModelCardName
```
public ModelCard withModelCardName(String modelCardName)
```
    The unique name of the model card.
    
    Parameters:
    
    modelCardName - The unique name of the model card.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModelCardVersion
```
public void setModelCardVersion(Integer modelCardVersion)
```
    The version of the model card.
    
    Parameters:
    
    modelCardVersion - The version of the model card.
  - getModelCardVersion
```
public Integer getModelCardVersion()
```
    The version of the model card.
    
    Returns:
    
    The version of the model card.
  - withModelCardVersion
```
public ModelCard withModelCardVersion(Integer modelCardVersion)
```
    The version of the model card.
    
    Parameters:
    
    modelCardVersion - The version of the model card.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContent
```
public void setContent(String content)
```
    The content of the model card. Content uses the model card JSON schema and provided as a string.
    
    Parameters:
    
    content - The content of the model card. Content uses the model card JSON schema and provided as a string.
  - getContent
```
public String getContent()
```
    The content of the model card. Content uses the model card JSON schema and provided as a string.
    
    Returns:
    
    The content of the model card. Content uses the model card JSON schema and provided as a string.
  - withContent
```
public ModelCard withContent(String content)
```
    The content of the model card. Content uses the model card JSON schema and provided as a string.
    
    Parameters:
    
    content - The content of the model card. Content uses the model card JSON schema and provided as a string.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModelCardStatus
```
public void setModelCardStatus(String modelCardStatus)
```
    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.
    Parameters:
    modelCardStatus - 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.
    See Also:
    
    ModelCardStatus
  - getModelCardStatus
```
public String getModelCardStatus()
```
    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:
    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.
    See Also:
    
    ModelCardStatus
  - withModelCardStatus
```
public ModelCard withModelCardStatus(String modelCardStatus)
```
    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.
    Parameters:
    modelCardStatus - 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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ModelCardStatus
  - withModelCardStatus
```
public ModelCard withModelCardStatus(ModelCardStatus modelCardStatus)
```
    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.
    Parameters:
    modelCardStatus - 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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ModelCardStatus
  - setSecurityConfig
```
public void setSecurityConfig(ModelCardSecurityConfig securityConfig)
```
    The security configuration used to protect model card data.
    
    Parameters:
    
    securityConfig - The security configuration used to protect model card data.
  - getSecurityConfig
```
public ModelCardSecurityConfig getSecurityConfig()
```
    The security configuration used to protect model card data.
    
    Returns:
    
    The security configuration used to protect model card data.
  - withSecurityConfig
```
public ModelCard withSecurityConfig(ModelCardSecurityConfig securityConfig)
```
    The security configuration used to protect model card data.
    
    Parameters:
    
    securityConfig - The security configuration used to protect model card data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The date and time that the model card was created.
    
    Parameters:
    
    creationTime - The date and time that the model card was created.
  - getCreationTime
```
public Date getCreationTime()
```
    The date and time that the model card was created.
    
    Returns:
    
    The date and time that the model card was created.
  - withCreationTime
```
public ModelCard withCreationTime(Date creationTime)
```
    The date and time that the model card was created.
    
    Parameters:
    
    creationTime - The date and time that the model card was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedBy
```
public void setCreatedBy(UserContext createdBy)
```
    Parameters:
    
    createdBy -
  - getCreatedBy
```
public UserContext getCreatedBy()
```
    Returns:
  - withCreatedBy
```
public ModelCard withCreatedBy(UserContext createdBy)
```
    Parameters:
    
    createdBy -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedTime
```
public void setLastModifiedTime(Date lastModifiedTime)
```
    The date and time that the model card was last modified.
    
    Parameters:
    
    lastModifiedTime - The date and time that the model card was last modified.
  - getLastModifiedTime
```
public Date getLastModifiedTime()
```
    The date and time that the model card was last modified.
    
    Returns:
    
    The date and time that the model card was last modified.
  - withLastModifiedTime
```
public ModelCard withLastModifiedTime(Date lastModifiedTime)
```
    The date and time that the model card was last modified.
    
    Parameters:
    
    lastModifiedTime - The date and time that the model card was last modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedBy
```
public void setLastModifiedBy(UserContext lastModifiedBy)
```
    Parameters:
    
    lastModifiedBy -
  - getLastModifiedBy
```
public UserContext getLastModifiedBy()
```
    Returns:
  - withLastModifiedBy
```
public ModelCard withLastModifiedBy(UserContext lastModifiedBy)
```
    Parameters:
    
    lastModifiedBy -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    Key-value pairs used to manage metadata for the model card.
    
    Returns:
    
    Key-value pairs used to manage metadata for the model card.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    Key-value pairs used to manage metadata for the model card.
    
    Parameters:
    
    tags - Key-value pairs used to manage metadata for the model card.
  - withTags
```
public ModelCard withTags(Tag... tags)
```
    Key-value pairs used to manage metadata for the model card.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - Key-value pairs used to manage metadata for the model card.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public ModelCard withTags(Collection<Tag> tags)
```
    Key-value pairs used to manage metadata for the model card.
    
    Parameters:
    
    tags - Key-value pairs used to manage metadata for the model card.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModelId
```
public void setModelId(String modelId)
```
    The unique name (ID) of the model.
    
    Parameters:
    
    modelId - The unique name (ID) of the model.
  - getModelId
```
public String getModelId()
```
    The unique name (ID) of the model.
    
    Returns:
    
    The unique name (ID) of the model.
  - withModelId
```
public ModelCard withModelId(String modelId)
```
    The unique name (ID) of the model.
    
    Parameters:
    
    modelId - The unique name (ID) of the model.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRiskRating
```
public void setRiskRating(String riskRating)
```
    The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.
    
    Parameters:
    
    riskRating - The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.
  - getRiskRating
```
public String getRiskRating()
```
    The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.
    
    Returns:
    
    The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.
  - withRiskRating
```
public ModelCard withRiskRating(String riskRating)
```
    The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.
    
    Parameters:
    
    riskRating - The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModelPackageGroupName
```
public void setModelPackageGroupName(String modelPackageGroupName)
```
    The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry.
    
    Parameters:
    
    modelPackageGroupName - The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry.
  - getModelPackageGroupName
```
public String getModelPackageGroupName()
```
    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:
    
    The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry.
  - withModelPackageGroupName
```
public ModelCard withModelPackageGroupName(String modelPackageGroupName)
```
    The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry.
    
    Parameters:
    
    modelPackageGroupName - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ModelCard clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class ModelCard

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ModelCard

Method Detail

setModelCardArn

getModelCardArn

withModelCardArn

setModelCardName

getModelCardName

withModelCardName

setModelCardVersion

getModelCardVersion

withModelCardVersion

setContent

getContent

withContent

setModelCardStatus

getModelCardStatus

withModelCardStatus

withModelCardStatus

setSecurityConfig

getSecurityConfig

withSecurityConfig

setCreationTime

getCreationTime

withCreationTime

setCreatedBy

getCreatedBy

withCreatedBy

setLastModifiedTime

getLastModifiedTime

withLastModifiedTime

setLastModifiedBy

getLastModifiedBy

withLastModifiedBy

getTags

setTags

withTags

withTags

setModelId

getModelId

withModelId

setRiskRating

getRiskRating

withRiskRating

setModelPackageGroupName

getModelPackageGroupName

withModelPackageGroupName

toString

equals

hashCode

clone

marshall