aws-cdk-lib.aws_sagemaker.CfnModelExplainabilityJobDefinitionProps

interface CfnModelExplainabilityJobDefinitionProps

LanguageType name
.NETAmazon.CDK.AWS.Sagemaker.CfnModelExplainabilityJobDefinitionProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnModelExplainabilityJobDefinitionProps
Javasoftware.amazon.awscdk.services.sagemaker.CfnModelExplainabilityJobDefinitionProps
Pythonaws_cdk.aws_sagemaker.CfnModelExplainabilityJobDefinitionProps
TypeScript aws-cdk-lib » aws_sagemaker » CfnModelExplainabilityJobDefinitionProps

Properties for defining a CfnModelExplainabilityJobDefinition.

Example

// 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

NameTypeDescription
jobResourcesIResolvable | MonitoringResourcesPropertyIdentifies the resources to deploy for a monitoring job.
modelExplainabilityAppSpecificationIResolvable | ModelExplainabilityAppSpecificationPropertyConfigures the model explainability job to run a specified Docker container image.
modelExplainabilityJobInputIResolvable | ModelExplainabilityJobInputPropertyInputs for the model explainability job.
modelExplainabilityJobOutputConfigIResolvable | MonitoringOutputConfigPropertyThe output configuration for monitoring jobs.
roleArnstringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
endpointName?stringAWS::SageMaker::ModelExplainabilityJobDefinition.EndpointName.
jobDefinitionName?stringThe name of the model explainability job definition.
modelExplainabilityBaselineConfig?IResolvable | ModelExplainabilityBaselineConfigPropertyThe baseline configuration for a model explainability job.
networkConfig?IResolvable | NetworkConfigPropertyNetworking options for a model explainability job.
stoppingCondition?IResolvable | StoppingConditionPropertyA time limit for how long the monitoring job is allowed to run before stopping.
tags?CfnTag[]An array of key-value pairs to apply to this resource.

jobResources

Type: IResolvable | MonitoringResourcesProperty

Identifies the resources to deploy for a monitoring job.


modelExplainabilityAppSpecification

Type: IResolvable | ModelExplainabilityAppSpecificationProperty

Configures the model explainability job to run a specified Docker container image.


modelExplainabilityJobInput

Type: IResolvable | ModelExplainabilityJobInputProperty

Inputs for the model explainability job.


modelExplainabilityJobOutputConfig

Type: IResolvable | MonitoringOutputConfigProperty

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::ModelExplainabilityJobDefinition.EndpointName.


jobDefinitionName?

Type: string (optional)

The name of the model explainability job definition.

The name must be unique within an AWS Region in the AWS account.


modelExplainabilityBaselineConfig?

Type: IResolvable | ModelExplainabilityBaselineConfigProperty (optional)

The baseline configuration for a model explainability job.


networkConfig?

Type: IResolvable | NetworkConfigProperty (optional)

Networking options for a model explainability job.


stoppingCondition?

Type: IResolvable | StoppingConditionProperty (optional)

A time limit for how long the monitoring job is allowed to run before stopping.


tags?

Type: CfnTag[] (optional)

An array of key-value pairs to apply to this resource.

For more information, see Tag .