Package software.amazon.awscdk.services.sagemaker

Interface CfnModelQualityJobDefinition.EndpointInputProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnModelQualityJobDefinition.EndpointInputProperty.Jsii$Proxy
Enclosing class:
CfnModelQualityJobDefinition
@Stability(Stable) public static interface CfnModelQualityJobDefinition.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
         .endTimeOffset("endTimeOffset")
         .inferenceAttribute("inferenceAttribute")
         .probabilityAttribute("probabilityAttribute")
         .probabilityThresholdAttribute(123)
         .s3DataDistributionType("s3DataDistributionType")
         .s3InputMode("s3InputMode")
         .startTimeOffset("startTimeOffset")
         .build();

  • Method Details

    • getEndpointName

      @Stability(Stable) @NotNull String getEndpointName()
      An endpoint in customer's account which has enabled DataCaptureConfig enabled.

    • getLocalPath

      @Stability(Stable) @NotNull String getLocalPath()
      Path to the filesystem where the endpoint data is available to the container.

    • getEndTimeOffset

      @Stability(Stable) @Nullable default String getEndTimeOffset()
      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 .

    • getInferenceAttribute

      @Stability(Stable) @Nullable default String getInferenceAttribute()
      The attribute of the input data that represents the ground truth label.

    • getProbabilityAttribute

      @Stability(Stable) @Nullable default String getProbabilityAttribute()
      In a classification problem, the attribute that represents the class probability.

    • getProbabilityThresholdAttribute

      @Stability(Stable) @Nullable default Number getProbabilityThresholdAttribute()
      The threshold for the class probability to be evaluated as a positive result.

    • getS3DataDistributionType

      @Stability(Stable) @Nullable default String getS3DataDistributionType()
      Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.

      Defaults to FullyReplicated

    • 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 .

    • getStartTimeOffset

      @Stability(Stable) @Nullable default String getStartTimeOffset()
      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 .

    • builder

      @Stability(Stable) static CfnModelQualityJobDefinition.EndpointInputProperty.Builder builder()
      Returns:
      a CfnModelQualityJobDefinition.EndpointInputProperty.Builder of CfnModelQualityJobDefinition.EndpointInputProperty