software.amazon.awscdk.services.sagemaker

Interface CfnModelPackageProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelPackageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:55.897Z")
 @Stability(value=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 environment;
 Object modelInput;
 CfnModelPackageProps cfnModelPackageProps = CfnModelPackageProps.builder()
         .additionalInferenceSpecificationDefinition(AdditionalInferenceSpecificationDefinitionProperty.builder()
                 .containers(List.of(ModelPackageContainerDefinitionProperty.builder()
                         .image("image")
                         // the properties below are optional
                         .containerHostname("containerHostname")
                         .environment(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(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(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(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(environment)
                                 .maxConcurrentTransforms(123)
                                 .maxPayloadInMb(123)
                                 .build())
                         .build()))
                 .validationRole("validationRole")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnModelPackageProps.Builder A builder for CfnModelPackageProps
static class	CfnModelPackageProps.Jsii$Proxy An implementation for CfnModelPackageProps

Method Summary

Modifier and Type	Method and Description
static CfnModelPackageProps.Builder	builder()
default Object	getAdditionalInferenceSpecificationDefinition() `AWS::SageMaker::ModelPackage.AdditionalInferenceSpecificationDefinition`.
default Object	getAdditionalInferenceSpecifications() An array of additional Inference Specification objects.
default Object	getAdditionalInferenceSpecificationsToAdd() `AWS::SageMaker::ModelPackage.AdditionalInferenceSpecificationsToAdd`.
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() `AWS::SageMaker::ModelPackage.ClientToken`.
default Object	getCreatedBy() `AWS::SageMaker::ModelPackage.CreatedBy`.
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() `AWS::SageMaker::ModelPackage.InferenceSpecification`.
default Object	getLastModifiedBy() `AWS::SageMaker::ModelPackage.LastModifiedBy`.
default String	getLastModifiedTime() The last time the model package was modified.
default Object	getMetadataProperties() `AWS::SageMaker::ModelPackage.MetadataProperties`.
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() `AWS::SageMaker::ModelPackage.ModelPackageStatusDetails`.
default Object	getModelPackageStatusItem() `AWS::SageMaker::ModelPackage.ModelPackageStatusItem`.
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() `AWS::SageMaker::ModelPackage.SourceAlgorithmSpecification`.
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() `AWS::SageMaker::ModelPackage.ValidationSpecification`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAdditionalInferenceSpecificationDefinition

@Stability(value=Stable)
 @Nullable
default Object getAdditionalInferenceSpecificationDefinition()

`AWS::SageMaker::ModelPackage.AdditionalInferenceSpecificationDefinition`.

getAdditionalInferenceSpecifications

@Stability(value=Stable)
 @Nullable
default Object getAdditionalInferenceSpecifications()

An array of additional Inference Specification objects.

getAdditionalInferenceSpecificationsToAdd

@Stability(value=Stable)
 @Nullable
default Object getAdditionalInferenceSpecificationsToAdd()

`AWS::SageMaker::ModelPackage.AdditionalInferenceSpecificationsToAdd`.

getApprovalDescription

@Stability(value=Stable)
 @Nullable
default String getApprovalDescription()

A description provided when the model approval is set.

getCertifyForMarketplace

@Stability(value=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(value=Stable)
 @Nullable
default String getClientToken()

`AWS::SageMaker::ModelPackage.ClientToken`.

getCreatedBy

@Stability(value=Stable)
 @Nullable
default Object getCreatedBy()

`AWS::SageMaker::ModelPackage.CreatedBy`.

getCustomerMetadataProperties

@Stability(value=Stable)
 @Nullable
default Object getCustomerMetadataProperties()

The metadata properties for the model package.

getDomain

@Stability(value=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(value=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(value=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(value=Stable)
 @Nullable
default Object getInferenceSpecification()

`AWS::SageMaker::ModelPackage.InferenceSpecification`.

getLastModifiedBy

@Stability(value=Stable)
 @Nullable
default Object getLastModifiedBy()

`AWS::SageMaker::ModelPackage.LastModifiedBy`.

getLastModifiedTime

@Stability(value=Stable)
 @Nullable
default String getLastModifiedTime()

The last time the model package was modified.

getMetadataProperties

@Stability(value=Stable)
 @Nullable
default Object getMetadataProperties()

`AWS::SageMaker::ModelPackage.MetadataProperties`.

getModelApprovalStatus

@Stability(value=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(value=Stable)
 @Nullable
default Object getModelMetrics()

Metrics for the model.

getModelPackageDescription

@Stability(value=Stable)
 @Nullable
default String getModelPackageDescription()

The description of the model package.

getModelPackageGroupName

@Stability(value=Stable)
 @Nullable
default String getModelPackageGroupName()

The model group to which the model belongs.

getModelPackageName

@Stability(value=Stable)
 @Nullable
default String getModelPackageName()

The name of the model.

getModelPackageStatusDetails

@Stability(value=Stable)
 @Nullable
default Object getModelPackageStatusDetails()

`AWS::SageMaker::ModelPackage.ModelPackageStatusDetails`.

getModelPackageStatusItem

@Stability(value=Stable)
 @Nullable
default Object getModelPackageStatusItem()

`AWS::SageMaker::ModelPackage.ModelPackageStatusItem`.

getModelPackageVersion

@Stability(value=Stable)
 @Nullable
default Number getModelPackageVersion()

The version number of a versioned model.

getSamplePayloadUrl

@Stability(value=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(value=Stable)
 @Nullable
default Object getSourceAlgorithmSpecification()

`AWS::SageMaker::ModelPackage.SourceAlgorithmSpecification`.

getTags

@Stability(value=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(value=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(value=Stable)
 @Nullable
default Object getValidationSpecification()

`AWS::SageMaker::ModelPackage.ValidationSpecification`.

builder

@Stability(value=Stable)
static CfnModelPackageProps.Builder builder()

Returns:

a CfnModelPackageProps.Builder of CfnModelPackageProps