interface EndpointInputProperty

Language	Type name
.NET	Amazon.CDK.AWS.Sagemaker.CfnModelBiasJobDefinition.EndpointInputProperty
Java	software.amazon.awscdk.services.sagemaker.CfnModelBiasJobDefinition.EndpointInputProperty
Python	aws_cdk.aws_sagemaker.CfnModelBiasJobDefinition.EndpointInputProperty
TypeScript	@aws-cdk/aws-sagemaker » CfnModelBiasJobDefinition » EndpointInputProperty

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 * as sagemaker from '@aws-cdk/aws-sagemaker';
const endpointInputProperty: sagemaker.CfnModelBiasJobDefinition.EndpointInputProperty = {
  endpointName: 'endpointName',
  localPath: 'localPath',

  // the properties below are optional
  endTimeOffset: 'endTimeOffset',
  featuresAttribute: 'featuresAttribute',
  inferenceAttribute: 'inferenceAttribute',
  probabilityAttribute: 'probabilityAttribute',
  probabilityThresholdAttribute: 123,
  s3DataDistributionType: 's3DataDistributionType',
  s3InputMode: 's3InputMode',
  startTimeOffset: 'startTimeOffset',
};

Properties

Name	Type	Description
endpointName	string	An endpoint in customer's account which has enabled DataCaptureConfig enabled.
localPath	string	Path to the filesystem where the endpoint data is available to the container.
endTimeOffset?	string	If specified, monitoring jobs substract this time from the end time.
featuresAttribute?	string	The attributes of the input data that are the input features.
inferenceAttribute?	string	The attribute of the input data that represents the ground truth label.
probabilityAttribute?	string	In a classification problem, the attribute that represents the class probability.
probabilityThresholdAttribute?	number	The threshold for the class probability to be evaluated as a positive result.
s3DataDistributionType?	string	Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.
s3InputMode?	string	Whether the Pipe or File is used as the input mode for transferring data for the monitoring job.
startTimeOffset?	string	If specified, monitoring jobs substract this time from the start time.

---

endpointName

Type: string

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

---

localPath

Type: string

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

---

endTimeOffset?

Type: string (optional)

If specified, monitoring jobs substract this time from the end time.

For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs .

---

featuresAttribute?

Type: string (optional)

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

---

inferenceAttribute?

Type: string (optional)

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

---

probabilityAttribute?

Type: string (optional)

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

---

probabilityThresholdAttribute?

Type: number (optional)

The threshold for the class probability to be evaluated as a positive result.

---

s3DataDistributionType?

Type: string (optional)

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

Defaults to FullyReplicated

---

s3InputMode?

Type: string (optional)

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 .

---

startTimeOffset?

Type: string (optional)

If specified, monitoring jobs substract this time from the start time.

For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs .