Package software.amazon.awscdk.services.sagemaker

Interface CfnModelExplainabilityJobDefinition.EndpointInputProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelExplainabilityJobDefinition.EndpointInputProperty.Jsii$Proxy

Enclosing class:

CfnModelExplainabilityJobDefinition

@Stability(Stable)
public static interface CfnModelExplainabilityJobDefinition.EndpointInputProperty
extends software.amazon.jsii.JsiiSerializable

Input object for the endpoint.

Example:

 // 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.*;
 EndpointInputProperty endpointInputProperty = EndpointInputProperty.builder()
         .endpointName("endpointName")
         .localPath("localPath")
         // the properties below are optional
         .featuresAttribute("featuresAttribute")
         .inferenceAttribute("inferenceAttribute")
         .probabilityAttribute("probabilityAttribute")
         .s3DataDistributionType("s3DataDistributionType")
         .s3InputMode("s3InputMode")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-endpointinput.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnModelExplainabilityJobDefinition.EndpointInputProperty.Builder	A builder for CfnModelExplainabilityJobDefinition.EndpointInputProperty
static final class	CfnModelExplainabilityJobDefinition.EndpointInputProperty.Jsii$Proxy	An implementation for CfnModelExplainabilityJobDefinition.EndpointInputProperty

Method Summary

Modifier and Type	Method	Description
static CfnModelExplainabilityJobDefinition.EndpointInputProperty.Builder	builder()
String	getEndpointName()	An endpoint in customer's account which has enabled DataCaptureConfig enabled.
default String	getFeaturesAttribute()	The attributes of the input data that are the input features.
default String	getInferenceAttribute()	The attribute of the input data that represents the ground truth label.
String	getLocalPath()	Path to the filesystem where the endpoint data is available to the container.
default String	getProbabilityAttribute()	In a classification problem, the attribute that represents the class probability.
default String	getS3DataDistributionType()	Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key.
default String	getS3InputMode()	Whether the Pipe or File is used as the input mode for transferring data for the monitoring job.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEndpointName

@Stability(Stable)
@NotNull
String getEndpointName()

An endpoint in customer's account which has enabled DataCaptureConfig enabled.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-endpointinput.html#cfn-sagemaker-modelexplainabilityjobdefinition-endpointinput-endpointname

getLocalPath

@Stability(Stable)
@NotNull
String getLocalPath()

Path to the filesystem where the endpoint data is available to the container.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-endpointinput.html#cfn-sagemaker-modelexplainabilityjobdefinition-endpointinput-localpath

getFeaturesAttribute

@Stability(Stable)
@Nullable
default String getFeaturesAttribute()

The attributes of the input data that are the input features.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-endpointinput.html#cfn-sagemaker-modelexplainabilityjobdefinition-endpointinput-featuresattribute

getInferenceAttribute

@Stability(Stable)
@Nullable
default String getInferenceAttribute()

The attribute of the input data that represents the ground truth label.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-endpointinput.html#cfn-sagemaker-modelexplainabilityjobdefinition-endpointinput-inferenceattribute

getProbabilityAttribute

@Stability(Stable)
@Nullable
default String getProbabilityAttribute()

In a classification problem, the attribute that represents the class probability.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-endpointinput.html#cfn-sagemaker-modelexplainabilityjobdefinition-endpointinput-probabilityattribute

getS3DataDistributionType

@Stability(Stable)
@Nullable
default String getS3DataDistributionType()

Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key.

Defaults to FullyReplicated

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-endpointinput.html#cfn-sagemaker-modelexplainabilityjobdefinition-endpointinput-s3datadistributiontype

getS3InputMode

@Stability(Stable)
@Nullable
default String getS3InputMode()

Whether the Pipe or File is used as the input mode for transferring data for the monitoring job.

Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-endpointinput.html#cfn-sagemaker-modelexplainabilityjobdefinition-endpointinput-s3inputmode

builder

@Stability(Stable)
static CfnModelExplainabilityJobDefinition.EndpointInputProperty.Builder builder()

Returns:

a CfnModelExplainabilityJobDefinition.EndpointInputProperty.Builder of CfnModelExplainabilityJobDefinition.EndpointInputProperty