Package software.amazon.awscdk.services.sagemaker

Interface CfnModelQualityJobDefinition.BatchTransformInputProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelQualityJobDefinition.BatchTransformInputProperty.Jsii$Proxy

Enclosing class:

CfnModelQualityJobDefinition

@Stability(Stable)
public static interface CfnModelQualityJobDefinition.BatchTransformInputProperty
extends software.amazon.jsii.JsiiSerializable

Input object for the batch transform job.

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.*;
 BatchTransformInputProperty batchTransformInputProperty = 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
         .endTimeOffset("endTimeOffset")
         .inferenceAttribute("inferenceAttribute")
         .probabilityAttribute("probabilityAttribute")
         .probabilityThresholdAttribute(123)
         .s3DataDistributionType("s3DataDistributionType")
         .s3InputMode("s3InputMode")
         .startTimeOffset("startTimeOffset")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnModelQualityJobDefinition.BatchTransformInputProperty.Builder	builder()
String	getDataCapturedDestinationS3Uri()	The Amazon S3 location being used to capture the data.
Object	getDatasetFormat()	The dataset format for your batch transform job.
default String	getEndTimeOffset()	If specified, monitoring jobs subtract this time from the end time.
default String	getInferenceAttribute()	The attribute of the input data that represents the ground truth label.
String	getLocalPath()	Path to the filesystem where the batch transform data is available to the container.
default String	getProbabilityAttribute()	In a classification problem, the attribute that represents the class probability.
default Number	getProbabilityThresholdAttribute()	The threshold for the class probability to be evaluated as a positive result.
default String	getS3DataDistributionType()	Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.
default String	getS3InputMode()	Whether the Pipe or File is used as the input mode for transferring data for the monitoring job.
default String	getStartTimeOffset()	If specified, monitoring jobs substract this time from the start time.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataCapturedDestinationS3Uri

@Stability(Stable)
@NotNull
String getDataCapturedDestinationS3Uri()

The Amazon S3 location being used to capture the data.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelqualityjobdefinition-batchtransforminput-datacaptureddestinations3uri

getDatasetFormat

@Stability(Stable)
@NotNull
Object getDatasetFormat()

The dataset format for your batch transform job.

Returns union: either IResolvable or CfnModelQualityJobDefinition.DatasetFormatProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelqualityjobdefinition-batchtransforminput-datasetformat

getLocalPath

@Stability(Stable)
@NotNull
String getLocalPath()

Path to the filesystem where the batch transform data is available to the container.

See Also:

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

getEndTimeOffset

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

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelqualityjobdefinition-batchtransforminput-endtimeoffset

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-modelqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelqualityjobdefinition-batchtransforminput-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-modelqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelqualityjobdefinition-batchtransforminput-probabilityattribute

getProbabilityThresholdAttribute

@Stability(Stable)
@Nullable
default Number getProbabilityThresholdAttribute()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelqualityjobdefinition-batchtransforminput-probabilitythresholdattribute

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelqualityjobdefinition-batchtransforminput-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-modelqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelqualityjobdefinition-batchtransforminput-s3inputmode

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelqualityjobdefinition-batchtransforminput-starttimeoffset

builder

@Stability(Stable)
static CfnModelQualityJobDefinition.BatchTransformInputProperty.Builder builder()

Returns:

a CfnModelQualityJobDefinition.BatchTransformInputProperty.Builder of CfnModelQualityJobDefinition.BatchTransformInputProperty