software.amazon.awssdk.services.sagemaker.model

Class CreateModelPackageRequest

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(value="software.amazon.awssdk:codegen")
public final class CreateModelPackageRequest
extends SageMakerRequest
implements ToCopyableBuilder<CreateModelPackageRequest.Builder,CreateModelPackageRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateModelPackageRequest.Builder

Method Summary

Modifier and Type	Method and Description
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.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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 can be run with models based on this model package, including the following:
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.
ModelMetrics	modelMetrics() A structure that contains model metrics reports.
String	modelPackageDescription() A description of the model package.
String	modelPackageGroupName() The name of the model group that this model version belongs to.
String	modelPackageName() The name of the model package.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateModelPackageRequest.Builder>	serializableBuilderClass()
SourceAlgorithmSpecification	sourceAlgorithmSpecification() Details about the algorithm that was used to create the model package.
List<Tag>	tags() A list of key value pairs associated with the model.
CreateModelPackageRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
ModelPackageValidationSpecification	validationSpecification() Specifies configurations for one or more transform jobs that Amazon 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 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.

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

validationSpecification

public final ModelPackageValidationSpecification validationSpecification()

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.

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.

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.

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.

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