Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SageMaker.Types.ProcessingS3Input

Description

Synopsis

Documentation

data ProcessingS3Input Source #

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

See: newProcessingS3Input smart constructor.

Constructors

ProcessingS3Input'

Fields

localPath :: Maybe Text
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 :: Maybe ProcessingS3CompressionType
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 :: Maybe ProcessingS3DataDistributionType
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 :: Maybe ProcessingS3InputMode
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.
s3Uri :: Text
The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.
s3DataType :: ProcessingS3DataType
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.

Instances

Instances details

FromJSON ProcessingS3Input Source #
Instance details Defined in Amazonka.SageMaker.Types.ProcessingS3Input Methods parseJSON :: Value -> Parser ProcessingS3Input # parseJSONList :: Value -> Parser [ProcessingS3Input] #
ToJSON ProcessingS3Input Source #
Instance details Defined in Amazonka.SageMaker.Types.ProcessingS3Input Methods toJSON :: ProcessingS3Input -> Value # toEncoding :: ProcessingS3Input -> Encoding # toJSONList :: [ProcessingS3Input] -> Value # toEncodingList :: [ProcessingS3Input] -> Encoding #
Generic ProcessingS3Input Source #
Instance details Defined in Amazonka.SageMaker.Types.ProcessingS3Input Associated Types type Rep ProcessingS3Input :: Type -> Type # Methods from :: ProcessingS3Input -> Rep ProcessingS3Input x # to :: Rep ProcessingS3Input x -> ProcessingS3Input #
Read ProcessingS3Input Source #
Instance details Defined in Amazonka.SageMaker.Types.ProcessingS3Input Methods readsPrec :: Int -> ReadS ProcessingS3Input # readList :: ReadS [ProcessingS3Input] # readPrec :: ReadPrec ProcessingS3Input # readListPrec :: ReadPrec [ProcessingS3Input] #
Show ProcessingS3Input Source #
Instance details Defined in Amazonka.SageMaker.Types.ProcessingS3Input Methods showsPrec :: Int -> ProcessingS3Input -> ShowS # show :: ProcessingS3Input -> String # showList :: [ProcessingS3Input] -> ShowS #
NFData ProcessingS3Input Source #
Instance details Defined in Amazonka.SageMaker.Types.ProcessingS3Input Methods rnf :: ProcessingS3Input -> () #
Eq ProcessingS3Input Source #
Instance details Defined in Amazonka.SageMaker.Types.ProcessingS3Input Methods (==) :: ProcessingS3Input -> ProcessingS3Input -> Bool # (/=) :: ProcessingS3Input -> ProcessingS3Input -> Bool #
Hashable ProcessingS3Input Source #
Instance details Defined in Amazonka.SageMaker.Types.ProcessingS3Input Methods hashWithSalt :: Int -> ProcessingS3Input -> Int # hash :: ProcessingS3Input -> Int #
type Rep ProcessingS3Input Source #
Instance details Defined in Amazonka.SageMaker.Types.ProcessingS3Input type Rep ProcessingS3Input = D1 ('MetaData "ProcessingS3Input" "Amazonka.SageMaker.Types.ProcessingS3Input" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ProcessingS3Input'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "localPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "s3CompressionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingS3CompressionType)) :: S1 ('MetaSel ('Just "s3DataDistributionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingS3DataDistributionType)))) :: (S1 ('MetaSel ('Just "s3InputMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingS3InputMode)) :: (S1 ('MetaSel ('Just "s3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "s3DataType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProcessingS3DataType)))))

newProcessingS3Input Source #

Arguments

:: Text	`$sel:s3Uri:ProcessingS3Input'`
-> ProcessingS3DataType	`$sel:s3DataType:ProcessingS3Input'`
-> ProcessingS3Input

Create a value of ProcessingS3Input with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:localPath:ProcessingS3Input', processingS3Input_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).

$sel:s3CompressionType:ProcessingS3Input', processingS3Input_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.

$sel:s3DataDistributionType:ProcessingS3Input', processingS3Input_s3DataDistributionType - 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.

$sel:s3InputMode:ProcessingS3Input', processingS3Input_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.

$sel:s3Uri:ProcessingS3Input', processingS3Input_s3Uri - The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.

$sel:s3DataType:ProcessingS3Input', processingS3Input_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.

processingS3Input_localPath :: Lens' ProcessingS3Input (Maybe Text) Source #

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

processingS3Input_s3CompressionType :: Lens' ProcessingS3Input (Maybe ProcessingS3CompressionType) Source #

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.

processingS3Input_s3DataDistributionType :: Lens' ProcessingS3Input (Maybe ProcessingS3DataDistributionType) Source #

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.

processingS3Input_s3InputMode :: Lens' ProcessingS3Input (Maybe ProcessingS3InputMode) Source #

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.

processingS3Input_s3Uri :: Lens' ProcessingS3Input Text Source #

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

processingS3Input_s3DataType :: Lens' ProcessingS3Input ProcessingS3DataType Source #

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.