CfnModelQualityJobDefinitionProps Struct
Properties for defining a CfnModelQualityJobDefinition.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const cfnModelQualityJobDefinitionProps: sagemaker.CfnModelQualityJobDefinitionProps = {
jobResources: {
clusterConfig: {
instanceCount: 123,
instanceType: 'instanceType',
volumeSizeInGb: 123,
// the properties below are optional
volumeKmsKeyId: 'volumeKmsKeyId',
},
},
modelQualityAppSpecification: {
imageUri: 'imageUri',
problemType: 'problemType',
// the properties below are optional
containerArguments: ['containerArguments'],
containerEntrypoint: ['containerEntrypoint'],
environment: {
environmentKey: 'environment',
},
postAnalyticsProcessorSourceUri: 'postAnalyticsProcessorSourceUri',
recordPreprocessorSourceUri: 'recordPreprocessorSourceUri',
},
modelQualityJobInput: {
groundTruthS3Input: {
s3Uri: 's3Uri',
},
// the properties below are optional
batchTransformInput: {
dataCapturedDestinationS3Uri: 'dataCapturedDestinationS3Uri',
datasetFormat: {
csv: {
header: false,
},
json: {
line: false,
},
parquet: false,
},
localPath: 'localPath',
// the properties below are optional
endTimeOffset: 'endTimeOffset',
inferenceAttribute: 'inferenceAttribute',
probabilityAttribute: 'probabilityAttribute',
probabilityThresholdAttribute: 123,
s3DataDistributionType: 's3DataDistributionType',
s3InputMode: 's3InputMode',
startTimeOffset: 'startTimeOffset',
},
endpointInput: {
endpointName: 'endpointName',
localPath: 'localPath',
// the properties below are optional
endTimeOffset: 'endTimeOffset',
inferenceAttribute: 'inferenceAttribute',
probabilityAttribute: 'probabilityAttribute',
probabilityThresholdAttribute: 123,
s3DataDistributionType: 's3DataDistributionType',
s3InputMode: 's3InputMode',
startTimeOffset: 'startTimeOffset',
},
},
modelQualityJobOutputConfig: {
monitoringOutputs: [{
s3Output: {
localPath: 'localPath',
s3Uri: 's3Uri',
// the properties below are optional
s3UploadMode: 's3UploadMode',
},
}],
// the properties below are optional
kmsKeyId: 'kmsKeyId',
},
roleArn: 'roleArn',
// the properties below are optional
endpointName: 'endpointName',
jobDefinitionName: 'jobDefinitionName',
modelQualityBaselineConfig: {
baseliningJobName: 'baseliningJobName',
constraintsResource: {
s3Uri: 's3Uri',
},
},
networkConfig: {
enableInterContainerTrafficEncryption: false,
enableNetworkIsolation: false,
vpcConfig: {
securityGroupIds: ['securityGroupIds'],
subnets: ['subnets'],
},
},
stoppingCondition: {
maxRuntimeInSeconds: 123,
},
tags: [{
key: 'key',
value: 'value',
}],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker
cfn_model_quality_job_definition_props = sagemaker.CfnModelQualityJobDefinitionProps(
job_resources=sagemaker.CfnModelQualityJobDefinition.MonitoringResourcesProperty(
cluster_config=sagemaker.CfnModelQualityJobDefinition.ClusterConfigProperty(
instance_count=123,
instance_type="instanceType",
volume_size_in_gb=123,
# the properties below are optional
volume_kms_key_id="volumeKmsKeyId"
)
),
model_quality_app_specification=sagemaker.CfnModelQualityJobDefinition.ModelQualityAppSpecificationProperty(
image_uri="imageUri",
problem_type="problemType",
# the properties below are optional
container_arguments=["containerArguments"],
container_entrypoint=["containerEntrypoint"],
environment={
"environment_key": "environment"
},
post_analytics_processor_source_uri="postAnalyticsProcessorSourceUri",
record_preprocessor_source_uri="recordPreprocessorSourceUri"
),
model_quality_job_input=sagemaker.CfnModelQualityJobDefinition.ModelQualityJobInputProperty(
ground_truth_s3_input=sagemaker.CfnModelQualityJobDefinition.MonitoringGroundTruthS3InputProperty(
s3_uri="s3Uri"
),
# the properties below are optional
batch_transform_input=sagemaker.CfnModelQualityJobDefinition.BatchTransformInputProperty(
data_captured_destination_s3_uri="dataCapturedDestinationS3Uri",
dataset_format=sagemaker.CfnModelQualityJobDefinition.DatasetFormatProperty(
csv=sagemaker.CfnModelQualityJobDefinition.CsvProperty(
header=False
),
json=sagemaker.CfnModelQualityJobDefinition.JsonProperty(
line=False
),
parquet=False
),
local_path="localPath",
# the properties below are optional
end_time_offset="endTimeOffset",
inference_attribute="inferenceAttribute",
probability_attribute="probabilityAttribute",
probability_threshold_attribute=123,
s3_data_distribution_type="s3DataDistributionType",
s3_input_mode="s3InputMode",
start_time_offset="startTimeOffset"
),
endpoint_input=sagemaker.CfnModelQualityJobDefinition.EndpointInputProperty(
endpoint_name="endpointName",
local_path="localPath",
# the properties below are optional
end_time_offset="endTimeOffset",
inference_attribute="inferenceAttribute",
probability_attribute="probabilityAttribute",
probability_threshold_attribute=123,
s3_data_distribution_type="s3DataDistributionType",
s3_input_mode="s3InputMode",
start_time_offset="startTimeOffset"
)
),
model_quality_job_output_config=sagemaker.CfnModelQualityJobDefinition.MonitoringOutputConfigProperty(
monitoring_outputs=[sagemaker.CfnModelQualityJobDefinition.MonitoringOutputProperty(
s3_output=sagemaker.CfnModelQualityJobDefinition.S3OutputProperty(
local_path="localPath",
s3_uri="s3Uri",
# the properties below are optional
s3_upload_mode="s3UploadMode"
)
)],
# the properties below are optional
kms_key_id="kmsKeyId"
),
role_arn="roleArn",
# the properties below are optional
endpoint_name="endpointName",
job_definition_name="jobDefinitionName",
model_quality_baseline_config=sagemaker.CfnModelQualityJobDefinition.ModelQualityBaselineConfigProperty(
baselining_job_name="baseliningJobName",
constraints_resource=sagemaker.CfnModelQualityJobDefinition.ConstraintsResourceProperty(
s3_uri="s3Uri"
)
),
network_config=sagemaker.CfnModelQualityJobDefinition.NetworkConfigProperty(
enable_inter_container_traffic_encryption=False,
enable_network_isolation=False,
vpc_config=sagemaker.CfnModelQualityJobDefinition.VpcConfigProperty(
security_group_ids=["securityGroupIds"],
subnets=["subnets"]
)
),
stopping_condition=sagemaker.CfnModelQualityJobDefinition.StoppingConditionProperty(
max_runtime_in_seconds=123
),
tags=[CfnTag(
key="key",
value="value"
)]
)
java
// 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.*;
CfnModelQualityJobDefinitionProps cfnModelQualityJobDefinitionProps = CfnModelQualityJobDefinitionProps.builder()
.jobResources(MonitoringResourcesProperty.builder()
.clusterConfig(ClusterConfigProperty.builder()
.instanceCount(123)
.instanceType("instanceType")
.volumeSizeInGb(123)
// the properties below are optional
.volumeKmsKeyId("volumeKmsKeyId")
.build())
.build())
.modelQualityAppSpecification(ModelQualityAppSpecificationProperty.builder()
.imageUri("imageUri")
.problemType("problemType")
// the properties below are optional
.containerArguments(List.of("containerArguments"))
.containerEntrypoint(List.of("containerEntrypoint"))
.environment(Map.of(
"environmentKey", "environment"))
.postAnalyticsProcessorSourceUri("postAnalyticsProcessorSourceUri")
.recordPreprocessorSourceUri("recordPreprocessorSourceUri")
.build())
.modelQualityJobInput(ModelQualityJobInputProperty.builder()
.groundTruthS3Input(MonitoringGroundTruthS3InputProperty.builder()
.s3Uri("s3Uri")
.build())
// the properties below are optional
.batchTransformInput(BatchTransformInputProperty.builder()
.dataCapturedDestinationS3Uri("dataCapturedDestinationS3Uri")
.datasetFormat(DatasetFormatProperty.builder()
.csv(CsvProperty.builder()
.header(false)
.build())
.json(JsonProperty.builder()
.line(false)
.build())
.parquet(false)
.build())
.localPath("localPath")
// the properties below are optional
.endTimeOffset("endTimeOffset")
.inferenceAttribute("inferenceAttribute")
.probabilityAttribute("probabilityAttribute")
.probabilityThresholdAttribute(123)
.s3DataDistributionType("s3DataDistributionType")
.s3InputMode("s3InputMode")
.startTimeOffset("startTimeOffset")
.build())
.endpointInput(EndpointInputProperty.builder()
.endpointName("endpointName")
.localPath("localPath")
// the properties below are optional
.endTimeOffset("endTimeOffset")
.inferenceAttribute("inferenceAttribute")
.probabilityAttribute("probabilityAttribute")
.probabilityThresholdAttribute(123)
.s3DataDistributionType("s3DataDistributionType")
.s3InputMode("s3InputMode")
.startTimeOffset("startTimeOffset")
.build())
.build())
.modelQualityJobOutputConfig(MonitoringOutputConfigProperty.builder()
.monitoringOutputs(List.of(MonitoringOutputProperty.builder()
.s3Output(S3OutputProperty.builder()
.localPath("localPath")
.s3Uri("s3Uri")
// the properties below are optional
.s3UploadMode("s3UploadMode")
.build())
.build()))
// the properties below are optional
.kmsKeyId("kmsKeyId")
.build())
.roleArn("roleArn")
// the properties below are optional
.endpointName("endpointName")
.jobDefinitionName("jobDefinitionName")
.modelQualityBaselineConfig(ModelQualityBaselineConfigProperty.builder()
.baseliningJobName("baseliningJobName")
.constraintsResource(ConstraintsResourceProperty.builder()
.s3Uri("s3Uri")
.build())
.build())
.networkConfig(NetworkConfigProperty.builder()
.enableInterContainerTrafficEncryption(false)
.enableNetworkIsolation(false)
.vpcConfig(VpcConfigProperty.builder()
.securityGroupIds(List.of("securityGroupIds"))
.subnets(List.of("subnets"))
.build())
.build())
.stoppingCondition(StoppingConditionProperty.builder()
.maxRuntimeInSeconds(123)
.build())
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;
var cfnModelQualityJobDefinitionProps = new CfnModelQualityJobDefinitionProps {
JobResources = new MonitoringResourcesProperty {
ClusterConfig = new ClusterConfigProperty {
InstanceCount = 123,
InstanceType = "instanceType",
VolumeSizeInGb = 123,
// the properties below are optional
VolumeKmsKeyId = "volumeKmsKeyId"
}
},
ModelQualityAppSpecification = new ModelQualityAppSpecificationProperty {
ImageUri = "imageUri",
ProblemType = "problemType",
// the properties below are optional
ContainerArguments = new [] { "containerArguments" },
ContainerEntrypoint = new [] { "containerEntrypoint" },
Environment = new Dictionary<string, string> {
{ "environmentKey", "environment" }
},
PostAnalyticsProcessorSourceUri = "postAnalyticsProcessorSourceUri",
RecordPreprocessorSourceUri = "recordPreprocessorSourceUri"
},
ModelQualityJobInput = new ModelQualityJobInputProperty {
GroundTruthS3Input = new MonitoringGroundTruthS3InputProperty {
S3Uri = "s3Uri"
},
// the properties below are optional
BatchTransformInput = new BatchTransformInputProperty {
DataCapturedDestinationS3Uri = "dataCapturedDestinationS3Uri",
DatasetFormat = new DatasetFormatProperty {
Csv = new CsvProperty {
Header = false
},
Json = new JsonProperty {
Line = false
},
Parquet = false
},
LocalPath = "localPath",
// the properties below are optional
EndTimeOffset = "endTimeOffset",
InferenceAttribute = "inferenceAttribute",
ProbabilityAttribute = "probabilityAttribute",
ProbabilityThresholdAttribute = 123,
S3DataDistributionType = "s3DataDistributionType",
S3InputMode = "s3InputMode",
StartTimeOffset = "startTimeOffset"
},
EndpointInput = new EndpointInputProperty {
EndpointName = "endpointName",
LocalPath = "localPath",
// the properties below are optional
EndTimeOffset = "endTimeOffset",
InferenceAttribute = "inferenceAttribute",
ProbabilityAttribute = "probabilityAttribute",
ProbabilityThresholdAttribute = 123,
S3DataDistributionType = "s3DataDistributionType",
S3InputMode = "s3InputMode",
StartTimeOffset = "startTimeOffset"
}
},
ModelQualityJobOutputConfig = new MonitoringOutputConfigProperty {
MonitoringOutputs = new [] { new MonitoringOutputProperty {
S3Output = new S3OutputProperty {
LocalPath = "localPath",
S3Uri = "s3Uri",
// the properties below are optional
S3UploadMode = "s3UploadMode"
}
} },
// the properties below are optional
KmsKeyId = "kmsKeyId"
},
RoleArn = "roleArn",
// the properties below are optional
EndpointName = "endpointName",
JobDefinitionName = "jobDefinitionName",
ModelQualityBaselineConfig = new ModelQualityBaselineConfigProperty {
BaseliningJobName = "baseliningJobName",
ConstraintsResource = new ConstraintsResourceProperty {
S3Uri = "s3Uri"
}
},
NetworkConfig = new NetworkConfigProperty {
EnableInterContainerTrafficEncryption = false,
EnableNetworkIsolation = false,
VpcConfig = new VpcConfigProperty {
SecurityGroupIds = new [] { "securityGroupIds" },
Subnets = new [] { "subnets" }
}
},
StoppingCondition = new StoppingConditionProperty {
MaxRuntimeInSeconds = 123
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnModelQualityJobDefinitionProps := &CfnModelQualityJobDefinitionProps{
JobResources: &MonitoringResourcesProperty{
ClusterConfig: &ClusterConfigProperty{
InstanceCount: jsii.Number(123),
InstanceType: jsii.String("instanceType"),
VolumeSizeInGb: jsii.Number(123),
// the properties below are optional
VolumeKmsKeyId: jsii.String("volumeKmsKeyId"),
},
},
ModelQualityAppSpecification: &ModelQualityAppSpecificationProperty{
ImageUri: jsii.String("imageUri"),
ProblemType: jsii.String("problemType"),
// the properties below are optional
ContainerArguments: []*string{
jsii.String("containerArguments"),
},
ContainerEntrypoint: []*string{
jsii.String("containerEntrypoint"),
},
Environment: map[string]*string{
"environmentKey": jsii.String("environment"),
},
PostAnalyticsProcessorSourceUri: jsii.String("postAnalyticsProcessorSourceUri"),
RecordPreprocessorSourceUri: jsii.String("recordPreprocessorSourceUri"),
},
ModelQualityJobInput: &ModelQualityJobInputProperty{
GroundTruthS3Input: &MonitoringGroundTruthS3InputProperty{
S3Uri: jsii.String("s3Uri"),
},
// the properties below are optional
BatchTransformInput: &BatchTransformInputProperty{
DataCapturedDestinationS3Uri: jsii.String("dataCapturedDestinationS3Uri"),
DatasetFormat: &DatasetFormatProperty{
Csv: &CsvProperty{
Header: jsii.Boolean(false),
},
Json: &JsonProperty{
Line: jsii.Boolean(false),
},
Parquet: jsii.Boolean(false),
},
LocalPath: jsii.String("localPath"),
// the properties below are optional
EndTimeOffset: jsii.String("endTimeOffset"),
InferenceAttribute: jsii.String("inferenceAttribute"),
ProbabilityAttribute: jsii.String("probabilityAttribute"),
ProbabilityThresholdAttribute: jsii.Number(123),
S3DataDistributionType: jsii.String("s3DataDistributionType"),
S3InputMode: jsii.String("s3InputMode"),
StartTimeOffset: jsii.String("startTimeOffset"),
},
EndpointInput: &EndpointInputProperty{
EndpointName: jsii.String("endpointName"),
LocalPath: jsii.String("localPath"),
// the properties below are optional
EndTimeOffset: jsii.String("endTimeOffset"),
InferenceAttribute: jsii.String("inferenceAttribute"),
ProbabilityAttribute: jsii.String("probabilityAttribute"),
ProbabilityThresholdAttribute: jsii.Number(123),
S3DataDistributionType: jsii.String("s3DataDistributionType"),
S3InputMode: jsii.String("s3InputMode"),
StartTimeOffset: jsii.String("startTimeOffset"),
},
},
ModelQualityJobOutputConfig: &MonitoringOutputConfigProperty{
MonitoringOutputs: []interface{}{
&MonitoringOutputProperty{
S3Output: &S3OutputProperty{
LocalPath: jsii.String("localPath"),
S3Uri: jsii.String("s3Uri"),
// the properties below are optional
S3UploadMode: jsii.String("s3UploadMode"),
},
},
},
// the properties below are optional
KmsKeyId: jsii.String("kmsKeyId"),
},
RoleArn: jsii.String("roleArn"),
// the properties below are optional
EndpointName: jsii.String("endpointName"),
JobDefinitionName: jsii.String("jobDefinitionName"),
ModelQualityBaselineConfig: &ModelQualityBaselineConfigProperty{
BaseliningJobName: jsii.String("baseliningJobName"),
ConstraintsResource: &ConstraintsResourceProperty{
S3Uri: jsii.String("s3Uri"),
},
},
NetworkConfig: &NetworkConfigProperty{
EnableInterContainerTrafficEncryption: jsii.Boolean(false),
EnableNetworkIsolation: jsii.Boolean(false),
VpcConfig: &VpcConfigProperty{
SecurityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
Subnets: []*string{
jsii.String("subnets"),
},
},
},
StoppingCondition: &StoppingConditionProperty{
MaxRuntimeInSeconds: jsii.Number(123),
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
Properties
endpointNameoptionalstringendpoint_nameoptionalstrendpointNameoptionalStringEndpointNameoptionalstringEndpointNameoptional*string#The name of the endpoint used to run the monitoring job.
jobDefinitionNameoptionalstringjob_definition_nameoptionalstrjobDefinitionNameoptionalStringJobDefinitionNameoptionalstringJobDefinitionNameoptional*string#The name of the monitoring job definition.
jobResourcesIResolvable | CfnModelQualityJobDefinition.MonitoringResourcesPropertyjob_resourcestyping.Union[IResolvable, MonitoringResourcesProperty]jobResourcesIResolvableJobResourcesIResolvableJobResourcesinterface{}required#Identifies the resources to deploy for a monitoring job.
modelQualityAppSpecificationIResolvable | CfnModelQualityJobDefinition.ModelQualityAppSpecificationPropertymodel_quality_app_specificationtyping.Union[IResolvable, ModelQualityAppSpecificationProperty]modelQualityAppSpecificationIResolvableModelQualityAppSpecificationIResolvableModelQualityAppSpecificationinterface{}required#Container image configuration object for the monitoring job.
modelQualityBaselineConfigoptionalIResolvable | CfnModelQualityJobDefinition.ModelQualityBaselineConfigPropertymodel_quality_baseline_configoptionaltyping.Union[IResolvable, ModelQualityBaselineConfigProperty]modelQualityBaselineConfigoptionalIResolvableModelQualityBaselineConfigoptionalIResolvableModelQualityBaselineConfigoptionalinterface{}#Specifies the constraints and baselines for the monitoring job.
modelQualityJobInputIResolvable | CfnModelQualityJobDefinition.ModelQualityJobInputPropertymodel_quality_job_inputtyping.Union[IResolvable, ModelQualityJobInputProperty]modelQualityJobInputIResolvableModelQualityJobInputIResolvableModelQualityJobInputinterface{}required#A list of the inputs that are monitored.
Currently endpoints are supported.
modelQualityJobOutputConfigIResolvable | CfnModelQualityJobDefinition.MonitoringOutputConfigPropertymodel_quality_job_output_configtyping.Union[IResolvable, MonitoringOutputConfigProperty]modelQualityJobOutputConfigIResolvableModelQualityJobOutputConfigIResolvableModelQualityJobOutputConfiginterface{}required#The output configuration for monitoring jobs.
networkConfigoptionalIResolvable | CfnModelQualityJobDefinition.NetworkConfigPropertynetwork_configoptionaltyping.Union[IResolvable, NetworkConfigProperty]networkConfigoptionalIResolvableNetworkConfigoptionalIResolvableNetworkConfigoptionalinterface{}#Specifies the network configuration for the monitoring job.
roleArnstring | IRoleRefrole_arntyping.Union[str, IRoleRef]roleArnStringRoleArnstringRoleArninterface{}required#The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
stoppingConditionoptionalIResolvable | CfnModelQualityJobDefinition.StoppingConditionPropertystopping_conditionoptionaltyping.Union[IResolvable, StoppingConditionProperty]stoppingConditionoptionalIResolvableStoppingConditionoptionalIResolvableStoppingConditionoptionalinterface{}#A time limit for how long the monitoring job is allowed to run before stopping.