interface CfnModelExplainabilityJobDefinitionProps

Language	Type name
.NET	`Amazon.CDK.AWS.Sagemaker.CfnModelExplainabilityJobDefinitionProps`
Java	`software.amazon.awscdk.services.sagemaker.CfnModelExplainabilityJobDefinitionProps`
Python	`aws_cdk.aws_sagemaker.CfnModelExplainabilityJobDefinitionProps`
TypeScript	`@aws-cdk/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 * as sagemaker from '@aws-cdk/aws-sagemaker';

declare const json: any;
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: json,
        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

Name	Type	Description
jobResources	`IResolvable` `\|` `MonitoringResourcesProperty`	Identifies the resources to deploy for a monitoring job.
modelExplainabilityAppSpecification	`IResolvable` `\|` `ModelExplainabilityAppSpecificationProperty`	Configures the model explainability job to run a specified Docker container image.
modelExplainabilityJobInput	`IResolvable` `\|` `ModelExplainabilityJobInputProperty`	Inputs for the model explainability job.
modelExplainabilityJobOutputConfig	`IResolvable` `\|` `MonitoringOutputConfigProperty`	The output configuration for monitoring jobs.
roleArn	`string`	The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
endpointName?	`string`	`AWS::SageMaker::ModelExplainabilityJobDefinition.EndpointName`.
jobDefinitionName?	`string`	The name of the model explainability job definition.
modelExplainabilityBaselineConfig?	`IResolvable` `\|` `ModelExplainabilityBaselineConfigProperty`	The baseline configuration for a model explainability job.
networkConfig?	`IResolvable` `\|` `NetworkConfigProperty`	Networking options for a model explainability job.
stoppingCondition?	`IResolvable` `\|` `StoppingConditionProperty`	A 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.