AWS CDK Reference

Appearance

v2.277.0

ModelExplainabilityJobInputProperty Struct ​

Inputs for the model explainability job.

Source
Generated code
Type last changed
v2.93.0 · 23 Aug 2023

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 modelExplainabilityJobInputProperty: sagemaker.CfnModelExplainabilityJobDefinition.ModelExplainabilityJobInputProperty = {
  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',
  },
};
python
# 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

model_explainability_job_input_property = 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"
    )
)
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.*;

ModelExplainabilityJobInputProperty modelExplainabilityJobInputProperty = 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();
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 modelExplainabilityJobInputProperty = 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"
    }
};
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"

modelExplainabilityJobInputProperty := &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"),
	},
}

Properties ​

batchTransformInputoptionalIResolvable | CfnModelExplainabilityJobDefinition.BatchTransformInputPropertybatch_transform_inputoptionaltyping.Union[IResolvable, BatchTransformInputProperty]batchTransformInputoptionalIResolvableBatchTransformInputoptionalIResolvableBatchTransformInputoptionalinterface{}#
Input object for the batch transform job.
endpointInputoptionalIResolvable | CfnModelExplainabilityJobDefinition.EndpointInputPropertyendpoint_inputoptionaltyping.Union[IResolvable, EndpointInputProperty]endpointInputoptionalIResolvableEndpointInputoptionalIResolvableEndpointInputoptionalinterface{}#
Input object for the endpoint.