All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnModelPackageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.416Z") @Stability(Stable) public interface CfnModelPackageProps extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnModelPackage.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 Object modelInput;
 CfnModelPackageProps cfnModelPackageProps = CfnModelPackageProps.builder()
         .additionalInferenceSpecificationDefinition(AdditionalInferenceSpecificationDefinitionProperty.builder()
                 .containers(List.of(ModelPackageContainerDefinitionProperty.builder()
                         .image("image")
                         // the properties below are optional
                         .containerHostname("containerHostname")
                         .environment(Map.of(
                                 "environmentKey", "environment"))
                         .framework("framework")
                         .frameworkVersion("frameworkVersion")
                         .imageDigest("imageDigest")
                         .modelDataUrl("modelDataUrl")
                         .modelInput(modelInput)
                         .nearestModelName("nearestModelName")
                         .productId("productId")
                         .build()))
                 .name("name")
                 // the properties below are optional
                 .description("description")
                 .supportedContentTypes(List.of("supportedContentTypes"))
                 .supportedRealtimeInferenceInstanceTypes(List.of("supportedRealtimeInferenceInstanceTypes"))
                 .supportedResponseMimeTypes(List.of("supportedResponseMimeTypes"))
                 .supportedTransformInstanceTypes(List.of("supportedTransformInstanceTypes"))
                 .build())
         .additionalInferenceSpecifications(List.of(AdditionalInferenceSpecificationDefinitionProperty.builder()
                 .containers(List.of(ModelPackageContainerDefinitionProperty.builder()
                         .image("image")
                         // the properties below are optional
                         .containerHostname("containerHostname")
                         .environment(Map.of(
                                 "environmentKey", "environment"))
                         .framework("framework")
                         .frameworkVersion("frameworkVersion")
                         .imageDigest("imageDigest")
                         .modelDataUrl("modelDataUrl")
                         .modelInput(modelInput)
                         .nearestModelName("nearestModelName")
                         .productId("productId")
                         .build()))
                 .name("name")
                 // the properties below are optional
                 .description("description")
                 .supportedContentTypes(List.of("supportedContentTypes"))
                 .supportedRealtimeInferenceInstanceTypes(List.of("supportedRealtimeInferenceInstanceTypes"))
                 .supportedResponseMimeTypes(List.of("supportedResponseMimeTypes"))
                 .supportedTransformInstanceTypes(List.of("supportedTransformInstanceTypes"))
                 .build()))
         .additionalInferenceSpecificationsToAdd(List.of(AdditionalInferenceSpecificationDefinitionProperty.builder()
                 .containers(List.of(ModelPackageContainerDefinitionProperty.builder()
                         .image("image")
                         // the properties below are optional
                         .containerHostname("containerHostname")
                         .environment(Map.of(
                                 "environmentKey", "environment"))
                         .framework("framework")
                         .frameworkVersion("frameworkVersion")
                         .imageDigest("imageDigest")
                         .modelDataUrl("modelDataUrl")
                         .modelInput(modelInput)
                         .nearestModelName("nearestModelName")
                         .productId("productId")
                         .build()))
                 .name("name")
                 // the properties below are optional
                 .description("description")
                 .supportedContentTypes(List.of("supportedContentTypes"))
                 .supportedRealtimeInferenceInstanceTypes(List.of("supportedRealtimeInferenceInstanceTypes"))
                 .supportedResponseMimeTypes(List.of("supportedResponseMimeTypes"))
                 .supportedTransformInstanceTypes(List.of("supportedTransformInstanceTypes"))
                 .build()))
         .approvalDescription("approvalDescription")
         .certifyForMarketplace(false)
         .clientToken("clientToken")
         .createdBy(UserContextProperty.builder()
                 .domainId("domainId")
                 .userProfileArn("userProfileArn")
                 .userProfileName("userProfileName")
                 .build())
         .customerMetadataProperties(Map.of(
                 "customerMetadataPropertiesKey", "customerMetadataProperties"))
         .domain("domain")
         .driftCheckBaselines(DriftCheckBaselinesProperty.builder()
                 .bias(DriftCheckBiasProperty.builder()
                         .configFile(FileSourceProperty.builder()
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .contentType("contentType")
                                 .build())
                         .postTrainingConstraints(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .preTrainingConstraints(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .build())
                 .explainability(DriftCheckExplainabilityProperty.builder()
                         .configFile(FileSourceProperty.builder()
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .contentType("contentType")
                                 .build())
                         .constraints(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .build())
                 .modelDataQuality(DriftCheckModelDataQualityProperty.builder()
                         .constraints(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .statistics(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .build())
                 .modelQuality(DriftCheckModelQualityProperty.builder()
                         .constraints(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .statistics(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .build())
                 .build())
         .environment(Map.of(
                 "environmentKey", "environment"))
         .inferenceSpecification(InferenceSpecificationProperty.builder()
                 .containers(List.of(ModelPackageContainerDefinitionProperty.builder()
                         .image("image")
                         // the properties below are optional
                         .containerHostname("containerHostname")
                         .environment(Map.of(
                                 "environmentKey", "environment"))
                         .framework("framework")
                         .frameworkVersion("frameworkVersion")
                         .imageDigest("imageDigest")
                         .modelDataUrl("modelDataUrl")
                         .modelInput(modelInput)
                         .nearestModelName("nearestModelName")
                         .productId("productId")
                         .build()))
                 .supportedContentTypes(List.of("supportedContentTypes"))
                 .supportedResponseMimeTypes(List.of("supportedResponseMimeTypes"))
                 // the properties below are optional
                 .supportedRealtimeInferenceInstanceTypes(List.of("supportedRealtimeInferenceInstanceTypes"))
                 .supportedTransformInstanceTypes(List.of("supportedTransformInstanceTypes"))
                 .build())
         .lastModifiedBy(UserContextProperty.builder()
                 .domainId("domainId")
                 .userProfileArn("userProfileArn")
                 .userProfileName("userProfileName")
                 .build())
         .lastModifiedTime("lastModifiedTime")
         .metadataProperties(MetadataPropertiesProperty.builder()
                 .commitId("commitId")
                 .generatedBy("generatedBy")
                 .projectId("projectId")
                 .repository("repository")
                 .build())
         .modelApprovalStatus("modelApprovalStatus")
         .modelMetrics(ModelMetricsProperty.builder()
                 .bias(BiasProperty.builder()
                         .postTrainingReport(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .preTrainingReport(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .report(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .build())
                 .explainability(ExplainabilityProperty.builder()
                         .report(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .build())
                 .modelDataQuality(ModelDataQualityProperty.builder()
                         .constraints(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .statistics(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .build())
                 .modelQuality(ModelQualityProperty.builder()
                         .constraints(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .statistics(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .build())
                 .build())
         .modelPackageDescription("modelPackageDescription")
         .modelPackageGroupName("modelPackageGroupName")
         .modelPackageName("modelPackageName")
         .modelPackageStatusDetails(ModelPackageStatusDetailsProperty.builder()
                 .validationStatuses(List.of(ModelPackageStatusItemProperty.builder()
                         .name("name")
                         .status("status")
                         // the properties below are optional
                         .failureReason("failureReason")
                         .build()))
                 // the properties below are optional
                 .imageScanStatuses(List.of(ModelPackageStatusItemProperty.builder()
                         .name("name")
                         .status("status")
                         // the properties below are optional
                         .failureReason("failureReason")
                         .build()))
                 .build())
         .modelPackageStatusItem(ModelPackageStatusItemProperty.builder()
                 .name("name")
                 .status("status")
                 // the properties below are optional
                 .failureReason("failureReason")
                 .build())
         .modelPackageVersion(123)
         .samplePayloadUrl("samplePayloadUrl")
         .sourceAlgorithmSpecification(SourceAlgorithmSpecificationProperty.builder()
                 .sourceAlgorithms(List.of(SourceAlgorithmProperty.builder()
                         .algorithmName("algorithmName")
                         // the properties below are optional
                         .modelDataUrl("modelDataUrl")
                         .build()))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .task("task")
         .validationSpecification(ValidationSpecificationProperty.builder()
                 .validationProfiles(List.of(ValidationProfileProperty.builder()
                         .profileName("profileName")
                         .transformJobDefinition(TransformJobDefinitionProperty.builder()
                                 .transformInput(TransformInputProperty.builder()
                                         .dataSource(DataSourceProperty.builder()
                                                 .s3DataSource(S3DataSourceProperty.builder()
                                                         .s3DataType("s3DataType")
                                                         .s3Uri("s3Uri")
                                                         .build())
                                                 .build())
                                         // the properties below are optional
                                         .compressionType("compressionType")
                                         .contentType("contentType")
                                         .splitType("splitType")
                                         .build())
                                 .transformOutput(TransformOutputProperty.builder()
                                         .s3OutputPath("s3OutputPath")
                                         // the properties below are optional
                                         .accept("accept")
                                         .assembleWith("assembleWith")
                                         .kmsKeyId("kmsKeyId")
                                         .build())
                                 .transformResources(TransformResourcesProperty.builder()
                                         .instanceCount(123)
                                         .instanceType("instanceType")
                                         // the properties below are optional
                                         .volumeKmsKeyId("volumeKmsKeyId")
                                         .build())
                                 // the properties below are optional
                                 .batchStrategy("batchStrategy")
                                 .environment(Map.of(
                                         "environmentKey", "environment"))
                                 .maxConcurrentTransforms(123)
                                 .maxPayloadInMb(123)
                                 .build())
                         .build()))
                 .validationRole("validationRole")
                 .build())
         .build();

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnModelPackageProps.Builder

A builder for CfnModelPackageProps

static final class

CfnModelPackageProps.Jsii$Proxy

An implementation for CfnModelPackageProps
Method Summary

Modifier and Type

Method

Description

static CfnModelPackageProps.Builder

builder()

default Object

getAdditionalInferenceSpecificationDefinition()

A structure of additional Inference Specification.

default Object

getAdditionalInferenceSpecifications()

An array of additional Inference Specification objects.

default Object

getAdditionalInferenceSpecificationsToAdd()

An array of additional Inference Specification objects to be added to the existing array.

default String

getApprovalDescription()

A description provided when the model approval is set.

default Object

getCertifyForMarketplace()

Whether the model package is to be certified to be listed on AWS Marketplace.

default String

getClientToken()

A unique token that guarantees that the call to this API is idempotent.

default Object

getCreatedBy()

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

default Object

getCustomerMetadataProperties()

The metadata properties for the model package.

default String

getDomain()

The machine learning domain of your model package and its components.

default Object

getDriftCheckBaselines()

Represents the drift check baselines that can be used when the model monitor is set using the model package.

default Object

getEnvironment()

The environment variables to set in the Docker container.

default Object

getInferenceSpecification()

Defines how to perform inference generation after a training job is run.

default Object

getLastModifiedBy()

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

default String

getLastModifiedTime()

The last time the model package was modified.

default Object

getMetadataProperties()

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

default String

getModelApprovalStatus()

The approval status of the model.

default Object

getModelMetrics()

Metrics for the model.

default String

getModelPackageDescription()

The description of the model package.

default String

getModelPackageGroupName()

The model group to which the model belongs.

default String

getModelPackageName()

The name of the model.

default Object

getModelPackageStatusDetails()

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

default Object

getModelPackageStatusItem()

Represents the overall status of a model package.

default Number

getModelPackageVersion()

The version number of a versioned model.

default String

getSamplePayloadUrl()

The Amazon Simple Storage Service path where the sample payload are stored.

default Object

getSourceAlgorithmSpecification()

A list of algorithms that were used to create a model package.

default List<CfnTag>

getTags()

A list of the tags associated with the model package.

default String

getTask()

The machine learning task your model package accomplishes.

default Object

getValidationSpecification()

Specifies batch transform jobs that SageMaker runs to validate your model package.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getAdditionalInferenceSpecificationDefinition
  
  @Stability(Stable) @Nullable default Object getAdditionalInferenceSpecificationDefinition()
  
  A structure of additional Inference Specification.
  Additional Inference Specification specifies details about inference jobs that can be run with models based on this model package
- getAdditionalInferenceSpecifications
  
  @Stability(Stable) @Nullable default Object getAdditionalInferenceSpecifications()
  
  An array of additional Inference Specification objects.
- getAdditionalInferenceSpecificationsToAdd
  
  @Stability(Stable) @Nullable default Object getAdditionalInferenceSpecificationsToAdd()
  
  An array of additional Inference Specification objects to be added to the existing array.
  The total number of additional Inference Specification objects cannot exceed 15. Each additional Inference Specification object specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
- getApprovalDescription
  
  @Stability(Stable) @Nullable default String getApprovalDescription()
  
  A description provided when the model approval is set.
- getCertifyForMarketplace
  
  @Stability(Stable) @Nullable default Object getCertifyForMarketplace()
  
  Whether the model package is to be certified to be listed on AWS Marketplace.
  For information about listing model packages on AWS Marketplace, see List Your Algorithm or Model Package on AWS Marketplace .
- getClientToken
  
  @Stability(Stable) @Nullable default String getClientToken()
  
  A unique token that guarantees that the call to this API is idempotent.
- getCreatedBy
  
  @Stability(Stable) @Nullable default Object getCreatedBy()
  
  Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
- getCustomerMetadataProperties
  
  @Stability(Stable) @Nullable default Object getCustomerMetadataProperties()
  
  The metadata properties for the model package.
- getDomain
  
  @Stability(Stable) @Nullable default String getDomain()
  
  The machine learning domain of your model package and its components.
  Common machine learning domains include computer vision and natural language processing.
- getDriftCheckBaselines
  
  @Stability(Stable) @Nullable default Object getDriftCheckBaselines()
  
  Represents the drift check baselines that can be used when the model monitor is set using the model package.
- getEnvironment
  
  @Stability(Stable) @Nullable default Object getEnvironment()
  
  The environment variables to set in the Docker container.
  Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.
- getInferenceSpecification
  
  @Stability(Stable) @Nullable default Object getInferenceSpecification()
  
  Defines how to perform inference generation after a training job is run.
- getLastModifiedBy
  
  @Stability(Stable) @Nullable default Object getLastModifiedBy()
  
  Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
- getLastModifiedTime
  
  @Stability(Stable) @Nullable default String getLastModifiedTime()
  
  The last time the model package was modified.
- getMetadataProperties
  
  @Stability(Stable) @Nullable default Object getMetadataProperties()
  
  Metadata properties of the tracking entity, trial, or trial component.
- getModelApprovalStatus
  
  @Stability(Stable) @Nullable default String getModelApprovalStatus()
  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.
- getModelMetrics
  
  @Stability(Stable) @Nullable default Object getModelMetrics()
  
  Metrics for the model.
- getModelPackageDescription
  
  @Stability(Stable) @Nullable default String getModelPackageDescription()
  
  The description of the model package.
- getModelPackageGroupName
  
  @Stability(Stable) @Nullable default String getModelPackageGroupName()
  
  The model group to which the model belongs.
- getModelPackageName
  
  @Stability(Stable) @Nullable default String getModelPackageName()
  
  The name of the model.
- getModelPackageStatusDetails
  
  @Stability(Stable) @Nullable default Object getModelPackageStatusDetails()
  
  Specifies the validation and image scan statuses of the model package.
- getModelPackageStatusItem
  
  @Stability(Stable) @Nullable default Object getModelPackageStatusItem()
  
  Represents the overall status of a model package.
- getModelPackageVersion
  
  @Stability(Stable) @Nullable default Number getModelPackageVersion()
  
  The version number of a versioned model.
- getSamplePayloadUrl
  
  @Stability(Stable) @Nullable default String getSamplePayloadUrl()
  
  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).
- getSourceAlgorithmSpecification
  
  @Stability(Stable) @Nullable default Object getSourceAlgorithmSpecification()
  
  A list of algorithms that were used to create a model package.
- getTags
  
  @Stability(Stable) @Nullable default List<CfnTag> getTags()
  
  A list of the tags associated with the model package.
  For more information, see Tagging AWS resources in the AWS General Reference Guide .
- getTask
  
  @Stability(Stable) @Nullable default String getTask()
  
  The machine learning task your model package accomplishes.
  Common machine learning tasks include object detection and image classification.
- getValidationSpecification
  
  @Stability(Stable) @Nullable default Object getValidationSpecification()
  
  Specifies batch transform jobs that SageMaker runs to validate your model package.
- builder
  
  @Stability(Stable) static CfnModelPackageProps.Builder builder()
  
  Returns:
  
  a CfnModelPackageProps.Builder of CfnModelPackageProps

Interface CfnModelPackageProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getAdditionalInferenceSpecificationDefinition

getAdditionalInferenceSpecifications

getAdditionalInferenceSpecificationsToAdd

getApprovalDescription

getCertifyForMarketplace

getClientToken

getCreatedBy

getCustomerMetadataProperties

getDomain

getDriftCheckBaselines

getEnvironment

getInferenceSpecification

getLastModifiedBy

getLastModifiedTime

getMetadataProperties

getModelApprovalStatus

getModelMetrics

getModelPackageDescription

getModelPackageGroupName

getModelPackageName

getModelPackageStatusDetails

getModelPackageStatusItem

getModelPackageVersion

getSamplePayloadUrl

getSourceAlgorithmSpecification

getTags

getTask

getValidationSpecification

builder