@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-03-14T16:25:25.529Z")
public interface CfnModelPackageProps
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();
| Modifier and Type | Interface and Description |
|---|---|
static class |
CfnModelPackageProps.Builder
A builder for
CfnModelPackageProps |
static class |
CfnModelPackageProps.Jsii$Proxy
An implementation for
CfnModelPackageProps |
| Modifier and Type | Method and Description |
|---|---|
static CfnModelPackageProps.Builder |
builder() |
default java.lang.Object |
getAdditionalInferenceSpecificationDefinition()
A structure of additional Inference Specification.
|
default java.lang.Object |
getAdditionalInferenceSpecifications()
An array of additional Inference Specification objects.
|
default java.lang.Object |
getAdditionalInferenceSpecificationsToAdd()
An array of additional Inference Specification objects to be added to the existing array.
|
default java.lang.String |
getApprovalDescription()
A description provided when the model approval is set.
|
default java.lang.Object |
getCertifyForMarketplace()
Whether the model package is to be certified to be listed on AWS Marketplace.
|
default java.lang.String |
getClientToken()
A unique token that guarantees that the call to this API is idempotent.
|
default java.lang.Object |
getCreatedBy()
Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
|
default java.lang.Object |
getCustomerMetadataProperties()
The metadata properties for the model package.
|
default java.lang.String |
getDomain()
The machine learning domain of your model package and its components.
|
default java.lang.Object |
getDriftCheckBaselines()
Represents the drift check baselines that can be used when the model monitor is set using the model package.
|
default java.lang.Object |
getEnvironment()
The environment variables to set in the Docker container.
|
default java.lang.Object |
getInferenceSpecification()
Defines how to perform inference generation after a training job is run.
|
default java.lang.Object |
getLastModifiedBy()
Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
|
default java.lang.String |
getLastModifiedTime()
The last time the model package was modified.
|
default java.lang.Object |
getMetadataProperties()
Metadata properties of the tracking entity, trial, or trial component.
|
default java.lang.String |
getModelApprovalStatus()
The approval status of the model.
|
default java.lang.Object |
getModelMetrics()
Metrics for the model.
|
default java.lang.String |
getModelPackageDescription()
The description of the model package.
|
default java.lang.String |
getModelPackageGroupName()
The model group to which the model belongs.
|
default java.lang.String |
getModelPackageName()
The name of the model.
|
default java.lang.Object |
getModelPackageStatusDetails()
Specifies the validation and image scan statuses of the model package.
|
default java.lang.Object |
getModelPackageStatusItem()
Represents the overall status of a model package.
|
default java.lang.Number |
getModelPackageVersion()
The version number of a versioned model.
|
default java.lang.String |
getSamplePayloadUrl()
The Amazon Simple Storage Service path where the sample payload are stored.
|
default java.lang.Object |
getSourceAlgorithmSpecification()
A list of algorithms that were used to create a model package.
|
default java.util.List<CfnTag> |
getTags()
A list of the tags associated with the model package.
|
default java.lang.String |
getTask()
The machine learning task your model package accomplishes.
|
default java.lang.Object |
getValidationSpecification()
Specifies batch transform jobs that SageMaker runs to validate your model package.
|
default java.lang.Object getAdditionalInferenceSpecificationDefinition()
Additional Inference Specification specifies details about inference jobs that can be run with models based on this model package
default java.lang.Object getAdditionalInferenceSpecifications()
default java.lang.Object getAdditionalInferenceSpecificationsToAdd()
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.
default java.lang.String getApprovalDescription()
default java.lang.Object getCertifyForMarketplace()
For information about listing model packages on AWS Marketplace, see List Your Algorithm or Model Package on AWS Marketplace .
default java.lang.String getClientToken()
default java.lang.Object getCreatedBy()
default java.lang.Object getCustomerMetadataProperties()
default java.lang.String getDomain()
Common machine learning domains include computer vision and natural language processing.
default java.lang.Object getDriftCheckBaselines()
default java.lang.Object getEnvironment()
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.
default java.lang.Object getInferenceSpecification()
default java.lang.Object getLastModifiedBy()
default java.lang.String getLastModifiedTime()
default java.lang.Object getMetadataProperties()
default java.lang.String getModelApprovalStatus()
APPROVED - The model is approvedREJECTED - The model is rejected.PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.default java.lang.Object getModelMetrics()
default java.lang.String getModelPackageDescription()
default java.lang.String getModelPackageGroupName()
default java.lang.String getModelPackageName()
default java.lang.Object getModelPackageStatusDetails()
default java.lang.Object getModelPackageStatusItem()
default java.lang.Number getModelPackageVersion()
default java.lang.String getSamplePayloadUrl()
This path must point to a single gzip compressed tar archive (.tar.gz suffix).
default java.lang.Object getSourceAlgorithmSpecification()
default java.util.List<CfnTag> getTags()
For more information, see Tagging AWS resources in the AWS General Reference Guide .
default java.lang.String getTask()
Common machine learning tasks include object detection and image classification.
default java.lang.Object getValidationSpecification()
static CfnModelPackageProps.Builder builder()
CfnModelPackageProps.Builder of CfnModelPackageProps