AWS CDK Reference

Appearance

v2.274.0

EndpointInputProperty Struct ​

Input object for the endpoint.

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 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 ​

endpointNamestringendpoint_namestrendpointNameStringEndpointNamestringEndpointName*stringrequired#
An endpoint in customer's account which has enabled `DataCaptureConfig` enabled.
endTimeOffsetstringend_time_offsetstrendTimeOffsetStringEndTimeOffsetstringEndTimeOffset*string#
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 .

featuresAttributestringfeatures_attributestrfeaturesAttributeStringFeaturesAttributestringFeaturesAttribute*string#
The attributes of the input data that are the input features.
inferenceAttributestringinference_attributestrinferenceAttributeStringInferenceAttributestringInferenceAttribute*string#
The attribute of the input data that represents the ground truth label.
localPathstringlocal_pathstrlocalPathStringLocalPathstringLocalPath*stringrequired#
Path to the filesystem where the endpoint data is available to the container.
probabilityAttributestringprobability_attributestrprobabilityAttributeStringProbabilityAttributestringProbabilityAttribute*string#
In a classification problem, the attribute that represents the class probability.
probabilityThresholdAttributenumberprobability_threshold_attributeint | floatprobabilityThresholdAttributeNumberProbabilityThresholdAttributedoubleProbabilityThresholdAttribute*float64#
The threshold for the class probability to be evaluated as a positive result.
s3DataDistributionTypestrings3_data_distribution_typestrs3DataDistributionTypeStringS3DataDistributionTypestringS3DataDistributionType*string#
Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key.

Defaults to FullyReplicated

s3InputModestrings3_input_modestrs3InputModeStringS3InputModestringS3InputMode*string#
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 .

startTimeOffsetstringstart_time_offsetstrstartTimeOffsetStringStartTimeOffsetstringStartTimeOffset*string#
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 .