Package software.amazon.awssdk.services.sagemaker.model

Class DescribeModelPackageResponse

    • Method Detail

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

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

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

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

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

      • modelLifeCycle

        public final ModelLifeCycle modelLifeCycle()

        A structure describing the current state of the model in its life cycle.

        Returns:
        A structure describing the current state of the model in its life cycle.

      • 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