com.amazonaws.services.sagemaker.model

Class UpdateModelPackageRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sagemaker.model.UpdateModelPackageRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateModelPackageRequest()

Method Summary

Modifier and Type	Method and Description
UpdateModelPackageRequest	addCustomerMetadataPropertiesEntry(String key, String value) Add a single CustomerMetadataProperties entry
UpdateModelPackageRequest	clearCustomerMetadataPropertiesEntries() Removes all the entries added into CustomerMetadataProperties.
UpdateModelPackageRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<AdditionalInferenceSpecificationDefinition>	getAdditionalInferenceSpecificationsToAdd() An array of additional Inference Specification objects to be added to the existing array additional Inference Specification.
String	getApprovalDescription() A description for the approval status of the model.
Map<String,String>	getCustomerMetadataProperties() The metadata properties associated with the model package versions.
List<String>	getCustomerMetadataPropertiesToRemove() The metadata properties associated with the model package versions to remove.
InferenceSpecification	getInferenceSpecification() Specifies details about inference jobs that you can run with models based on this model package, including the following information:
String	getModelApprovalStatus() The approval status of the model.
ModelPackageModelCard	getModelCard() The model card associated with the model package.
String	getModelPackageArn() The Amazon Resource Name (ARN) of the model package.
String	getSourceUri() The URI of the source for the model package.
int	hashCode()
void	setAdditionalInferenceSpecificationsToAdd(Collection<AdditionalInferenceSpecificationDefinition> additionalInferenceSpecificationsToAdd) An array of additional Inference Specification objects to be added to the existing array additional Inference Specification.
void	setApprovalDescription(String approvalDescription) A description for the approval status of the model.
void	setCustomerMetadataProperties(Map<String,String> customerMetadataProperties) The metadata properties associated with the model package versions.
void	setCustomerMetadataPropertiesToRemove(Collection<String> customerMetadataPropertiesToRemove) The metadata properties associated with the model package versions to remove.
void	setInferenceSpecification(InferenceSpecification inferenceSpecification) Specifies details about inference jobs that you can run with models based on this model package, including the following information:
void	setModelApprovalStatus(String modelApprovalStatus) The approval status of the model.
void	setModelCard(ModelPackageModelCard modelCard) The model card associated with the model package.
void	setModelPackageArn(String modelPackageArn) The Amazon Resource Name (ARN) of the model package.
void	setSourceUri(String sourceUri) The URI of the source for the model package.
String	toString() Returns a string representation of this object.
UpdateModelPackageRequest	withAdditionalInferenceSpecificationsToAdd(AdditionalInferenceSpecificationDefinition... additionalInferenceSpecificationsToAdd) An array of additional Inference Specification objects to be added to the existing array additional Inference Specification.
UpdateModelPackageRequest	withAdditionalInferenceSpecificationsToAdd(Collection<AdditionalInferenceSpecificationDefinition> additionalInferenceSpecificationsToAdd) An array of additional Inference Specification objects to be added to the existing array additional Inference Specification.
UpdateModelPackageRequest	withApprovalDescription(String approvalDescription) A description for the approval status of the model.
UpdateModelPackageRequest	withCustomerMetadataProperties(Map<String,String> customerMetadataProperties) The metadata properties associated with the model package versions.
UpdateModelPackageRequest	withCustomerMetadataPropertiesToRemove(Collection<String> customerMetadataPropertiesToRemove) The metadata properties associated with the model package versions to remove.
UpdateModelPackageRequest	withCustomerMetadataPropertiesToRemove(String... customerMetadataPropertiesToRemove) The metadata properties associated with the model package versions to remove.
UpdateModelPackageRequest	withInferenceSpecification(InferenceSpecification inferenceSpecification) Specifies details about inference jobs that you can run with models based on this model package, including the following information:
UpdateModelPackageRequest	withModelApprovalStatus(ModelApprovalStatus modelApprovalStatus) The approval status of the model.
UpdateModelPackageRequest	withModelApprovalStatus(String modelApprovalStatus) The approval status of the model.
UpdateModelPackageRequest	withModelCard(ModelPackageModelCard modelCard) The model card associated with the model package.
UpdateModelPackageRequest	withModelPackageArn(String modelPackageArn) The Amazon Resource Name (ARN) of the model package.
UpdateModelPackageRequest	withSourceUri(String sourceUri) The URI of the source for the model package.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateModelPackageRequest

public UpdateModelPackageRequest()

Method Detail

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 UpdateModelPackageRequest 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.

setModelApprovalStatus

public void setModelApprovalStatus(String modelApprovalStatus)

The approval status of the model.

Parameters:

modelApprovalStatus - The approval status of the model.

See Also:

ModelApprovalStatus

getModelApprovalStatus

public String getModelApprovalStatus()

The approval status of the model.

Returns:

The approval status of the model.

See Also:

ModelApprovalStatus

withModelApprovalStatus

public UpdateModelPackageRequest withModelApprovalStatus(String modelApprovalStatus)

The approval status of the model.

Parameters:

modelApprovalStatus - The approval status of the model.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ModelApprovalStatus

withModelApprovalStatus

public UpdateModelPackageRequest withModelApprovalStatus(ModelApprovalStatus modelApprovalStatus)

The approval status of the model.

Parameters:

modelApprovalStatus - The approval status of the model.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ModelApprovalStatus

setApprovalDescription

public void setApprovalDescription(String approvalDescription)

A description for the approval status of the model.

Parameters:

approvalDescription - A description for the approval status of the model.

getApprovalDescription

public String getApprovalDescription()

A description for the approval status of the model.

Returns:

A description for the approval status of the model.

withApprovalDescription

public UpdateModelPackageRequest withApprovalDescription(String approvalDescription)

A description for the approval status of the model.

Parameters:

approvalDescription - A description for the approval status of the model.

Returns:

Returns a reference to this object so that method calls can be chained together.

getCustomerMetadataProperties

public Map<String,String> getCustomerMetadataProperties()

The metadata properties associated with the model package versions.

Returns:

The metadata properties associated with the model package versions.

setCustomerMetadataProperties

public void setCustomerMetadataProperties(Map<String,String> customerMetadataProperties)

The metadata properties associated with the model package versions.

Parameters:

customerMetadataProperties - The metadata properties associated with the model package versions.

withCustomerMetadataProperties

public UpdateModelPackageRequest withCustomerMetadataProperties(Map<String,String> customerMetadataProperties)

The metadata properties associated with the model package versions.

Parameters:

customerMetadataProperties - The metadata properties associated with the model package versions.

Returns:

Returns a reference to this object so that method calls can be chained together.

addCustomerMetadataPropertiesEntry

public UpdateModelPackageRequest addCustomerMetadataPropertiesEntry(String key,
                                                                    String value)

Add a single CustomerMetadataProperties entry

See Also:

withCustomerMetadataProperties(java.util.Map<java.lang.String, java.lang.String>)

clearCustomerMetadataPropertiesEntries

public UpdateModelPackageRequest clearCustomerMetadataPropertiesEntries()

Removes all the entries added into CustomerMetadataProperties.

Returns:

Returns a reference to this object so that method calls can be chained together.

getCustomerMetadataPropertiesToRemove

public List<String> getCustomerMetadataPropertiesToRemove()

The metadata properties associated with the model package versions to remove.

Returns:

The metadata properties associated with the model package versions to remove.

setCustomerMetadataPropertiesToRemove

public void setCustomerMetadataPropertiesToRemove(Collection<String> customerMetadataPropertiesToRemove)

The metadata properties associated with the model package versions to remove.

Parameters:

customerMetadataPropertiesToRemove - The metadata properties associated with the model package versions to remove.

withCustomerMetadataPropertiesToRemove

public UpdateModelPackageRequest withCustomerMetadataPropertiesToRemove(String... customerMetadataPropertiesToRemove)

The metadata properties associated with the model package versions to remove.

NOTE: This method appends the values to the existing list (if any). Use setCustomerMetadataPropertiesToRemove(java.util.Collection) or withCustomerMetadataPropertiesToRemove(java.util.Collection) if you want to override the existing values.

Parameters:

customerMetadataPropertiesToRemove - The metadata properties associated with the model package versions to remove.

Returns:

Returns a reference to this object so that method calls can be chained together.

withCustomerMetadataPropertiesToRemove

public UpdateModelPackageRequest withCustomerMetadataPropertiesToRemove(Collection<String> customerMetadataPropertiesToRemove)

The metadata properties associated with the model package versions to remove.

Parameters:

customerMetadataPropertiesToRemove - The metadata properties associated with the model package versions to remove.

Returns:

Returns a reference to this object so that method calls can be chained together.

getAdditionalInferenceSpecificationsToAdd

public List<AdditionalInferenceSpecificationDefinition> getAdditionalInferenceSpecificationsToAdd()

An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

Returns:

An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

setAdditionalInferenceSpecificationsToAdd

public void setAdditionalInferenceSpecificationsToAdd(Collection<AdditionalInferenceSpecificationDefinition> additionalInferenceSpecificationsToAdd)

An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

Parameters:

additionalInferenceSpecificationsToAdd - An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

withAdditionalInferenceSpecificationsToAdd

public UpdateModelPackageRequest withAdditionalInferenceSpecificationsToAdd(AdditionalInferenceSpecificationDefinition... additionalInferenceSpecificationsToAdd)

An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

NOTE: This method appends the values to the existing list (if any). Use setAdditionalInferenceSpecificationsToAdd(java.util.Collection) or withAdditionalInferenceSpecificationsToAdd(java.util.Collection) if you want to override the existing values.

Parameters:

additionalInferenceSpecificationsToAdd - An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

Returns:

Returns a reference to this object so that method calls can be chained together.

withAdditionalInferenceSpecificationsToAdd

public UpdateModelPackageRequest withAdditionalInferenceSpecificationsToAdd(Collection<AdditionalInferenceSpecificationDefinition> additionalInferenceSpecificationsToAdd)

An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

Parameters:

additionalInferenceSpecificationsToAdd - An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

Returns:

Returns a reference to this object so that method calls can be chained together.

setInferenceSpecification

public void setInferenceSpecification(InferenceSpecification inferenceSpecification)

Specifies details about inference jobs that you can run with models based on this model package, including the following information:

• The Amazon ECR paths of containers that contain the inference code and model artifacts.

• The instance types that the model package supports for transform jobs and real-time endpoints used for inference.

• The input and output content formats that the model package supports for inference.

Parameters:

inferenceSpecification - Specifies details about inference jobs that you can run with models based on this model package, including the following information:

• The Amazon ECR paths of containers that contain the inference code and model artifacts.

• The instance types that the model package supports for transform jobs and real-time endpoints used for inference.

• The input and output content formats that the model package supports for inference.

getInferenceSpecification

public InferenceSpecification getInferenceSpecification()

Specifies details about inference jobs that you can run with models based on this model package, including the following information:

• The Amazon ECR paths of containers that contain the inference code and model artifacts.

• The instance types that the model package supports for transform jobs and real-time endpoints used for inference.

• The input and output content formats that the model package supports for inference.

Returns:

Specifies details about inference jobs that you can run with models based on this model package, including the following information:

• The Amazon ECR paths of containers that contain the inference code and model artifacts.

• The instance types that the model package supports for transform jobs and real-time endpoints used for inference.

• The input and output content formats that the model package supports for inference.

withInferenceSpecification

public UpdateModelPackageRequest withInferenceSpecification(InferenceSpecification inferenceSpecification)

Specifies details about inference jobs that you can run with models based on this model package, including the following information:

• The Amazon ECR paths of containers that contain the inference code and model artifacts.

• The instance types that the model package supports for transform jobs and real-time endpoints used for inference.

• The input and output content formats that the model package supports for inference.

Parameters:

inferenceSpecification - Specifies details about inference jobs that you can run with models based on this model package, including the following information:

• The Amazon ECR paths of containers that contain the inference code and model artifacts.

• The instance types that the model package supports for transform jobs and real-time endpoints used for inference.

• The input and output content formats that the model package supports for inference.

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 UpdateModelPackageRequest 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.

setModelCard

public void setModelCard(ModelPackageModelCard modelCard)

The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

Parameters:

modelCard - The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

getModelCard

public ModelPackageModelCard getModelCard()

The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

Returns:

The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

withModelCard

public UpdateModelPackageRequest withModelCard(ModelPackageModelCard modelCard)

The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

Parameters:

modelCard - The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

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 UpdateModelPackageRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()