ModelPackage (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 ModelPackage

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ModelPackage
extends Object
implements Serializable, Cloneable, StructuredPojo 
```
A versioned model that can be deployed for SageMaker inference.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ModelPackage ()

Constructors
Constructor and Description
`ModelPackage ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`ModelPackage`	`addCustomerMetadataPropertiesEntry (String key, String value)` Add a single CustomerMetadataProperties entry
`ModelPackage`	`clearCustomerMetadataPropertiesEntries ()` Removes all the entries added into CustomerMetadataProperties.
`ModelPackage`	`clone ()`
`boolean`	`equals (Object obj)`
`List<AdditionalInferenceSpecificationDefinition>`	`getAdditionalInferenceSpecifications ()` An array of additional Inference Specification objects.
`String`	`getApprovalDescription ()` A description provided when the model approval is set.
`Boolean`	`getCertifyForMarketplace ()` Whether the model package is to be certified to be listed on Amazon Web Services Marketplace.
`UserContext`	`getCreatedBy ()` Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
`Date`	`getCreationTime ()` The time that the model package was created.
`Map<String,String>`	`getCustomerMetadataProperties ()` The metadata properties for the model package.
`String`	`getDomain ()` The machine learning domain of your model package and its components.
`DriftCheckBaselines`	`getDriftCheckBaselines ()` Represents the drift check baselines that can be used when the model monitor is set using the model package.
`InferenceSpecification`	`getInferenceSpecification ()` Defines how to perform inference generation after a training job is run.
`UserContext`	`getLastModifiedBy ()` Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
`Date`	`getLastModifiedTime ()` The last time the model package was modified.
`MetadataProperties`	`getMetadataProperties ()` Metadata properties of the tracking entity, trial, or trial component.
`String`	`getModelApprovalStatus ()` The approval status of the model.
`ModelPackageModelCard`	`getModelCard ()`
`ModelMetrics`	`getModelMetrics ()` Metrics for the model.
`String`	`getModelPackageArn ()` The Amazon Resource Name (ARN) of the model package.
`String`	`getModelPackageDescription ()` The description of the model package.
`String`	`getModelPackageGroupName ()` The model group to which the model belongs.
`String`	`getModelPackageName ()` The name of the model.
`String`	`getModelPackageStatus ()` The status of the model package.
`ModelPackageStatusDetails`	`getModelPackageStatusDetails ()` Specifies the validation and image scan statuses of the model package.
`Integer`	`getModelPackageVersion ()` The version number of a versioned model.
`String`	`getSamplePayloadUrl ()` The Amazon Simple Storage Service path where the sample payload are stored.
`ModelPackageSecurityConfig`	`getSecurityConfig ()`
`String`	`getSkipModelValidation ()` Indicates if you want to skip model validation.
`SourceAlgorithmSpecification`	`getSourceAlgorithmSpecification ()` A list of algorithms that were used to create a model package.
`String`	`getSourceUri ()` The URI of the source for the model package.
`List<Tag>`	`getTags ()` A list of the tags associated with the model package.
`String`	`getTask ()` The machine learning task your model package accomplishes.
`ModelPackageValidationSpecification`	`getValidationSpecification ()` Specifies batch transform jobs that SageMaker runs to validate your model package.
`int`	`hashCode ()`
`Boolean`	`isCertifyForMarketplace ()` Whether the model package is to be certified to be listed on Amazon Web Services Marketplace.
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAdditionalInferenceSpecifications (Collection<AdditionalInferenceSpecificationDefinition> additionalInferenceSpecifications)` An array of additional Inference Specification objects.
`void`	`setApprovalDescription (String approvalDescription)` A description provided when the model approval is set.
`void`	`setCertifyForMarketplace (Boolean certifyForMarketplace)` Whether the model package is to be certified to be listed on Amazon Web Services Marketplace.
`void`	`setCreatedBy (UserContext createdBy)` Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
`void`	`setCreationTime (Date creationTime)` The time that the model package was created.
`void`	`setCustomerMetadataProperties (Map<String,String> customerMetadataProperties)` The metadata properties for the model package.
`void`	`setDomain (String domain)` The machine learning domain of your model package and its components.
`void`	`setDriftCheckBaselines (DriftCheckBaselines driftCheckBaselines)` Represents the drift check baselines that can be used when the model monitor is set using the model package.
`void`	`setInferenceSpecification (InferenceSpecification inferenceSpecification)` Defines how to perform inference generation after a training job is run.
`void`	`setLastModifiedBy (UserContext lastModifiedBy)` Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
`void`	`setLastModifiedTime (Date lastModifiedTime)` The last time the model package was modified.
`void`	`setMetadataProperties (MetadataProperties metadataProperties)` Metadata properties of the tracking entity, trial, or trial component.
`void`	`setModelApprovalStatus (String modelApprovalStatus)` The approval status of the model.
`void`	`setModelCard (ModelPackageModelCard modelCard)`
`void`	`setModelMetrics (ModelMetrics modelMetrics)` Metrics for the model.
`void`	`setModelPackageArn (String modelPackageArn)` The Amazon Resource Name (ARN) of the model package.
`void`	`setModelPackageDescription (String modelPackageDescription)` The description of the model package.
`void`	`setModelPackageGroupName (String modelPackageGroupName)` The model group to which the model belongs.
`void`	`setModelPackageName (String modelPackageName)` The name of the model.
`void`	`setModelPackageStatus (String modelPackageStatus)` The status of the model package.
`void`	`setModelPackageStatusDetails (ModelPackageStatusDetails modelPackageStatusDetails)` Specifies the validation and image scan statuses of the model package.
`void`	`setModelPackageVersion (Integer modelPackageVersion)` The version number of a versioned model.
`void`	`setSamplePayloadUrl (String samplePayloadUrl)` The Amazon Simple Storage Service path where the sample payload are stored.
`void`	`setSecurityConfig (ModelPackageSecurityConfig securityConfig)`
`void`	`setSkipModelValidation (String skipModelValidation)` Indicates if you want to skip model validation.
`void`	`setSourceAlgorithmSpecification (SourceAlgorithmSpecification sourceAlgorithmSpecification)` A list of algorithms that were used to create a model package.
`void`	`setSourceUri (String sourceUri)` The URI of the source for the model package.
`void`	`setTags (Collection<Tag> tags)` A list of the tags associated with the model package.
`void`	`setTask (String task)` The machine learning task your model package accomplishes.
`void`	`setValidationSpecification (ModelPackageValidationSpecification validationSpecification)` Specifies batch transform jobs that SageMaker runs to validate your model package.
`String`	`toString ()` Returns a string representation of this object.
`ModelPackage`	`withAdditionalInferenceSpecifications (AdditionalInferenceSpecificationDefinition... additionalInferenceSpecifications)` An array of additional Inference Specification objects.
`ModelPackage`	`withAdditionalInferenceSpecifications (Collection<AdditionalInferenceSpecificationDefinition> additionalInferenceSpecifications)` An array of additional Inference Specification objects.
`ModelPackage`	`withApprovalDescription (String approvalDescription)` A description provided when the model approval is set.
`ModelPackage`	`withCertifyForMarketplace (Boolean certifyForMarketplace)` Whether the model package is to be certified to be listed on Amazon Web Services Marketplace.
`ModelPackage`	`withCreatedBy (UserContext createdBy)` Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
`ModelPackage`	`withCreationTime (Date creationTime)` The time that the model package was created.
`ModelPackage`	`withCustomerMetadataProperties (Map<String,String> customerMetadataProperties)` The metadata properties for the model package.
`ModelPackage`	`withDomain (String domain)` The machine learning domain of your model package and its components.
`ModelPackage`	`withDriftCheckBaselines (DriftCheckBaselines driftCheckBaselines)` Represents the drift check baselines that can be used when the model monitor is set using the model package.
`ModelPackage`	`withInferenceSpecification (InferenceSpecification inferenceSpecification)` Defines how to perform inference generation after a training job is run.
`ModelPackage`	`withLastModifiedBy (UserContext lastModifiedBy)` Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
`ModelPackage`	`withLastModifiedTime (Date lastModifiedTime)` The last time the model package was modified.
`ModelPackage`	`withMetadataProperties (MetadataProperties metadataProperties)` Metadata properties of the tracking entity, trial, or trial component.
`ModelPackage`	`withModelApprovalStatus (ModelApprovalStatus modelApprovalStatus)` The approval status of the model.
`ModelPackage`	`withModelApprovalStatus (String modelApprovalStatus)` The approval status of the model.
`ModelPackage`	`withModelCard (ModelPackageModelCard modelCard)`
`ModelPackage`	`withModelMetrics (ModelMetrics modelMetrics)` Metrics for the model.
`ModelPackage`	`withModelPackageArn (String modelPackageArn)` The Amazon Resource Name (ARN) of the model package.
`ModelPackage`	`withModelPackageDescription (String modelPackageDescription)` The description of the model package.
`ModelPackage`	`withModelPackageGroupName (String modelPackageGroupName)` The model group to which the model belongs.
`ModelPackage`	`withModelPackageName (String modelPackageName)` The name of the model.
`ModelPackage`	`withModelPackageStatus (ModelPackageStatus modelPackageStatus)` The status of the model package.
`ModelPackage`	`withModelPackageStatus (String modelPackageStatus)` The status of the model package.
`ModelPackage`	`withModelPackageStatusDetails (ModelPackageStatusDetails modelPackageStatusDetails)` Specifies the validation and image scan statuses of the model package.
`ModelPackage`	`withModelPackageVersion (Integer modelPackageVersion)` The version number of a versioned model.
`ModelPackage`	`withSamplePayloadUrl (String samplePayloadUrl)` The Amazon Simple Storage Service path where the sample payload are stored.
`ModelPackage`	`withSecurityConfig (ModelPackageSecurityConfig securityConfig)`
`ModelPackage`	`withSkipModelValidation (SkipModelValidation skipModelValidation)` Indicates if you want to skip model validation.
`ModelPackage`	`withSkipModelValidation (String skipModelValidation)` Indicates if you want to skip model validation.
`ModelPackage`	`withSourceAlgorithmSpecification (SourceAlgorithmSpecification sourceAlgorithmSpecification)` A list of algorithms that were used to create a model package.
`ModelPackage`	`withSourceUri (String sourceUri)` The URI of the source for the model package.
`ModelPackage`	`withTags (Collection<Tag> tags)` A list of the tags associated with the model package.
`ModelPackage`	`withTags (Tag... tags)` A list of the tags associated with the model package.
`ModelPackage`	`withTask (String task)` The machine learning task your model package accomplishes.
`ModelPackage`	`withValidationSpecification (ModelPackageValidationSpecification validationSpecification)` Specifies batch transform jobs that SageMaker runs to validate your model package.

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

- Constructor Detail
  - ModelPackage
```
public ModelPackage()
```
- Method Detail
  - setModelPackageName
```
public void setModelPackageName(String modelPackageName)
```
    The name of the model.
    
    Parameters:
    
    modelPackageName - The name of the model.
  - getModelPackageName
```
public String getModelPackageName()
```
    The name of the model.
    
    Returns:
    
    The name of the model.
  - withModelPackageName
```
public ModelPackage withModelPackageName(String modelPackageName)
```
    The name of the model.
    
    Parameters:
    
    modelPackageName - The name of the model.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModelPackageGroupName
```
public void setModelPackageGroupName(String modelPackageGroupName)
```
    The model group to which the model belongs.
    
    Parameters:
    
    modelPackageGroupName - The model group to which the model belongs.
  - getModelPackageGroupName
```
public String getModelPackageGroupName()
```
    The model group to which the model belongs.
    
    Returns:
    
    The model group to which the model belongs.
  - withModelPackageGroupName
```
public ModelPackage withModelPackageGroupName(String modelPackageGroupName)
```
    The model group to which the model belongs.
    
    Parameters:
    
    modelPackageGroupName - The model group to which the model belongs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModelPackageVersion
```
public void setModelPackageVersion(Integer modelPackageVersion)
```
    The version number of a versioned model.
    
    Parameters:
    
    modelPackageVersion - The version number of a versioned model.
  - getModelPackageVersion
```
public Integer getModelPackageVersion()
```
    The version number of a versioned model.
    
    Returns:
    
    The version number of a versioned model.
  - withModelPackageVersion
```
public ModelPackage withModelPackageVersion(Integer modelPackageVersion)
```
    The version number of a versioned model.
    
    Parameters:
    
    modelPackageVersion - The version number of a versioned model.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModelPackageArn
```
public void setModelPackageArn(String modelPackageArn)
```
    The Amazon Resource Name (ARN) of the model package.
    
    Parameters:
    
    modelPackageArn - The Amazon Resource Name (ARN) of the model package.
  - getModelPackageArn
```
public String getModelPackageArn()
```
    The Amazon Resource Name (ARN) of the model package.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the model package.
  - withModelPackageArn
```
public ModelPackage withModelPackageArn(String modelPackageArn)
```
    The Amazon Resource Name (ARN) of the model package.
    
    Parameters:
    
    modelPackageArn - The Amazon Resource Name (ARN) of the model package.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModelPackageDescription
```
public void setModelPackageDescription(String modelPackageDescription)
```
    The description of the model package.
    
    Parameters:
    
    modelPackageDescription - The description of the model package.
  - getModelPackageDescription
```
public String getModelPackageDescription()
```
    The description of the model package.
    
    Returns:
    
    The description of the model package.
  - withModelPackageDescription
```
public ModelPackage withModelPackageDescription(String modelPackageDescription)
```
    The description of the model package.
    
    Parameters:
    
    modelPackageDescription - The description of the model package.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The time that the model package was created.
    
    Parameters:
    
    creationTime - The time that the model package was created.
  - getCreationTime
```
public Date getCreationTime()
```
    The time that the model package was created.
    
    Returns:
    
    The time that the model package was created.
  - withCreationTime
```
public ModelPackage withCreationTime(Date creationTime)
```
    The time that the model package was created.
    
    Parameters:
    
    creationTime - The time that the model package was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInferenceSpecification
```
public void setInferenceSpecification(InferenceSpecification inferenceSpecification)
```
    Defines how to perform inference generation after a training job is run.
    
    Parameters:
    
    inferenceSpecification - Defines how to perform inference generation after a training job is run.
  - getInferenceSpecification
```
public InferenceSpecification getInferenceSpecification()
```
    Defines how to perform inference generation after a training job is run.
    
    Returns:
    
    Defines how to perform inference generation after a training job is run.
  - withInferenceSpecification
```
public ModelPackage withInferenceSpecification(InferenceSpecification inferenceSpecification)
```
    Defines how to perform inference generation after a training job is run.
    
    Parameters:
    
    inferenceSpecification - Defines how to perform inference generation after a training job is run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceAlgorithmSpecification
```
public void setSourceAlgorithmSpecification(SourceAlgorithmSpecification sourceAlgorithmSpecification)
```
    A list of algorithms that were used to create a model package.
    
    Parameters:
    
    sourceAlgorithmSpecification - A list of algorithms that were used to create a model package.
  - getSourceAlgorithmSpecification
```
public SourceAlgorithmSpecification getSourceAlgorithmSpecification()
```
    A list of algorithms that were used to create a model package.
    
    Returns:
    
    A list of algorithms that were used to create a model package.
  - withSourceAlgorithmSpecification
```
public ModelPackage withSourceAlgorithmSpecification(SourceAlgorithmSpecification sourceAlgorithmSpecification)
```
    A list of algorithms that were used to create a model package.
    
    Parameters:
    
    sourceAlgorithmSpecification - A list of algorithms that were used to create a model package.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setValidationSpecification
```
public void setValidationSpecification(ModelPackageValidationSpecification validationSpecification)
```
    Specifies batch transform jobs that SageMaker runs to validate your model package.
    
    Parameters:
    
    validationSpecification - Specifies batch transform jobs that SageMaker runs to validate your model package.
  - getValidationSpecification
```
public ModelPackageValidationSpecification getValidationSpecification()
```
    Specifies batch transform jobs that SageMaker runs to validate your model package.
    
    Returns:
    
    Specifies batch transform jobs that SageMaker runs to validate your model package.
  - withValidationSpecification
```
public ModelPackage withValidationSpecification(ModelPackageValidationSpecification validationSpecification)
```
    Specifies batch transform jobs that SageMaker runs to validate your model package.
    
    Parameters:
    
    validationSpecification - Specifies batch transform jobs that SageMaker runs to validate your model package.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModelPackageStatus
```
public void setModelPackageStatus(String modelPackageStatus)
```
    The status of the model package. This can be one of the following values.
    - PENDING - The model package is pending being created.
    - IN_PROGRESS - The model package is in the process of being created.
    - COMPLETED - The model package was successfully created.
    - FAILED - The model package failed.
    - DELETING - The model package is in the process of being deleted.
    Parameters:
    modelPackageStatus - The status of the model package. This can be one of the following values.
    
    PENDING - The model package is pending being created.
    
    IN_PROGRESS - The model package is in the process of being created.
    
    COMPLETED - The model package was successfully created.
    
    FAILED - The model package failed.
    
    DELETING - The model package is in the process of being deleted.
    See Also:
    
    ModelPackageStatus
  - getModelPackageStatus
```
public String getModelPackageStatus()
```
    The status of the model package. This can be one of the following values.
    - PENDING - The model package is pending being created.
    - IN_PROGRESS - The model package is in the process of being created.
    - COMPLETED - The model package was successfully created.
    - FAILED - The model package failed.
    - DELETING - The model package is in the process of being deleted.
    Returns:
    The status of the model package. This can be one of the following values.
    
    PENDING - The model package is pending being created.
    
    IN_PROGRESS - The model package is in the process of being created.
    
    COMPLETED - The model package was successfully created.
    
    FAILED - The model package failed.
    
    DELETING - The model package is in the process of being deleted.
    See Also:
    
    ModelPackageStatus
  - withModelPackageStatus
```
public ModelPackage withModelPackageStatus(String modelPackageStatus)
```
    The status of the model package. This can be one of the following values.
    - PENDING - The model package is pending being created.
    - IN_PROGRESS - The model package is in the process of being created.
    - COMPLETED - The model package was successfully created.
    - FAILED - The model package failed.
    - DELETING - The model package is in the process of being deleted.
    Parameters:
    modelPackageStatus - The status of the model package. This can be one of the following values.
    
    PENDING - The model package is pending being created.
    
    IN_PROGRESS - The model package is in the process of being created.
    
    COMPLETED - The model package was successfully created.
    
    FAILED - The model package failed.
    
    DELETING - The model package is in the process of being deleted.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ModelPackageStatus
  - withModelPackageStatus
```
public ModelPackage withModelPackageStatus(ModelPackageStatus modelPackageStatus)
```
    The status of the model package. This can be one of the following values.
    - PENDING - The model package is pending being created.
    - IN_PROGRESS - The model package is in the process of being created.
    - COMPLETED - The model package was successfully created.
    - FAILED - The model package failed.
    - DELETING - The model package is in the process of being deleted.
    Parameters:
    modelPackageStatus - The status of the model package. This can be one of the following values.
    
    PENDING - The model package is pending being created.
    
    IN_PROGRESS - The model package is in the process of being created.
    
    COMPLETED - The model package was successfully created.
    
    FAILED - The model package failed.
    
    DELETING - The model package is in the process of being deleted.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ModelPackageStatus
  - setModelPackageStatusDetails
```
public void setModelPackageStatusDetails(ModelPackageStatusDetails modelPackageStatusDetails)
```
    Specifies the validation and image scan statuses of the model package.
    
    Parameters:
    
    modelPackageStatusDetails - Specifies the validation and image scan statuses of the model package.
  - getModelPackageStatusDetails
```
public ModelPackageStatusDetails getModelPackageStatusDetails()
```
    Specifies the validation and image scan statuses of the model package.
    
    Returns:
    
    Specifies the validation and image scan statuses of the model package.
  - withModelPackageStatusDetails
```
public ModelPackage withModelPackageStatusDetails(ModelPackageStatusDetails modelPackageStatusDetails)
```
    Specifies the validation and image scan statuses of the model package.
    
    Parameters:
    
    modelPackageStatusDetails - Specifies the validation and image scan statuses of the model package.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCertifyForMarketplace
```
public void setCertifyForMarketplace(Boolean certifyForMarketplace)
```
    Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For information about listing model packages on Amazon Web Services Marketplace, see List Your Algorithm or Model Package on Amazon Web Services Marketplace.
    
    Parameters:
    
    certifyForMarketplace - Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For information about listing model packages on Amazon Web Services Marketplace, see List Your Algorithm or Model Package on Amazon Web Services Marketplace.
  - getCertifyForMarketplace
```
public Boolean getCertifyForMarketplace()
```
    Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For information about listing model packages on Amazon Web Services Marketplace, see List Your Algorithm or Model Package on Amazon Web Services Marketplace.
    
    Returns:
    
    Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For information about listing model packages on Amazon Web Services Marketplace, see List Your Algorithm or Model Package on Amazon Web Services Marketplace.
  - withCertifyForMarketplace
```
public ModelPackage withCertifyForMarketplace(Boolean certifyForMarketplace)
```
    Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For information about listing model packages on Amazon Web Services Marketplace, see List Your Algorithm or Model Package on Amazon Web Services Marketplace.
    
    Parameters:
    
    certifyForMarketplace - Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For information about listing model packages on Amazon Web Services Marketplace, see List Your Algorithm or Model Package on Amazon Web Services Marketplace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isCertifyForMarketplace
```
public Boolean isCertifyForMarketplace()
```
    Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For information about listing model packages on Amazon Web Services Marketplace, see List Your Algorithm or Model Package on Amazon Web Services Marketplace.
    
    Returns:
    
    Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For information about listing model packages on Amazon Web Services Marketplace, see List Your Algorithm or Model Package on Amazon Web Services Marketplace.
  - setModelApprovalStatus
```
public void setModelApprovalStatus(String modelApprovalStatus)
```
    The approval status of the model. This can be one of the following values.
    - APPROVED - The model is approved
    - REJECTED - The model is rejected.
    - PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.
    Parameters:
    modelApprovalStatus - The approval status of the model. This can be one of the following values.
    
    APPROVED - The model is approved
    
    REJECTED - The model is rejected.
    
    PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.
    See Also:
    
    ModelApprovalStatus
  - getModelApprovalStatus
```
public String getModelApprovalStatus()
```
    The approval status of the model. This can be one of the following values.
    - APPROVED - The model is approved
    - REJECTED - The model is rejected.
    - PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.
    Returns:
    The approval status of the model. This can be one of the following values.
    
    APPROVED - The model is approved
    
    REJECTED - The model is rejected.
    
    PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.
    See Also:
    
    ModelApprovalStatus
  - withModelApprovalStatus
```
public ModelPackage withModelApprovalStatus(String modelApprovalStatus)
```
    The approval status of the model. This can be one of the following values.
    - APPROVED - The model is approved
    - REJECTED - The model is rejected.
    - PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.
    Parameters:
    modelApprovalStatus - The approval status of the model. This can be one of the following values.
    
    APPROVED - The model is approved
    
    REJECTED - The model is rejected.
    
    PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ModelApprovalStatus
  - withModelApprovalStatus
```
public ModelPackage withModelApprovalStatus(ModelApprovalStatus modelApprovalStatus)
```
    The approval status of the model. This can be one of the following values.
    - APPROVED - The model is approved
    - REJECTED - The model is rejected.
    - PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.
    Parameters:
    modelApprovalStatus - The approval status of the model. This can be one of the following values.
    
    APPROVED - The model is approved
    
    REJECTED - The model is rejected.
    
    PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ModelApprovalStatus
  - setCreatedBy
```
public void setCreatedBy(UserContext createdBy)
```
    Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
    
    Parameters:
    
    createdBy - Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
  - getCreatedBy
```
public UserContext getCreatedBy()
```
    Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
    
    Returns:
    
    Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
  - withCreatedBy
```
public ModelPackage withCreatedBy(UserContext createdBy)
```
    Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
    
    Parameters:
    
    createdBy - Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetadataProperties
```
public void setMetadataProperties(MetadataProperties metadataProperties)
```
    Metadata properties of the tracking entity, trial, or trial component.
    
    Parameters:
    
    metadataProperties - Metadata properties of the tracking entity, trial, or trial component.
  - getMetadataProperties
```
public MetadataProperties getMetadataProperties()
```
    Metadata properties of the tracking entity, trial, or trial component.
    
    Returns:
    
    Metadata properties of the tracking entity, trial, or trial component.
  - withMetadataProperties
```
public ModelPackage withMetadataProperties(MetadataProperties metadataProperties)
```
    Metadata properties of the tracking entity, trial, or trial component.
    
    Parameters:
    
    metadataProperties - Metadata properties of the tracking entity, trial, or trial component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModelMetrics
```
public void setModelMetrics(ModelMetrics modelMetrics)
```
    Metrics for the model.
    
    Parameters:
    
    modelMetrics - Metrics for the model.
  - getModelMetrics
```
public ModelMetrics getModelMetrics()
```
    Metrics for the model.
    
    Returns:
    
    Metrics for the model.
  - withModelMetrics
```
public ModelPackage withModelMetrics(ModelMetrics modelMetrics)
```
    Metrics for the model.
    
    Parameters:
    
    modelMetrics - Metrics for the model.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedTime
```
public void setLastModifiedTime(Date lastModifiedTime)
```
    The last time the model package was modified.
    
    Parameters:
    
    lastModifiedTime - The last time the model package was modified.
  - getLastModifiedTime
```
public Date getLastModifiedTime()
```
    The last time the model package was modified.
    
    Returns:
    
    The last time the model package was modified.
  - withLastModifiedTime
```
public ModelPackage withLastModifiedTime(Date lastModifiedTime)
```
    The last time the model package was modified.
    
    Parameters:
    
    lastModifiedTime - The last time the model package was modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedBy
```
public void setLastModifiedBy(UserContext lastModifiedBy)
```
    Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
    
    Parameters:
    
    lastModifiedBy - Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
  - getLastModifiedBy
```
public UserContext getLastModifiedBy()
```
    Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
    
    Returns:
    
    Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
  - withLastModifiedBy
```
public ModelPackage withLastModifiedBy(UserContext lastModifiedBy)
```
    Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
    
    Parameters:
    
    lastModifiedBy - Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setApprovalDescription
```
public void setApprovalDescription(String approvalDescription)
```
    A description provided when the model approval is set.
    
    Parameters:
    
    approvalDescription - A description provided when the model approval is set.
  - getApprovalDescription
```
public String getApprovalDescription()
```
    A description provided when the model approval is set.
    
    Returns:
    
    A description provided when the model approval is set.
  - withApprovalDescription
```
public ModelPackage withApprovalDescription(String approvalDescription)
```
    A description provided when the model approval is set.
    
    Parameters:
    
    approvalDescription - A description provided when the model approval is set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDomain
```
public void setDomain(String domain)
```
    The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.
    
    Parameters:
    
    domain - The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.
  - getDomain
```
public String getDomain()
```
    The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.
    
    Returns:
    
    The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.
  - withDomain
```
public ModelPackage withDomain(String domain)
```
    The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.
    
    Parameters:
    
    domain - The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTask
```
public void setTask(String task)
```
    The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.
    
    Parameters:
    
    task - The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.
  - getTask
```
public String getTask()
```
    The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.
    
    Returns:
    
    The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.
  - withTask
```
public ModelPackage withTask(String task)
```
    The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.
    
    Parameters:
    
    task - The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSamplePayloadUrl
```
public void setSamplePayloadUrl(String samplePayloadUrl)
```
    The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
    
    Parameters:
    
    samplePayloadUrl - The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
  - getSamplePayloadUrl
```
public String getSamplePayloadUrl()
```
    The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
    
    Returns:
    
    The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
  - withSamplePayloadUrl
```
public ModelPackage withSamplePayloadUrl(String samplePayloadUrl)
```
    The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
    
    Parameters:
    
    samplePayloadUrl - The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAdditionalInferenceSpecifications
```
public List<AdditionalInferenceSpecificationDefinition> getAdditionalInferenceSpecifications()
```
    An array of additional Inference Specification objects.
    
    Returns:
    
    An array of additional Inference Specification objects.
  - setAdditionalInferenceSpecifications
```
public void setAdditionalInferenceSpecifications(Collection<AdditionalInferenceSpecificationDefinition> additionalInferenceSpecifications)
```
    An array of additional Inference Specification objects.
    
    Parameters:
    
    additionalInferenceSpecifications - An array of additional Inference Specification objects.
  - withAdditionalInferenceSpecifications
```
public ModelPackage withAdditionalInferenceSpecifications(AdditionalInferenceSpecificationDefinition... additionalInferenceSpecifications)
```
    An array of additional Inference Specification objects.
    
    NOTE: This method appends the values to the existing list (if any). Use setAdditionalInferenceSpecifications(java.util.Collection) or withAdditionalInferenceSpecifications(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    additionalInferenceSpecifications - An array of additional Inference Specification objects.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAdditionalInferenceSpecifications
```
public ModelPackage withAdditionalInferenceSpecifications(Collection<AdditionalInferenceSpecificationDefinition> additionalInferenceSpecifications)
```
    An array of additional Inference Specification objects.
    
    Parameters:
    
    additionalInferenceSpecifications - An array of additional Inference Specification objects.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceUri
```
public void setSourceUri(String sourceUri)
```
    The URI of the source for the model package.
    
    Parameters:
    
    sourceUri - The URI of the source for the model package.
  - getSourceUri
```
public String getSourceUri()
```
    The URI of the source for the model package.
    
    Returns:
    
    The URI of the source for the model package.
  - withSourceUri
```
public ModelPackage withSourceUri(String sourceUri)
```
    The URI of the source for the model package.
    
    Parameters:
    
    sourceUri - The URI of the source for the model package.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecurityConfig
```
public void setSecurityConfig(ModelPackageSecurityConfig securityConfig)
```
    Parameters:
    
    securityConfig -
  - getSecurityConfig
```
public ModelPackageSecurityConfig getSecurityConfig()
```
    Returns:
  - withSecurityConfig
```
public ModelPackage withSecurityConfig(ModelPackageSecurityConfig securityConfig)
```
    Parameters:
    
    securityConfig -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModelCard
```
public void setModelCard(ModelPackageModelCard modelCard)
```
    Parameters:
    
    modelCard -
  - getModelCard
```
public ModelPackageModelCard getModelCard()
```
    Returns:
  - withModelCard
```
public ModelPackage withModelCard(ModelPackageModelCard modelCard)
```
    Parameters:
    
    modelCard -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
    
    Returns:
    
    A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
    
    Parameters:
    
    tags - A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
  - withTags
```
public ModelPackage withTags(Tag... tags)
```
    A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
    
    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 - A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public ModelPackage withTags(Collection<Tag> tags)
```
    A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
    
    Parameters:
    
    tags - A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCustomerMetadataProperties
```
public Map<String,String> getCustomerMetadataProperties()
```
    The metadata properties for the model package.
    
    Returns:
    
    The metadata properties for the model package.
  - setCustomerMetadataProperties
```
public void setCustomerMetadataProperties(Map<String,String> customerMetadataProperties)
```
    The metadata properties for the model package.
    
    Parameters:
    
    customerMetadataProperties - The metadata properties for the model package.
  - withCustomerMetadataProperties
```
public ModelPackage withCustomerMetadataProperties(Map<String,String> customerMetadataProperties)
```
    The metadata properties for the model package.
    
    Parameters:
    
    customerMetadataProperties - The metadata properties for the model package.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addCustomerMetadataPropertiesEntry
```
public ModelPackage addCustomerMetadataPropertiesEntry(String key,
 String value)
```
    Add a single CustomerMetadataProperties entry
    
    See Also:
    
    withCustomerMetadataProperties(java.util.Map<java.lang.String, java.lang.String>)
  - clearCustomerMetadataPropertiesEntries
```
public ModelPackage clearCustomerMetadataPropertiesEntries()
```
    Removes all the entries added into CustomerMetadataProperties.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDriftCheckBaselines
```
public void setDriftCheckBaselines(DriftCheckBaselines driftCheckBaselines)
```
    Represents the drift check baselines that can be used when the model monitor is set using the model package.
    
    Parameters:
    
    driftCheckBaselines - Represents the drift check baselines that can be used when the model monitor is set using the model package.
  - getDriftCheckBaselines
```
public DriftCheckBaselines getDriftCheckBaselines()
```
    Represents the drift check baselines that can be used when the model monitor is set using the model package.
    
    Returns:
    
    Represents the drift check baselines that can be used when the model monitor is set using the model package.
  - withDriftCheckBaselines
```
public ModelPackage withDriftCheckBaselines(DriftCheckBaselines driftCheckBaselines)
```
    Represents the drift check baselines that can be used when the model monitor is set using the model package.
    
    Parameters:
    
    driftCheckBaselines - Represents the drift check baselines that can be used when the model monitor is set using the model package.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSkipModelValidation
```
public void setSkipModelValidation(String skipModelValidation)
```
    Indicates if you want to skip model validation.
    
    Parameters:
    
    skipModelValidation - Indicates if you want to skip model validation.
    
    See Also:
    
    SkipModelValidation
  - getSkipModelValidation
```
public String getSkipModelValidation()
```
    Indicates if you want to skip model validation.
    
    Returns:
    
    Indicates if you want to skip model validation.
    
    See Also:
    
    SkipModelValidation
  - withSkipModelValidation
```
public ModelPackage withSkipModelValidation(String skipModelValidation)
```
    Indicates if you want to skip model validation.
    
    Parameters:
    
    skipModelValidation - Indicates if you want to skip model validation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SkipModelValidation
  - withSkipModelValidation
```
public ModelPackage withSkipModelValidation(SkipModelValidation skipModelValidation)
```
    Indicates if you want to skip model validation.
    
    Parameters:
    
    skipModelValidation - Indicates if you want to skip model validation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SkipModelValidation
  - 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 ModelPackage 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 ModelPackage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ModelPackage

Method Detail

setModelPackageName

getModelPackageName

withModelPackageName

setModelPackageGroupName

getModelPackageGroupName

withModelPackageGroupName

setModelPackageVersion

getModelPackageVersion

withModelPackageVersion

setModelPackageArn

getModelPackageArn

withModelPackageArn

setModelPackageDescription

getModelPackageDescription

withModelPackageDescription

setCreationTime

getCreationTime

withCreationTime

setInferenceSpecification

getInferenceSpecification

withInferenceSpecification

setSourceAlgorithmSpecification

getSourceAlgorithmSpecification

withSourceAlgorithmSpecification

setValidationSpecification

getValidationSpecification

withValidationSpecification

setModelPackageStatus

getModelPackageStatus

withModelPackageStatus

withModelPackageStatus

setModelPackageStatusDetails

getModelPackageStatusDetails

withModelPackageStatusDetails

setCertifyForMarketplace

getCertifyForMarketplace

withCertifyForMarketplace

isCertifyForMarketplace

setModelApprovalStatus

getModelApprovalStatus

withModelApprovalStatus

withModelApprovalStatus

setCreatedBy

getCreatedBy

withCreatedBy

setMetadataProperties

getMetadataProperties

withMetadataProperties

setModelMetrics

getModelMetrics

withModelMetrics

setLastModifiedTime

getLastModifiedTime

withLastModifiedTime

setLastModifiedBy

getLastModifiedBy

withLastModifiedBy

setApprovalDescription

getApprovalDescription

withApprovalDescription

setDomain

getDomain

withDomain

setTask

getTask

withTask

setSamplePayloadUrl

getSamplePayloadUrl

withSamplePayloadUrl

getAdditionalInferenceSpecifications

setAdditionalInferenceSpecifications

withAdditionalInferenceSpecifications