AWS::SageMaker::ProcessingJob S3Input - AWS CloudFormation
SyntaxProperties

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::SageMaker::ProcessingJob S3Input

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "LocalPath" : String,
  "S3CompressionType" : String,
  "S3DataDistributionType" : String,
  "S3DataType" : String,
  "S3InputMode" : String,
  "S3Uri" : String
}

YAML

  LocalPath: String
  S3CompressionType: String
  S3DataDistributionType: String
  S3DataType: String
  S3InputMode: String
  S3Uri: String

Properties

LocalPath

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

Required: No

Type: String

Pattern: .*

Minimum: 0

Maximum: 256

Update requires: Replacement

S3CompressionType

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.

Required: No

Type: String

Allowed values: None | Gzip

Update requires: Replacement

S3DataDistributionType

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

Required: No

Type: String

Allowed values: FullyReplicated | ShardedByS3Key

Update requires: Replacement

S3DataType

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.

Required: Yes

Type: String

Allowed values: ManifestFile | S3Prefix

Update requires: Replacement

S3InputMode

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.

Required: No

Type: String

Allowed values: File | Pipe

Update requires: Replacement

S3Uri

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

Required: Yes

Type: String

Pattern: (https|s3)://([^/]+)/?(.*)

Minimum: 0

Maximum: 1024

Update requires: Replacement