CreateModelPackageRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.sagemaker.model.CreateModelPackageRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateModelPackageRequest
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

CreateModelPackageRequest()

Constructors
Constructor and Description
`CreateModelPackageRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateModelPackageRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`Boolean`	`getCertifyForMarketplace()` Whether to certify the model package for listing on Amazon Web Services Marketplace.
`String`	`getClientToken()` A unique token that guarantees that the call to this API is idempotent.
`InferenceSpecification`	`getInferenceSpecification()` Specifies details about inference jobs that can be run with models based on this model package, including the following:
`MetadataProperties`	`getMetadataProperties()`
`String`	`getModelApprovalStatus()` Whether the model is approved for deployment.
`ModelMetrics`	`getModelMetrics()` A structure that contains model metrics reports.
`String`	`getModelPackageDescription()` A description of the model package.
`String`	`getModelPackageGroupName()` The name of the model group that this model version belongs to.
`String`	`getModelPackageName()` The name of the model package.
`SourceAlgorithmSpecification`	`getSourceAlgorithmSpecification()` Details about the algorithm that was used to create the model package.
`List<Tag>`	`getTags()` A list of key value pairs associated with the model.
`ModelPackageValidationSpecification`	`getValidationSpecification()` Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.
`int`	`hashCode()`
`Boolean`	`isCertifyForMarketplace()` Whether to certify the model package for listing on Amazon Web Services Marketplace.
`void`	`setCertifyForMarketplace(Boolean certifyForMarketplace)` Whether to certify the model package for listing on Amazon Web Services Marketplace.
`void`	`setClientToken(String clientToken)` A unique token that guarantees that the call to this API is idempotent.
`void`	`setInferenceSpecification(InferenceSpecification inferenceSpecification)` Specifies details about inference jobs that can be run with models based on this model package, including the following:
`void`	`setMetadataProperties(MetadataProperties metadataProperties)`
`void`	`setModelApprovalStatus(String modelApprovalStatus)` Whether the model is approved for deployment.
`void`	`setModelMetrics(ModelMetrics modelMetrics)` A structure that contains model metrics reports.
`void`	`setModelPackageDescription(String modelPackageDescription)` A description of the model package.
`void`	`setModelPackageGroupName(String modelPackageGroupName)` The name of the model group that this model version belongs to.
`void`	`setModelPackageName(String modelPackageName)` The name of the model package.
`void`	`setSourceAlgorithmSpecification(SourceAlgorithmSpecification sourceAlgorithmSpecification)` Details about the algorithm that was used to create the model package.
`void`	`setTags(Collection<Tag> tags)` A list of key value pairs associated with the model.
`void`	`setValidationSpecification(ModelPackageValidationSpecification validationSpecification)` Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.
`String`	`toString()` Returns a string representation of this object.
`CreateModelPackageRequest`	`withCertifyForMarketplace(Boolean certifyForMarketplace)` Whether to certify the model package for listing on Amazon Web Services Marketplace.
`CreateModelPackageRequest`	`withClientToken(String clientToken)` A unique token that guarantees that the call to this API is idempotent.
`CreateModelPackageRequest`	`withInferenceSpecification(InferenceSpecification inferenceSpecification)` Specifies details about inference jobs that can be run with models based on this model package, including the following:
`CreateModelPackageRequest`	`withMetadataProperties(MetadataProperties metadataProperties)`
`CreateModelPackageRequest`	`withModelApprovalStatus(ModelApprovalStatus modelApprovalStatus)` Whether the model is approved for deployment.
`CreateModelPackageRequest`	`withModelApprovalStatus(String modelApprovalStatus)` Whether the model is approved for deployment.
`CreateModelPackageRequest`	`withModelMetrics(ModelMetrics modelMetrics)` A structure that contains model metrics reports.
`CreateModelPackageRequest`	`withModelPackageDescription(String modelPackageDescription)` A description of the model package.
`CreateModelPackageRequest`	`withModelPackageGroupName(String modelPackageGroupName)` The name of the model group that this model version belongs to.
`CreateModelPackageRequest`	`withModelPackageName(String modelPackageName)` The name of the model package.
`CreateModelPackageRequest`	`withSourceAlgorithmSpecification(SourceAlgorithmSpecification sourceAlgorithmSpecification)` Details about the algorithm that was used to create the model package.
`CreateModelPackageRequest`	`withTags(Collection<Tag> tags)` A list of key value pairs associated with the model.
`CreateModelPackageRequest`	`withTags(Tag... tags)` A list of key value pairs associated with the model.
`CreateModelPackageRequest`	`withValidationSpecification(ModelPackageValidationSpecification validationSpecification)` Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.

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

- Constructor Detail
  - CreateModelPackageRequest
```
public CreateModelPackageRequest()
```
- Method Detail
  - setModelPackageName
```
public void setModelPackageName(String modelPackageName)
```
    The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
    
    This parameter is required for unversioned models. It is not applicable to versioned models.
    
    Parameters:
    
    modelPackageName - The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
    
    This parameter is required for unversioned models. It is not applicable to versioned models.
  - getModelPackageName
```
public String getModelPackageName()
```
    The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
    
    This parameter is required for unversioned models. It is not applicable to versioned models.
    
    Returns:
    
    The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
    
    This parameter is required for unversioned models. It is not applicable to versioned models.
  - withModelPackageName
```
public CreateModelPackageRequest withModelPackageName(String modelPackageName)
```
    The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
    
    This parameter is required for unversioned models. It is not applicable to versioned models.
    
    Parameters:
    
    modelPackageName - The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
    
    This parameter is required for unversioned models. It is not applicable to versioned models.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModelPackageGroupName
```
public void setModelPackageGroupName(String modelPackageGroupName)
```
    The name of the model group that this model version belongs to.
    
    This parameter is required for versioned models, and does not apply to unversioned models.
    
    Parameters:
    
    modelPackageGroupName - The name of the model group that this model version belongs to.
    
    This parameter is required for versioned models, and does not apply to unversioned models.
  - getModelPackageGroupName
```
public String getModelPackageGroupName()
```
    The name of the model group that this model version belongs to.
    
    This parameter is required for versioned models, and does not apply to unversioned models.
    
    Returns:
    
    The name of the model group that this model version belongs to.
    
    This parameter is required for versioned models, and does not apply to unversioned models.
  - withModelPackageGroupName
```
public CreateModelPackageRequest withModelPackageGroupName(String modelPackageGroupName)
```
    The name of the model group that this model version belongs to.
    
    This parameter is required for versioned models, and does not apply to unversioned models.
    
    Parameters:
    
    modelPackageGroupName - The name of the model group that this model version belongs to.
    
    This parameter is required for versioned models, and does not apply to unversioned models.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModelPackageDescription
```
public void setModelPackageDescription(String modelPackageDescription)
```
    A description of the model package.
    
    Parameters:
    
    modelPackageDescription - A description of the model package.
  - getModelPackageDescription
```
public String getModelPackageDescription()
```
    A description of the model package.
    
    Returns:
    
    A description of the model package.
  - withModelPackageDescription
```
public CreateModelPackageRequest withModelPackageDescription(String modelPackageDescription)
```
    A description of the model package.
    
    Parameters:
    
    modelPackageDescription - A description of the model package.
    
    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 can be run with models based on this model package, including the following:
    - 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 can be run with models based on this model package, including the following:
    
    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 can be run with models based on this model package, including the following:
    - 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 can be run with models based on this model package, including the following:
    
    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 CreateModelPackageRequest withInferenceSpecification(InferenceSpecification inferenceSpecification)
```
    Specifies details about inference jobs that can be run with models based on this model package, including the following:
    - 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 can be run with models based on this model package, including the following:
    
    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.
  - setValidationSpecification
```
public void setValidationSpecification(ModelPackageValidationSpecification validationSpecification)
```
    Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.
    
    Parameters:
    
    validationSpecification - Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.
  - getValidationSpecification
```
public ModelPackageValidationSpecification getValidationSpecification()
```
    Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.
    
    Returns:
    
    Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.
  - withValidationSpecification
```
public CreateModelPackageRequest withValidationSpecification(ModelPackageValidationSpecification validationSpecification)
```
    Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.
    
    Parameters:
    
    validationSpecification - Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceAlgorithmSpecification
```
public void setSourceAlgorithmSpecification(SourceAlgorithmSpecification sourceAlgorithmSpecification)
```
    Details about the algorithm that was used to create the model package.
    
    Parameters:
    
    sourceAlgorithmSpecification - Details about the algorithm that was used to create the model package.
  - getSourceAlgorithmSpecification
```
public SourceAlgorithmSpecification getSourceAlgorithmSpecification()
```
    Details about the algorithm that was used to create the model package.
    
    Returns:
    
    Details about the algorithm that was used to create the model package.
  - withSourceAlgorithmSpecification
```
public CreateModelPackageRequest withSourceAlgorithmSpecification(SourceAlgorithmSpecification sourceAlgorithmSpecification)
```
    Details about the algorithm that was used to create the model package.
    
    Parameters:
    
    sourceAlgorithmSpecification - Details about the algorithm that was used to create 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 to certify the model package for listing on Amazon Web Services Marketplace.
    
    This parameter is optional for unversioned models, and does not apply to versioned models.
    
    Parameters:
    
    certifyForMarketplace - Whether to certify the model package for listing on Amazon Web Services Marketplace.
    
    This parameter is optional for unversioned models, and does not apply to versioned models.
  - getCertifyForMarketplace
```
public Boolean getCertifyForMarketplace()
```
    Whether to certify the model package for listing on Amazon Web Services Marketplace.
    
    This parameter is optional for unversioned models, and does not apply to versioned models.
    
    Returns:
    
    Whether to certify the model package for listing on Amazon Web Services Marketplace.
    
    This parameter is optional for unversioned models, and does not apply to versioned models.
  - withCertifyForMarketplace
```
public CreateModelPackageRequest withCertifyForMarketplace(Boolean certifyForMarketplace)
```
    Whether to certify the model package for listing on Amazon Web Services Marketplace.
    
    This parameter is optional for unversioned models, and does not apply to versioned models.
    
    Parameters:
    
    certifyForMarketplace - Whether to certify the model package for listing on Amazon Web Services Marketplace.
    
    This parameter is optional for unversioned models, and does not apply to versioned models.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isCertifyForMarketplace
```
public Boolean isCertifyForMarketplace()
```
    Whether to certify the model package for listing on Amazon Web Services Marketplace.
    
    This parameter is optional for unversioned models, and does not apply to versioned models.
    
    Returns:
    
    Whether to certify the model package for listing on Amazon Web Services Marketplace.
    
    This parameter is optional for unversioned models, and does not apply to versioned models.
  - getTags
```
public List<Tag> getTags()
```
    A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
    
    Returns:
    
    A list of key value pairs associated with the model. 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 key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
    
    Parameters:
    
    tags - A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
  - withTags
```
public CreateModelPackageRequest withTags(Tag... tags)
```
    A list of key value pairs associated with the model. 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 key value pairs associated with the model. 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 CreateModelPackageRequest withTags(Collection<Tag> tags)
```
    A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
    
    Parameters:
    
    tags - A list of key value pairs associated with the model. 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.
  - setModelApprovalStatus
```
public void setModelApprovalStatus(String modelApprovalStatus)
```
    Whether the model is approved for deployment.
    
    This parameter is optional for versioned models, and does not apply to unversioned models.
    
    For versioned models, the value of this parameter must be set to Approved to deploy the model.
    
    Parameters:
    
    modelApprovalStatus - Whether the model is approved for deployment.
    
    This parameter is optional for versioned models, and does not apply to unversioned models.
    
    For versioned models, the value of this parameter must be set to Approved to deploy the model.
    
    See Also:
    
    ModelApprovalStatus
  - getModelApprovalStatus
```
public String getModelApprovalStatus()
```
    Whether the model is approved for deployment.
    
    This parameter is optional for versioned models, and does not apply to unversioned models.
    
    For versioned models, the value of this parameter must be set to Approved to deploy the model.
    
    Returns:
    
    Whether the model is approved for deployment.
    
    This parameter is optional for versioned models, and does not apply to unversioned models.
    
    For versioned models, the value of this parameter must be set to Approved to deploy the model.
    
    See Also:
    
    ModelApprovalStatus
  - withModelApprovalStatus
```
public CreateModelPackageRequest withModelApprovalStatus(String modelApprovalStatus)
```
    Whether the model is approved for deployment.
    
    This parameter is optional for versioned models, and does not apply to unversioned models.
    
    For versioned models, the value of this parameter must be set to Approved to deploy the model.
    
    Parameters:
    
    modelApprovalStatus - Whether the model is approved for deployment.
    
    This parameter is optional for versioned models, and does not apply to unversioned models.
    
    For versioned models, the value of this parameter must be set to Approved to deploy the model.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ModelApprovalStatus
  - withModelApprovalStatus
```
public CreateModelPackageRequest withModelApprovalStatus(ModelApprovalStatus modelApprovalStatus)
```
    Whether the model is approved for deployment.
    
    This parameter is optional for versioned models, and does not apply to unversioned models.
    
    For versioned models, the value of this parameter must be set to Approved to deploy the model.
    
    Parameters:
    
    modelApprovalStatus - Whether the model is approved for deployment.
    
    This parameter is optional for versioned models, and does not apply to unversioned models.
    
    For versioned models, the value of this parameter must be set to Approved to deploy the model.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ModelApprovalStatus
  - setMetadataProperties
```
public void setMetadataProperties(MetadataProperties metadataProperties)
```
    Parameters:
    
    metadataProperties -
  - getMetadataProperties
```
public MetadataProperties getMetadataProperties()
```
    Returns:
  - withMetadataProperties
```
public CreateModelPackageRequest withMetadataProperties(MetadataProperties metadataProperties)
```
    Parameters:
    
    metadataProperties -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModelMetrics
```
public void setModelMetrics(ModelMetrics modelMetrics)
```
    A structure that contains model metrics reports.
    
    Parameters:
    
    modelMetrics - A structure that contains model metrics reports.
  - getModelMetrics
```
public ModelMetrics getModelMetrics()
```
    A structure that contains model metrics reports.
    
    Returns:
    
    A structure that contains model metrics reports.
  - withModelMetrics
```
public CreateModelPackageRequest withModelMetrics(ModelMetrics modelMetrics)
```
    A structure that contains model metrics reports.
    
    Parameters:
    
    modelMetrics - A structure that contains model metrics reports.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientToken
```
public void setClientToken(String clientToken)
```
    A unique token that guarantees that the call to this API is idempotent.
    
    Parameters:
    
    clientToken - A unique token that guarantees that the call to this API is idempotent.
  - getClientToken
```
public String getClientToken()
```
    A unique token that guarantees that the call to this API is idempotent.
    
    Returns:
    
    A unique token that guarantees that the call to this API is idempotent.
  - withClientToken
```
public CreateModelPackageRequest withClientToken(String clientToken)
```
    A unique token that guarantees that the call to this API is idempotent.
    
    Parameters:
    
    clientToken - A unique token that guarantees that the call to this API is idempotent.
    
    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 CreateModelPackageRequest 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()

Did this page help you?

Class CreateModelPackageRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateModelPackageRequest

Method Detail

setModelPackageName

getModelPackageName

withModelPackageName

setModelPackageGroupName

getModelPackageGroupName

withModelPackageGroupName

setModelPackageDescription

getModelPackageDescription

withModelPackageDescription

setInferenceSpecification

getInferenceSpecification

withInferenceSpecification

setValidationSpecification

getValidationSpecification

withValidationSpecification

setSourceAlgorithmSpecification

getSourceAlgorithmSpecification

withSourceAlgorithmSpecification

setCertifyForMarketplace

getCertifyForMarketplace

withCertifyForMarketplace

isCertifyForMarketplace

getTags

setTags

withTags

withTags

setModelApprovalStatus

getModelApprovalStatus

withModelApprovalStatus

withModelApprovalStatus

setMetadataProperties

getMetadataProperties

withMetadataProperties

setModelMetrics

getModelMetrics

withModelMetrics

setClientToken

getClientToken

withClientToken

toString

equals

hashCode

clone