interface CfnModelQualityJobDefinitionProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Sagemaker.CfnModelQualityJobDefinitionProps |
Java | software.amazon.awscdk.services.sagemaker.CfnModelQualityJobDefinitionProps |
Python | aws_cdk.aws_sagemaker.CfnModelQualityJobDefinitionProps |
TypeScript | @aws-cdk/aws-sagemaker » CfnModelQualityJobDefinitionProps |
Properties for defining a CfnModelQualityJobDefinition
.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as sagemaker from '@aws-cdk/aws-sagemaker';
declare const json: any;
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: json,
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',
}],
};
Properties
Name | Type | Description |
---|---|---|
job | IResolvable | Monitoring | Identifies the resources to deploy for a monitoring job. |
model | IResolvable | Model | Container image configuration object for the monitoring job. |
model | IResolvable | Model | A list of the inputs that are monitored. |
model | IResolvable | Monitoring | The output configuration for monitoring jobs. |
role | string | The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. |
endpoint | string | AWS::SageMaker::ModelQualityJobDefinition.EndpointName . |
job | string | The name of the monitoring job definition. |
model | IResolvable | Model | Specifies the constraints and baselines for the monitoring job. |
network | IResolvable | Network | Specifies the network configuration for the monitoring job. |
stopping | IResolvable | Stopping | A time limit for how long the monitoring job is allowed to run before stopping. |
tags? | Cfn [] | An array of key-value pairs to apply to this resource. |
jobResources
Type:
IResolvable
|
Monitoring
Identifies the resources to deploy for a monitoring job.
modelQualityAppSpecification
Type:
IResolvable
|
Model
Container image configuration object for the monitoring job.
modelQualityJobInput
Type:
IResolvable
|
Model
A list of the inputs that are monitored.
Currently endpoints are supported.
modelQualityJobOutputConfig
Type:
IResolvable
|
Monitoring
The output configuration for monitoring jobs.
roleArn
Type:
string
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
endpointName?
Type:
string
(optional)
AWS::SageMaker::ModelQualityJobDefinition.EndpointName
.
jobDefinitionName?
Type:
string
(optional)
The name of the monitoring job definition.
modelQualityBaselineConfig?
Type:
IResolvable
|
Model
(optional)
Specifies the constraints and baselines for the monitoring job.
networkConfig?
Type:
IResolvable
|
Network
(optional)
Specifies the network configuration for the monitoring job.
stoppingCondition?
Type:
IResolvable
|
Stopping
(optional)
A time limit for how long the monitoring job is allowed to run before stopping.
tags?
Type:
Cfn
[]
(optional)
An array of key-value pairs to apply to this resource.
For more information, see Tag .