CfnModelExplainabilityJobDefinitionProps Struct
Properties for defining a CfnModelExplainabilityJobDefinition.
| Source | |
|---|---|
| Type last changed |
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',
}],
};
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_explainability_job_definition_props = sagemaker.CfnModelExplainabilityJobDefinitionProps(
job_resources=sagemaker.CfnModelExplainabilityJobDefinition.MonitoringResourcesProperty(
cluster_config=sagemaker.CfnModelExplainabilityJobDefinition.ClusterConfigProperty(
instance_count=123,
instance_type="instanceType",
volume_size_in_gb=123,
# the properties below are optional
volume_kms_key_id="volumeKmsKeyId"
)
),
model_explainability_app_specification=sagemaker.CfnModelExplainabilityJobDefinition.ModelExplainabilityAppSpecificationProperty(
config_uri="configUri",
image_uri="imageUri",
# the properties below are optional
environment={
"environment_key": "environment"
}
),
model_explainability_job_input=sagemaker.CfnModelExplainabilityJobDefinition.ModelExplainabilityJobInputProperty(
batch_transform_input=sagemaker.CfnModelExplainabilityJobDefinition.BatchTransformInputProperty(
data_captured_destination_s3_uri="dataCapturedDestinationS3Uri",
dataset_format=sagemaker.CfnModelExplainabilityJobDefinition.DatasetFormatProperty(
csv=sagemaker.CfnModelExplainabilityJobDefinition.CsvProperty(
header=False
),
json=sagemaker.CfnModelExplainabilityJobDefinition.JsonProperty(
line=False
),
parquet=False
),
local_path="localPath",
# the properties below are optional
features_attribute="featuresAttribute",
inference_attribute="inferenceAttribute",
probability_attribute="probabilityAttribute",
s3_data_distribution_type="s3DataDistributionType",
s3_input_mode="s3InputMode"
),
endpoint_input=sagemaker.CfnModelExplainabilityJobDefinition.EndpointInputProperty(
endpoint_name="endpointName",
local_path="localPath",
# the properties below are optional
features_attribute="featuresAttribute",
inference_attribute="inferenceAttribute",
probability_attribute="probabilityAttribute",
s3_data_distribution_type="s3DataDistributionType",
s3_input_mode="s3InputMode"
)
),
model_explainability_job_output_config=sagemaker.CfnModelExplainabilityJobDefinition.MonitoringOutputConfigProperty(
monitoring_outputs=[sagemaker.CfnModelExplainabilityJobDefinition.MonitoringOutputProperty(
s3_output=sagemaker.CfnModelExplainabilityJobDefinition.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_explainability_baseline_config=sagemaker.CfnModelExplainabilityJobDefinition.ModelExplainabilityBaselineConfigProperty(
baselining_job_name="baseliningJobName",
constraints_resource=sagemaker.CfnModelExplainabilityJobDefinition.ConstraintsResourceProperty(
s3_uri="s3Uri"
)
),
network_config=sagemaker.CfnModelExplainabilityJobDefinition.NetworkConfigProperty(
enable_inter_container_traffic_encryption=False,
enable_network_isolation=False,
vpc_config=sagemaker.CfnModelExplainabilityJobDefinition.VpcConfigProperty(
security_group_ids=["securityGroupIds"],
subnets=["subnets"]
)
),
stopping_condition=sagemaker.CfnModelExplainabilityJobDefinition.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.*;
CfnModelExplainabilityJobDefinitionProps cfnModelExplainabilityJobDefinitionProps = CfnModelExplainabilityJobDefinitionProps.builder()
.jobResources(MonitoringResourcesProperty.builder()
.clusterConfig(ClusterConfigProperty.builder()
.instanceCount(123)
.instanceType("instanceType")
.volumeSizeInGb(123)
// the properties below are optional
.volumeKmsKeyId("volumeKmsKeyId")
.build())
.build())
.modelExplainabilityAppSpecification(ModelExplainabilityAppSpecificationProperty.builder()
.configUri("configUri")
.imageUri("imageUri")
// the properties below are optional
.environment(Map.of(
"environmentKey", "environment"))
.build())
.modelExplainabilityJobInput(ModelExplainabilityJobInputProperty.builder()
.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
.featuresAttribute("featuresAttribute")
.inferenceAttribute("inferenceAttribute")
.probabilityAttribute("probabilityAttribute")
.s3DataDistributionType("s3DataDistributionType")
.s3InputMode("s3InputMode")
.build())
.endpointInput(EndpointInputProperty.builder()
.endpointName("endpointName")
.localPath("localPath")
// the properties below are optional
.featuresAttribute("featuresAttribute")
.inferenceAttribute("inferenceAttribute")
.probabilityAttribute("probabilityAttribute")
.s3DataDistributionType("s3DataDistributionType")
.s3InputMode("s3InputMode")
.build())
.build())
.modelExplainabilityJobOutputConfig(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")
.modelExplainabilityBaselineConfig(ModelExplainabilityBaselineConfigProperty.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 cfnModelExplainabilityJobDefinitionProps = new CfnModelExplainabilityJobDefinitionProps {
JobResources = new MonitoringResourcesProperty {
ClusterConfig = new ClusterConfigProperty {
InstanceCount = 123,
InstanceType = "instanceType",
VolumeSizeInGb = 123,
// the properties below are optional
VolumeKmsKeyId = "volumeKmsKeyId"
}
},
ModelExplainabilityAppSpecification = new ModelExplainabilityAppSpecificationProperty {
ConfigUri = "configUri",
ImageUri = "imageUri",
// the properties below are optional
Environment = new Dictionary<string, string> {
{ "environmentKey", "environment" }
}
},
ModelExplainabilityJobInput = new ModelExplainabilityJobInputProperty {
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
FeaturesAttribute = "featuresAttribute",
InferenceAttribute = "inferenceAttribute",
ProbabilityAttribute = "probabilityAttribute",
S3DataDistributionType = "s3DataDistributionType",
S3InputMode = "s3InputMode"
},
EndpointInput = new EndpointInputProperty {
EndpointName = "endpointName",
LocalPath = "localPath",
// the properties below are optional
FeaturesAttribute = "featuresAttribute",
InferenceAttribute = "inferenceAttribute",
ProbabilityAttribute = "probabilityAttribute",
S3DataDistributionType = "s3DataDistributionType",
S3InputMode = "s3InputMode"
}
},
ModelExplainabilityJobOutputConfig = 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",
ModelExplainabilityBaselineConfig = new ModelExplainabilityBaselineConfigProperty {
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"
cfnModelExplainabilityJobDefinitionProps := &CfnModelExplainabilityJobDefinitionProps{
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"),
},
},
ModelExplainabilityAppSpecification: &ModelExplainabilityAppSpecificationProperty{
ConfigUri: jsii.String("configUri"),
ImageUri: jsii.String("imageUri"),
// the properties below are optional
Environment: map[string]*string{
"environmentKey": jsii.String("environment"),
},
},
ModelExplainabilityJobInput: &ModelExplainabilityJobInputProperty{
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
FeaturesAttribute: jsii.String("featuresAttribute"),
InferenceAttribute: jsii.String("inferenceAttribute"),
ProbabilityAttribute: jsii.String("probabilityAttribute"),
S3DataDistributionType: jsii.String("s3DataDistributionType"),
S3InputMode: jsii.String("s3InputMode"),
},
EndpointInput: &EndpointInputProperty{
EndpointName: jsii.String("endpointName"),
LocalPath: jsii.String("localPath"),
// the properties below are optional
FeaturesAttribute: jsii.String("featuresAttribute"),
InferenceAttribute: jsii.String("inferenceAttribute"),
ProbabilityAttribute: jsii.String("probabilityAttribute"),
S3DataDistributionType: jsii.String("s3DataDistributionType"),
S3InputMode: jsii.String("s3InputMode"),
},
},
ModelExplainabilityJobOutputConfig: &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"),
ModelExplainabilityBaselineConfig: &ModelExplainabilityBaselineConfigProperty{
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 model explainability job definition.
The name must be unique within an AWS Region in the AWS account.
jobResourcesIResolvable | CfnModelExplainabilityJobDefinition.job_resourcestyping.Union[IResolvable, MonitoringResourcesProperty]jobResourcesIResolvableJobResourcesIResolvableJobResourcesinterface{} required #Identifies the resources to deploy for a monitoring job.
modelExplainabilityAppSpecificationIResolvable | CfnModelExplainabilityJobDefinition.model_explainability_app_specificationtyping.Union[IResolvable, ModelExplainabilityAppSpecificationProperty]modelExplainabilityAppSpecificationIResolvableModelExplainabilityAppSpecificationIResolvableModelExplainabilityAppSpecificationinterface{} required #Configures the model explainability job to run a specified Docker container image.
modelExplainabilityBaselineConfigoptionalIResolvable | CfnModelExplainabilityJobDefinition.model_explainability_baseline_configoptionaltyping.Union[IResolvable, ModelExplainabilityBaselineConfigProperty]modelExplainabilityBaselineConfigoptionalIResolvableModelExplainabilityBaselineConfigoptionalIResolvableModelExplainabilityBaselineConfigoptionalinterface{} #The baseline configuration for a model explainability job.
modelExplainabilityJobInputIResolvable | CfnModelExplainabilityJobDefinition.model_explainability_job_inputtyping.Union[IResolvable, ModelExplainabilityJobInputProperty]modelExplainabilityJobInputIResolvableModelExplainabilityJobInputIResolvableModelExplainabilityJobInputinterface{} required #Inputs for the model explainability job.
modelExplainabilityJobOutputConfigIResolvable | CfnModelExplainabilityJobDefinition.model_explainability_job_output_configtyping.Union[IResolvable, MonitoringOutputConfigProperty]modelExplainabilityJobOutputConfigIResolvableModelExplainabilityJobOutputConfigIResolvableModelExplainabilityJobOutputConfiginterface{} required #The output configuration for monitoring jobs.
networkConfigoptionalIResolvable | CfnModelExplainabilityJobDefinition.network_configoptionaltyping.Union[IResolvable, NetworkConfigProperty]networkConfigoptionalIResolvableNetworkConfigoptionalIResolvableNetworkConfigoptionalinterface{} #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.
stoppingConditionoptionalIResolvable | CfnModelExplainabilityJobDefinition.stopping_conditionoptionaltyping.Union[IResolvable, StoppingConditionProperty]stoppingConditionoptionalIResolvableStoppingConditionoptionalIResolvableStoppingConditionoptionalinterface{} #A time limit for how long the monitoring job is allowed to run before stopping.