java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.sagemaker.model.SageMakerRequest
    - - software.amazon.awssdk.services.sagemaker.model.CreateModelPackageRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateModelPackageRequest.Builder,CreateModelPackageRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateModelPackageRequest
extends SageMakerRequest
implements ToCopyableBuilder<CreateModelPackageRequest.Builder,CreateModelPackageRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateModelPackageRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<AdditionalInferenceSpecificationDefinition>`	`additionalInferenceSpecifications()`	An array of additional Inference Specification objects.
`static CreateModelPackageRequest.Builder`	`builder()`
`Boolean`	`certifyForMarketplace()`	Whether to certify the model package for listing on Amazon Web Services Marketplace.
`String`	`clientToken()`	A unique token that guarantees that the call to this API is idempotent.
`Map<String,String>`	`customerMetadataProperties()`	The metadata properties associated with the model package versions.
`String`	`domain()`	The machine learning domain of your model package and its components.
`DriftCheckBaselines`	`driftCheckBaselines()`	Represents the drift check baselines that can be used when the model monitor is set using the model package.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAdditionalInferenceSpecifications()`	For responses, this returns true if the service returned a value for the AdditionalInferenceSpecifications property.
`boolean`	`hasCustomerMetadataProperties()`	For responses, this returns true if the service returned a value for the CustomerMetadataProperties property.
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`InferenceSpecification`	`inferenceSpecification()`	Specifies details about inference jobs that you can run with models based on this model package, including the following information:
`MetadataProperties`	`metadataProperties()`	Returns the value of the MetadataProperties property for this object.
`ModelApprovalStatus`	`modelApprovalStatus()`	Whether the model is approved for deployment.
`String`	`modelApprovalStatusAsString()`	Whether the model is approved for deployment.
`ModelPackageModelCard`	`modelCard()`	The model card associated with the model package.
`ModelMetrics`	`modelMetrics()`	A structure that contains model metrics reports.
`String`	`modelPackageDescription()`	A description of the model package.
`String`	`modelPackageGroupName()`	The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.
`String`	`modelPackageName()`	The name of the model package.
`String`	`samplePayloadUrl()`	The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored.
`List<SdkField<?>>`	`sdkFields()`
`ModelPackageSecurityConfig`	`securityConfig()`	The KMS Key ID (`KMSKeyId`) used for encryption of model package information.
`static Class<? extends CreateModelPackageRequest.Builder>`	`serializableBuilderClass()`
`SkipModelValidation`	`skipModelValidation()`	Indicates if you want to skip model validation.
`String`	`skipModelValidationAsString()`	Indicates if you want to skip model validation.
`SourceAlgorithmSpecification`	`sourceAlgorithmSpecification()`	Details about the algorithm that was used to create the model package.
`String`	`sourceUri()`	The URI of the source for the model package.
`List<Tag>`	`tags()`	A list of key value pairs associated with the model.
`String`	`task()`	The machine learning task your model package accomplishes.
`CreateModelPackageRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`ModelPackageValidationSpecification`	`validationSpecification()`	Specifies configurations for one or more transform jobs that SageMaker runs to test the model package.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - modelPackageName
```
public final 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.
    
    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.
  - modelPackageGroupName
```
public final String modelPackageGroupName()
```
    The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.
    
    This parameter is required for versioned models, and does not apply to unversioned models.
    
    Returns:
    
    The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.
    
    This parameter is required for versioned models, and does not apply to unversioned models.
  - modelPackageDescription
```
public final String modelPackageDescription()
```
    A description of the model package.
    
    Returns:
    
    A description of the model package.
  - inferenceSpecification
```
public final 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.
    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.
  - validationSpecification
```
public final ModelPackageValidationSpecification validationSpecification()
```
    Specifies configurations for one or more transform jobs that SageMaker runs to test the model package.
    
    Returns:
    
    Specifies configurations for one or more transform jobs that SageMaker runs to test the model package.
  - sourceAlgorithmSpecification
```
public final SourceAlgorithmSpecification sourceAlgorithmSpecification()
```
    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.
  - certifyForMarketplace
```
public final 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.
    
    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.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final List<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.
    
    If you supply ModelPackageGroupName, your model package belongs to the model group you specify and uses the tags associated with the model group. In this case, you cannot supply a tag argument.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    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.
    
    If you supply ModelPackageGroupName, your model package belongs to the model group you specify and uses the tags associated with the model group. In this case, you cannot supply a tag argument.
  - modelApprovalStatus
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, modelApprovalStatus will return ModelApprovalStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modelApprovalStatusAsString().
    
    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
  - modelApprovalStatusAsString
```
public final String modelApprovalStatusAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, modelApprovalStatus will return ModelApprovalStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modelApprovalStatusAsString().
    
    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
  - metadataProperties
```
public final MetadataProperties metadataProperties()
```
    Returns the value of the MetadataProperties property for this object.
    
    Returns:
    
    The value of the MetadataProperties property for this object.
  - modelMetrics
```
public final ModelMetrics modelMetrics()
```
    A structure that contains model metrics reports.
    
    Returns:
    
    A structure that contains model metrics reports.
  - clientToken
```
public final String clientToken()
```
    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.
  - domain
```
public final String domain()
```
    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.
  - task
```
public final String task()
```
    The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification. The following tasks are supported by Inference Recommender: "IMAGE_CLASSIFICATION" | "OBJECT_DETECTION" | "TEXT_GENERATION" | "IMAGE_SEGMENTATION" | "FILL_MASK" | "CLASSIFICATION" | "REGRESSION" | "OTHER".
    
    Specify "OTHER" if none of the tasks listed fit your use case.
    
    Returns:
    
    The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification. The following tasks are supported by Inference Recommender: "IMAGE_CLASSIFICATION" | "OBJECT_DETECTION" | "TEXT_GENERATION" | "IMAGE_SEGMENTATION" | "FILL_MASK" | "CLASSIFICATION" | "REGRESSION" | "OTHER".
    
    Specify "OTHER" if none of the tasks listed fit your use case.
  - samplePayloadUrl
```
public final String samplePayloadUrl()
```
    The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple files that are all equally used in the load test. Each file in the archive must satisfy the size constraints of the InvokeEndpoint call.
    
    Returns:
    
    The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple files that are all equally used in the load test. Each file in the archive must satisfy the size constraints of the InvokeEndpoint call.
  - hasCustomerMetadataProperties
```
public final boolean hasCustomerMetadataProperties()
```
    For responses, this returns true if the service returned a value for the CustomerMetadataProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - customerMetadataProperties
```
public final Map<String,String> customerMetadataProperties()
```
    The metadata properties associated with the model package versions.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCustomerMetadataProperties() method.
    
    Returns:
    
    The metadata properties associated with the model package versions.
  - driftCheckBaselines
```
public final DriftCheckBaselines driftCheckBaselines()
```
    Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.
    
    Returns:
    
    Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.
  - hasAdditionalInferenceSpecifications
```
public final boolean hasAdditionalInferenceSpecifications()
```
    For responses, this returns true if the service returned a value for the AdditionalInferenceSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - additionalInferenceSpecifications
```
public final List<AdditionalInferenceSpecificationDefinition> additionalInferenceSpecifications()
```
    An array of additional Inference Specification objects. 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdditionalInferenceSpecifications() method.
    
    Returns:
    
    An array of additional Inference Specification objects. 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.
  - skipModelValidation
```
public final SkipModelValidation skipModelValidation()
```
    Indicates if you want to skip model validation.
    
    If the service returns an enum value that is not available in the current SDK version, skipModelValidation will return SkipModelValidation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from skipModelValidationAsString().
    
    Returns:
    
    Indicates if you want to skip model validation.
    
    See Also:
    
    SkipModelValidation
  - skipModelValidationAsString
```
public final String skipModelValidationAsString()
```
    Indicates if you want to skip model validation.
    
    If the service returns an enum value that is not available in the current SDK version, skipModelValidation will return SkipModelValidation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from skipModelValidationAsString().
    
    Returns:
    
    Indicates if you want to skip model validation.
    
    See Also:
    
    SkipModelValidation
  - sourceUri
```
public final String sourceUri()
```
    The URI of the source for the model package. If you want to clone a model package, set it to the model package Amazon Resource Name (ARN). If you want to register a model, set it to the model ARN.
    
    Returns:
    
    The URI of the source for the model package. If you want to clone a model package, set it to the model package Amazon Resource Name (ARN). If you want to register a model, set it to the model ARN.
  - securityConfig
```
public final ModelPackageSecurityConfig securityConfig()
```
    The KMS Key ID (KMSKeyId) used for encryption of model package information.
    
    Returns:
    
    The KMS Key ID (KMSKeyId) used for encryption of model package information.
  - modelCard
```
public final 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.
    
    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.
  - toBuilder
```
public CreateModelPackageRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateModelPackageRequest.Builder,CreateModelPackageRequest>
    
    Specified by:
    
    toBuilder in class SageMakerRequest
  - builder
```
public static CreateModelPackageRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateModelPackageRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateModelPackageRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

modelPackageName

modelPackageGroupName

modelPackageDescription

inferenceSpecification

validationSpecification

sourceAlgorithmSpecification

certifyForMarketplace

hasTags

tags

modelApprovalStatus

modelApprovalStatusAsString

metadataProperties

modelMetrics

clientToken

domain

task

samplePayloadUrl

hasCustomerMetadataProperties

customerMetadataProperties

driftCheckBaselines

hasAdditionalInferenceSpecifications

additionalInferenceSpecifications

skipModelValidation

skipModelValidationAsString

sourceUri

securityConfig

modelCard

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields