Class ModelPackage

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.ModelPackage
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ModelPackage.Builder,ModelPackage>
@Generated("software.amazon.awssdk:codegen") public final class ModelPackage extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ModelPackage.Builder,ModelPackage>

A versioned model that can be deployed for SageMaker inference.

See Also:

  • Method Details

    • modelPackageName

      public final String modelPackageName()

      The name of the model.

      Returns:
      The name of the model.

    • modelPackageGroupName

      public final String modelPackageGroupName()

      The model group to which the model belongs.

      Returns:
      The model group to which the model belongs.

    • modelPackageVersion

      public final Integer modelPackageVersion()

      The version number of a versioned model.

      Returns:
      The version number of a versioned model.

    • modelPackageArn

      public final String modelPackageArn()

      The Amazon Resource Name (ARN) of the model package.

      Returns:
      The Amazon Resource Name (ARN) of the model package.

    • modelPackageDescription

      public final String modelPackageDescription()

      The description of the model package.

      Returns:
      The description of the model package.

    • creationTime

      public final Instant creationTime()

      The time that the model package was created.

      Returns:
      The time that the model package was created.

    • inferenceSpecification

      public final InferenceSpecification inferenceSpecification()

      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.

    • sourceAlgorithmSpecification

      public final SourceAlgorithmSpecification sourceAlgorithmSpecification()

      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.

    • validationSpecification

      public final ModelPackageValidationSpecification validationSpecification()

      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.

    • modelPackageStatus

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

      If the service returns an enum value that is not available in the current SDK version, modelPackageStatus will return ModelPackageStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modelPackageStatusAsString().

      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:

    • modelPackageStatusAsString

      public final String modelPackageStatusAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, modelPackageStatus will return ModelPackageStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modelPackageStatusAsString().

      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:

    • modelPackageStatusDetails

      public final ModelPackageStatusDetails modelPackageStatusDetails()

      Specifies the validation and image scan statuses of the model package.

      Returns:
      Specifies the validation and image scan statuses of the model package.

    • certifyForMarketplace

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

      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.

    • modelApprovalStatus

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

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

    • modelApprovalStatusAsString

      public final String modelApprovalStatusAsString()

      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.

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

    • createdBy

      public final UserContext createdBy()

      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.

    • metadataProperties

      public final MetadataProperties metadataProperties()

      Metadata properties of the tracking entity, trial, or trial component.

      Returns:
      Metadata properties of the tracking entity, trial, or trial component.

    • modelMetrics

      public final ModelMetrics modelMetrics()

      Metrics for the model.

      Returns:
      Metrics for the model.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The last time the model package was modified.

      Returns:
      The last time the model package was modified.

    • lastModifiedBy

      public final UserContext lastModifiedBy()

      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.

    • approvalDescription

      public final String approvalDescription()

      A description provided when the model approval is set.

      Returns:
      A description provided when the model approval is set.

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

      Returns:
      The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.

    • samplePayloadUrl

      public final 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).

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

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

      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.

    • sourceUri

      public final String sourceUri()

      The URI of the source for the model package.

      Returns:
      The URI of the source for the model package.

    • securityConfig

      public final ModelPackageSecurityConfig securityConfig()
      Returns the value of the SecurityConfig property for this object.
      Returns:
      The value of the SecurityConfig property for this object.

    • modelCard

      public final ModelPackageModelCard modelCard()
      Returns the value of the ModelCard property for this object.
      Returns:
      The value of the ModelCard property for this object.

    • 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 the tags associated with the model package. 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 the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

    • 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 for the model package.

      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 for the model package.

    • driftCheckBaselines

      public final DriftCheckBaselines driftCheckBaselines()

      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.

    • 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:

    • 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:

    • toBuilder

      public ModelPackage.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ModelPackage.Builder,ModelPackage>
      Returns:
      a builder for type T

    • builder

      public static ModelPackage.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ModelPackage.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.