interface S3InputProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Sagemaker.CfnProcessingJob.S3InputProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnProcessingJob_S3InputProperty`
Java	`software.amazon.awscdk.services.sagemaker.CfnProcessingJob.S3InputProperty`
Python	`aws_cdk.aws_sagemaker.CfnProcessingJob.S3InputProperty`
TypeScript	`aws-cdk-lib` » `aws_sagemaker` » `CfnProcessingJob` » `S3InputProperty`

Configuration for downloading input data from Amazon S3 into the processing container.

Example

// 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 s3InputProperty: sagemaker.CfnProcessingJob.S3InputProperty = {
  s3DataType: 's3DataType',
  s3Uri: 's3Uri',

  // the properties below are optional
  localPath: 'localPath',
  s3CompressionType: 's3CompressionType',
  s3DataDistributionType: 's3DataDistributionType',
  s3InputMode: 's3InputMode',
};

Properties

Name	Type	Description
s3DataType	`string`	Whether you use an `S3Prefix` or a `ManifestFile` for the data type.
s3Uri	`string`	The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.
localPath?	`string`	The local path in your container where you want Amazon SageMaker to write input data to.
s3CompressionType?	`string`	Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container.
s3DataDistributionType?	`string`	Whether to distribute the data from Amazon S3 to all processing instances with `FullyReplicated` , or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.
s3InputMode?	`string`	Whether to use `File` or `Pipe` input mode.

s3DataType

Type: string

Whether you use an S3Prefix or a ManifestFile for the data type.

If you choose S3Prefix , S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you choose ManifestFile , S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for the processing job.

s3Uri

Type: string

The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.

localPath?

Type: string (optional)

The local path in your container where you want Amazon SageMaker to write input data to.

LocalPath is an absolute path to the input data and must begin with /opt/ml/processing/ . LocalPath is a required parameter when AppManaged is False (default).

s3CompressionType?

Type: string (optional)

Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container.

Gzip can only be used when Pipe mode is specified as the S3InputMode . In Pipe mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.

s3DataDistributionType?

Type: string (optional)

Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated , or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.

s3InputMode?

Type: string (optional)

Whether to use File or Pipe input mode.

In File mode, Amazon SageMaker copies the data from the input source onto the local ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.