# BatchTransformInputProperty

Input object for the batch transform job.

- Source: Generated at build time
- Type last changed: v2.93.0 · 23 Aug 2023

## Example

TypeScript:

```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 batchTransformInputProperty: sagemaker.CfnModelExplainabilityJobDefinition.BatchTransformInputProperty = {
  dataCapturedDestinationS3Uri: 'dataCapturedDestinationS3Uri',
  datasetFormat: {
    csv: {
      header: false,
    },
    json: {
      line: false,
    },
    parquet: false,
  },
  localPath: 'localPath',

  // the properties below are optional
  featuresAttribute: 'featuresAttribute',
  inferenceAttribute: 'inferenceAttribute',
  probabilityAttribute: 'probabilityAttribute',
  s3DataDistributionType: 's3DataDistributionType',
  s3InputMode: 's3InputMode',
};
```

Python:

```python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

batch_transform_input_property = sagemaker.CfnModelExplainabilityJobDefinition.BatchTransformInputProperty(
    data_captured_destination_s3_uri="dataCapturedDestinationS3Uri",
    dataset_format=sagemaker.CfnModelExplainabilityJobDefinition.DatasetFormatProperty(
        csv=sagemaker.CfnModelExplainabilityJobDefinition.CsvProperty(
            header=False
        ),
        json=sagemaker.CfnModelExplainabilityJobDefinition.JsonProperty(
            line=False
        ),
        parquet=False
    ),
    local_path="localPath",

    # the properties below are optional
    features_attribute="featuresAttribute",
    inference_attribute="inferenceAttribute",
    probability_attribute="probabilityAttribute",
    s3_data_distribution_type="s3DataDistributionType",
    s3_input_mode="s3InputMode"
)
```

Java:

```java
// 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
        .featuresAttribute("featuresAttribute")
        .inferenceAttribute("inferenceAttribute")
        .probabilityAttribute("probabilityAttribute")
        .s3DataDistributionType("s3DataDistributionType")
        .s3InputMode("s3InputMode")
        .build();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;

var batchTransformInputProperty = new BatchTransformInputProperty {
    DataCapturedDestinationS3Uri = "dataCapturedDestinationS3Uri",
    DatasetFormat = new DatasetFormatProperty {
        Csv = new CsvProperty {
            Header = false
        },
        Json = new JsonProperty {
            Line = false
        },
        Parquet = false
    },
    LocalPath = "localPath",

    // the properties below are optional
    FeaturesAttribute = "featuresAttribute",
    InferenceAttribute = "inferenceAttribute",
    ProbabilityAttribute = "probabilityAttribute",
    S3DataDistributionType = "s3DataDistributionType",
    S3InputMode = "s3InputMode"
};
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

batchTransformInputProperty := &BatchTransformInputProperty{
	DataCapturedDestinationS3Uri: jsii.String("dataCapturedDestinationS3Uri"),
	DatasetFormat: &DatasetFormatProperty{
		Csv: &CsvProperty{
			Header: jsii.Boolean(false),
		},
		Json: &JsonProperty{
			Line: jsii.Boolean(false),
		},
		Parquet: jsii.Boolean(false),
	},
	LocalPath: jsii.String("localPath"),

	// the properties below are optional
	FeaturesAttribute: jsii.String("featuresAttribute"),
	InferenceAttribute: jsii.String("inferenceAttribute"),
	ProbabilityAttribute: jsii.String("probabilityAttribute"),
	S3DataDistributionType: jsii.String("s3DataDistributionType"),
	S3InputMode: jsii.String("s3InputMode"),
}
```

## Properties

- `dataCapturedDestinationS3Uri`: string (required) — The Amazon S3 location being used to capture the data.

- `datasetFormat`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnModelExplainabilityJobDefinition.DatasetFormatProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnModelExplainabilityJobDefinition.DatasetFormatProperty.html) (required) — The dataset format for your batch transform job.

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

- `localPath`: string (required) — Path to the filesystem where the batch transform data is available to the container.

- `probabilityAttribute`: string — In a classification problem, the attribute that represents the class probability.

- `s3DataDistributionType`: string — Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.

  Defaults to `FullyReplicated`

- `s3InputMode`: 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` .
