Class DescribeModelPackageResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.sagemaker.model.SageMakerResponse
software.amazon.awssdk.services.sagemaker.model.DescribeModelPackageResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeModelPackageResponse.Builder,DescribeModelPackageResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeModelPackageResponse extends SageMakerResponse implements ToCopyableBuilder<DescribeModelPackageResponse.Builder,DescribeModelPackageResponse>

  • Method Details

    • modelPackageName

      public final String modelPackageName()

      The name of the model package being described.

      Returns:
      The name of the model package being described.

    • modelPackageGroupName

      public final String modelPackageGroupName()

      If the model is a versioned model, the name of the model group that the versioned model belongs to.

      Returns:
      If the model is a versioned model, the name of the model group that the versioned model belongs to.

    • modelPackageVersion

      public final Integer modelPackageVersion()

      The version of the model package.

      Returns:
      The version of the model package.

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

      A brief summary of the model package.

      Returns:
      A brief summary of the model package.

    • creationTime

      public final Instant creationTime()

      A timestamp specifying when the model package was created.

      Returns:
      A timestamp specifying when the model package was created.

    • inferenceSpecification

      public final InferenceSpecification inferenceSpecification()

      Details about inference jobs that you can run with models based on this model package.

      Returns:
      Details about inference jobs that you can run with models based on this 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.

    • validationSpecification

      public final ModelPackageValidationSpecification validationSpecification()

      Configurations for one or more transform jobs that SageMaker runs to test the model package.

      Returns:
      Configurations for one or more transform jobs that SageMaker runs to test the model package.

    • modelPackageStatus

      public final ModelPackageStatus modelPackageStatus()

      The current status of the model package.

      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 current status of the model package.
      See Also:

    • modelPackageStatusAsString

      public final String modelPackageStatusAsString()

      The current status of the model package.

      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 current status of the model package.
      See Also:

    • modelPackageStatusDetails

      public final ModelPackageStatusDetails modelPackageStatusDetails()

      Details about the current status of the model package.

      Returns:
      Details about the current status of the model package.

    • certifyForMarketplace

      public final Boolean certifyForMarketplace()

      Whether the model package is certified for listing on Amazon Web Services Marketplace.

      Returns:
      Whether the model package is certified for listing on Amazon Web Services Marketplace.

    • modelApprovalStatus

      public final ModelApprovalStatus modelApprovalStatus()

      The approval status of the model package.

      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 package.
      See Also:

    • modelApprovalStatusAsString

      public final String modelApprovalStatusAsString()

      The approval status of the model package.

      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 package.
      See Also:

    • createdBy

      public final UserContext createdBy()
      Returns the value of the CreatedBy property for this object.
      Returns:
      The value of the CreatedBy property for this object.

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

      Metrics for the model.

      Returns:
      Metrics for the model.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The last time that the model package was modified.

      Returns:
      The last time that the model package was modified.

    • lastModifiedBy

      public final UserContext lastModifiedBy()
      Returns the value of the LastModifiedBy property for this object.
      Returns:
      The value of the LastModifiedBy property for this object.

    • approvalDescription

      public final String approvalDescription()

      A description provided for the model approval.

      Returns:
      A description provided for the model approval.

    • domain

      public final String domain()

      The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.

      Returns:
      The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.

    • task

      public final String task()

      The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.

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

    • samplePayloadUrl

      public final String samplePayloadUrl()

      The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single gzip compressed tar archive (.tar.gz suffix).

      Returns:
      The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single gzip compressed tar archive (.tar.gz suffix).

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

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

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

      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 DescribeModelPackageResponse.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<DescribeModelPackageResponse.Builder,DescribeModelPackageResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeModelPackageResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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