CfnModelExplainabilityJobDefinitionProps Struct
Properties for defining a CfnModelExplainabilityJobDefinition.
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 cfnModelExplainabilityJobDefinitionProps: sagemaker.CfnModelExplainabilityJobDefinitionProps = {
jobResources: {
clusterConfig: {
instanceCount: 123,
instanceType: 'instanceType',
volumeSizeInGb: 123,
// the properties below are optional
volumeKmsKeyId: 'volumeKmsKeyId',
},
},
modelExplainabilityAppSpecification: {
configUri: 'configUri',
imageUri: 'imageUri',
// the properties below are optional
environment: {
environmentKey: 'environment',
},
},
modelExplainabilityJobInput: {
batchTransformInput: {
dataCapturedDestinationS3Uri: 'dataCapturedDestinationS3Uri',
datasetFormat: {
csv: {
header: false,
},
json: {
line: false,
},
parquet: false,
},
localPath: 'localPath',
// the properties below are optional
featuresAttribute: 'featuresAttribute',
inferenceAttribute: 'inferenceAttribute',
probabilityAttribute: 'probabilityAttribute',
s3DataDistributionType: 's3DataDistributionType',
s3InputMode: 's3InputMode',
},
endpointInput: {
endpointName: 'endpointName',
localPath: 'localPath',
// the properties below are optional
featuresAttribute: 'featuresAttribute',
inferenceAttribute: 'inferenceAttribute',
probabilityAttribute: 'probabilityAttribute',
s3DataDistributionType: 's3DataDistributionType',
s3InputMode: 's3InputMode',
},
},
modelExplainabilityJobOutputConfig: {
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',
modelExplainabilityBaselineConfig: {
baseliningJobName: 'baseliningJobName',
constraintsResource: {
s3Uri: 's3Uri',
},
},
networkConfig: {
enableInterContainerTrafficEncryption: false,
enableNetworkIsolation: false,
vpcConfig: {
securityGroupIds: ['securityGroupIds'],
subnets: ['subnets'],
},
},
stoppingCondition: {
maxRuntimeInSeconds: 123,
},
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
The name of the endpoint used to run the monitoring job.
jobDefinitionNamestringjob_definition_namestrjobDefinitionNameStringJobDefinitionNamestringJobDefinitionName*string#The name of the model explainability job definition.
The name must be unique within an AWS Region in the AWS account.
jobResourcesIResolvable | CfnModelExplainabilityJobDefinition.MonitoringResourcesPropertyjob_resourcestyping.Union[IResolvable, MonitoringResourcesProperty]jobResourcesIResolvableJobResourcesIResolvableJobResourcesinterface{}required#Identifies the resources to deploy for a monitoring job.
modelExplainabilityAppSpecificationIResolvable | CfnModelExplainabilityJobDefinition.ModelExplainabilityAppSpecificationPropertymodel_explainability_app_specificationtyping.Union[IResolvable, ModelExplainabilityAppSpecificationProperty]modelExplainabilityAppSpecificationIResolvableModelExplainabilityAppSpecificationIResolvableModelExplainabilityAppSpecificationinterface{}required#Configures the model explainability job to run a specified Docker container image.
modelExplainabilityBaselineConfigIResolvable | CfnModelExplainabilityJobDefinition.ModelExplainabilityBaselineConfigPropertymodel_explainability_baseline_configtyping.Union[IResolvable, ModelExplainabilityBaselineConfigProperty]modelExplainabilityBaselineConfigIResolvableModelExplainabilityBaselineConfigIResolvableModelExplainabilityBaselineConfiginterface{}#The baseline configuration for a model explainability job.
modelExplainabilityJobInputIResolvable | CfnModelExplainabilityJobDefinition.ModelExplainabilityJobInputPropertymodel_explainability_job_inputtyping.Union[IResolvable, ModelExplainabilityJobInputProperty]modelExplainabilityJobInputIResolvableModelExplainabilityJobInputIResolvableModelExplainabilityJobInputinterface{}required#Inputs for the model explainability job.
modelExplainabilityJobOutputConfigIResolvable | CfnModelExplainabilityJobDefinition.MonitoringOutputConfigPropertymodel_explainability_job_output_configtyping.Union[IResolvable, MonitoringOutputConfigProperty]modelExplainabilityJobOutputConfigIResolvableModelExplainabilityJobOutputConfigIResolvableModelExplainabilityJobOutputConfiginterface{}required#The output configuration for monitoring jobs.
networkConfigIResolvable | CfnModelExplainabilityJobDefinition.NetworkConfigPropertynetwork_configtyping.Union[IResolvable, NetworkConfigProperty]networkConfigIResolvableNetworkConfigIResolvableNetworkConfiginterface{}#Networking options for a model explainability 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.
stoppingConditionIResolvable | CfnModelExplainabilityJobDefinition.StoppingConditionPropertystopping_conditiontyping.Union[IResolvable, StoppingConditionProperty]stoppingConditionIResolvableStoppingConditionIResolvableStoppingConditioninterface{}#A time limit for how long the monitoring job is allowed to run before stopping.