/AWS1/CL_SGMPROCESSINGS3INPUT

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

CONSTRUCTOR

IMPORTING

Required arguments:

iv_s3uri TYPE /AWS1/SGMS3URI /AWS1/SGMS3URI

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

iv_s3datatype TYPE /AWS1/SGMPROCESSINGS3DATATYPE /AWS1/SGMPROCESSINGS3DATATYPE

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.

Optional arguments:

iv_localpath TYPE /AWS1/SGMPROCESSINGLOCALPATH /AWS1/SGMPROCESSINGLOCALPATH

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

iv_s3inputmode TYPE /AWS1/SGMPROCESSINGS3INPUTMODE /AWS1/SGMPROCESSINGS3INPUTMODE

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.

iv_s3datadistributiontype TYPE /AWS1/SGMPROCINGS3DATADISTRI00 /AWS1/SGMPROCINGS3DATADISTRI00

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.

iv_s3compressiontype TYPE /AWS1/SGMPROCINGS3COMPRESSIO00 /AWS1/SGMPROCINGS3COMPRESSIO00

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.

---

Queryable Attributes

S3Uri

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

Accessible with the following methods

Method	Description
GET_S3URI()	Getter for S3URI, with configurable default
ASK_S3URI()	Getter for S3URI w/ exceptions if field has no value
HAS_S3URI()	Determine if S3URI has a value

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

Accessible with the following methods

Method	Description
GET_LOCALPATH()	Getter for LOCALPATH, with configurable default
ASK_LOCALPATH()	Getter for LOCALPATH w/ exceptions if field has no value
HAS_LOCALPATH()	Determine if LOCALPATH has a value

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.

Accessible with the following methods

Method	Description
GET_S3DATATYPE()	Getter for S3DATATYPE, with configurable default
ASK_S3DATATYPE()	Getter for S3DATATYPE w/ exceptions if field has no value
HAS_S3DATATYPE()	Determine if S3DATATYPE has a value

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.

Accessible with the following methods

Method	Description
GET_S3INPUTMODE()	Getter for S3INPUTMODE, with configurable default
ASK_S3INPUTMODE()	Getter for S3INPUTMODE w/ exceptions if field has no value
HAS_S3INPUTMODE()	Determine if S3INPUTMODE has a value

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.

Accessible with the following methods

Method	Description
GET_S3DATADISTRIBUTIONTYPE()	Getter for S3DATADISTRIBUTIONTYPE, with configurable default
ASK_S3DATADISTRIBUTIONTYPE()	Getter for S3DATADISTRIBUTIONTYPE w/ exceptions if field has
HAS_S3DATADISTRIBUTIONTYPE()	Determine if S3DATADISTRIBUTIONTYPE has a value

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.

Accessible with the following methods

Method	Description
GET_S3COMPRESSIONTYPE()	Getter for S3COMPRESSIONTYPE, with configurable default
ASK_S3COMPRESSIONTYPE()	Getter for S3COMPRESSIONTYPE w/ exceptions if field has no v
HAS_S3COMPRESSIONTYPE()	Determine if S3COMPRESSIONTYPE has a value