AWS SDK for C++  1.9.126
AWS SDK for C++
Public Member Functions | List of all members
Aws::SageMaker::Model::ProcessingS3Input Class Reference

#include <ProcessingS3Input.h>

Public Member Functions

 ProcessingS3Input ()
 
 ProcessingS3Input (Aws::Utils::Json::JsonView jsonValue)
 
ProcessingS3Inputoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetS3Uri () const
 
bool S3UriHasBeenSet () const
 
void SetS3Uri (const Aws::String &value)
 
void SetS3Uri (Aws::String &&value)
 
void SetS3Uri (const char *value)
 
ProcessingS3InputWithS3Uri (const Aws::String &value)
 
ProcessingS3InputWithS3Uri (Aws::String &&value)
 
ProcessingS3InputWithS3Uri (const char *value)
 
const Aws::StringGetLocalPath () const
 
bool LocalPathHasBeenSet () const
 
void SetLocalPath (const Aws::String &value)
 
void SetLocalPath (Aws::String &&value)
 
void SetLocalPath (const char *value)
 
ProcessingS3InputWithLocalPath (const Aws::String &value)
 
ProcessingS3InputWithLocalPath (Aws::String &&value)
 
ProcessingS3InputWithLocalPath (const char *value)
 
const ProcessingS3DataTypeGetS3DataType () const
 
bool S3DataTypeHasBeenSet () const
 
void SetS3DataType (const ProcessingS3DataType &value)
 
void SetS3DataType (ProcessingS3DataType &&value)
 
ProcessingS3InputWithS3DataType (const ProcessingS3DataType &value)
 
ProcessingS3InputWithS3DataType (ProcessingS3DataType &&value)
 
const ProcessingS3InputModeGetS3InputMode () const
 
bool S3InputModeHasBeenSet () const
 
void SetS3InputMode (const ProcessingS3InputMode &value)
 
void SetS3InputMode (ProcessingS3InputMode &&value)
 
ProcessingS3InputWithS3InputMode (const ProcessingS3InputMode &value)
 
ProcessingS3InputWithS3InputMode (ProcessingS3InputMode &&value)
 
const ProcessingS3DataDistributionTypeGetS3DataDistributionType () const
 
bool S3DataDistributionTypeHasBeenSet () const
 
void SetS3DataDistributionType (const ProcessingS3DataDistributionType &value)
 
void SetS3DataDistributionType (ProcessingS3DataDistributionType &&value)
 
ProcessingS3InputWithS3DataDistributionType (const ProcessingS3DataDistributionType &value)
 
ProcessingS3InputWithS3DataDistributionType (ProcessingS3DataDistributionType &&value)
 
const ProcessingS3CompressionTypeGetS3CompressionType () const
 
bool S3CompressionTypeHasBeenSet () const
 
void SetS3CompressionType (const ProcessingS3CompressionType &value)
 
void SetS3CompressionType (ProcessingS3CompressionType &&value)
 
ProcessingS3InputWithS3CompressionType (const ProcessingS3CompressionType &value)
 
ProcessingS3InputWithS3CompressionType (ProcessingS3CompressionType &&value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 36 of file ProcessingS3Input.h.

Constructor & Destructor Documentation

◆ ProcessingS3Input() [1/2]

Aws::SageMaker::Model::ProcessingS3Input::ProcessingS3Input ( )

◆ ProcessingS3Input() [2/2]

Aws::SageMaker::Model::ProcessingS3Input::ProcessingS3Input ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetLocalPath()

const Aws::String& Aws::SageMaker::Model::ProcessingS3Input::GetLocalPath ( ) const
inline

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

Definition at line 101 of file ProcessingS3Input.h.

◆ GetS3CompressionType()

const ProcessingS3CompressionType& Aws::SageMaker::Model::ProcessingS3Input::GetS3CompressionType ( ) const
inline

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.

Definition at line 345 of file ProcessingS3Input.h.

◆ GetS3DataDistributionType()

const ProcessingS3DataDistributionType& Aws::SageMaker::Model::ProcessingS3Input::GetS3DataDistributionType ( ) const
inline

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.

Definition at line 300 of file ProcessingS3Input.h.

◆ GetS3DataType()

const ProcessingS3DataType& Aws::SageMaker::Model::ProcessingS3Input::GetS3DataType ( ) const
inline

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.

Definition at line 176 of file ProcessingS3Input.h.

◆ GetS3InputMode()

const ProcessingS3InputMode& Aws::SageMaker::Model::ProcessingS3Input::GetS3InputMode ( ) const
inline

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.

Definition at line 242 of file ProcessingS3Input.h.

◆ GetS3Uri()

const Aws::String& Aws::SageMaker::Model::ProcessingS3Input::GetS3Uri ( ) const
inline

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

Definition at line 49 of file ProcessingS3Input.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::SageMaker::Model::ProcessingS3Input::Jsonize ( ) const

◆ LocalPathHasBeenSet()

bool Aws::SageMaker::Model::ProcessingS3Input::LocalPathHasBeenSet ( ) const
inline

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

Definition at line 110 of file ProcessingS3Input.h.

◆ operator=()

ProcessingS3Input& Aws::SageMaker::Model::ProcessingS3Input::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ S3CompressionTypeHasBeenSet()

bool Aws::SageMaker::Model::ProcessingS3Input::S3CompressionTypeHasBeenSet ( ) const
inline

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.

Definition at line 354 of file ProcessingS3Input.h.

◆ S3DataDistributionTypeHasBeenSet()

bool Aws::SageMaker::Model::ProcessingS3Input::S3DataDistributionTypeHasBeenSet ( ) const
inline

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.

Definition at line 307 of file ProcessingS3Input.h.

◆ S3DataTypeHasBeenSet()

bool Aws::SageMaker::Model::ProcessingS3Input::S3DataTypeHasBeenSet ( ) const
inline

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.

Definition at line 187 of file ProcessingS3Input.h.

◆ S3InputModeHasBeenSet()

bool Aws::SageMaker::Model::ProcessingS3Input::S3InputModeHasBeenSet ( ) const
inline

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.

Definition at line 252 of file ProcessingS3Input.h.

◆ S3UriHasBeenSet()

bool Aws::SageMaker::Model::ProcessingS3Input::S3UriHasBeenSet ( ) const
inline

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

Definition at line 55 of file ProcessingS3Input.h.

◆ SetLocalPath() [1/3]

void Aws::SageMaker::Model::ProcessingS3Input::SetLocalPath ( Aws::String &&  value)
inline

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

Definition at line 128 of file ProcessingS3Input.h.

◆ SetLocalPath() [2/3]

void Aws::SageMaker::Model::ProcessingS3Input::SetLocalPath ( const Aws::String value)
inline

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

Definition at line 119 of file ProcessingS3Input.h.

◆ SetLocalPath() [3/3]

void Aws::SageMaker::Model::ProcessingS3Input::SetLocalPath ( const char *  value)
inline

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

Definition at line 137 of file ProcessingS3Input.h.

◆ SetS3CompressionType() [1/2]

void Aws::SageMaker::Model::ProcessingS3Input::SetS3CompressionType ( const ProcessingS3CompressionType value)
inline

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.

Definition at line 363 of file ProcessingS3Input.h.

◆ SetS3CompressionType() [2/2]

void Aws::SageMaker::Model::ProcessingS3Input::SetS3CompressionType ( ProcessingS3CompressionType &&  value)
inline

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.

Definition at line 372 of file ProcessingS3Input.h.

◆ SetS3DataDistributionType() [1/2]

void Aws::SageMaker::Model::ProcessingS3Input::SetS3DataDistributionType ( const ProcessingS3DataDistributionType value)
inline

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.

Definition at line 314 of file ProcessingS3Input.h.

◆ SetS3DataDistributionType() [2/2]

void Aws::SageMaker::Model::ProcessingS3Input::SetS3DataDistributionType ( ProcessingS3DataDistributionType &&  value)
inline

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.

Definition at line 321 of file ProcessingS3Input.h.

◆ SetS3DataType() [1/2]

void Aws::SageMaker::Model::ProcessingS3Input::SetS3DataType ( const ProcessingS3DataType value)
inline

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.

Definition at line 198 of file ProcessingS3Input.h.

◆ SetS3DataType() [2/2]

void Aws::SageMaker::Model::ProcessingS3Input::SetS3DataType ( ProcessingS3DataType &&  value)
inline

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.

Definition at line 209 of file ProcessingS3Input.h.

◆ SetS3InputMode() [1/2]

void Aws::SageMaker::Model::ProcessingS3Input::SetS3InputMode ( const ProcessingS3InputMode value)
inline

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.

Definition at line 262 of file ProcessingS3Input.h.

◆ SetS3InputMode() [2/2]

void Aws::SageMaker::Model::ProcessingS3Input::SetS3InputMode ( ProcessingS3InputMode &&  value)
inline

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.

Definition at line 272 of file ProcessingS3Input.h.

◆ SetS3Uri() [1/3]

void Aws::SageMaker::Model::ProcessingS3Input::SetS3Uri ( Aws::String &&  value)
inline

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

Definition at line 67 of file ProcessingS3Input.h.

◆ SetS3Uri() [2/3]

void Aws::SageMaker::Model::ProcessingS3Input::SetS3Uri ( const Aws::String value)
inline

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

Definition at line 61 of file ProcessingS3Input.h.

◆ SetS3Uri() [3/3]

void Aws::SageMaker::Model::ProcessingS3Input::SetS3Uri ( const char *  value)
inline

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

Definition at line 73 of file ProcessingS3Input.h.

◆ WithLocalPath() [1/3]

ProcessingS3Input& Aws::SageMaker::Model::ProcessingS3Input::WithLocalPath ( Aws::String &&  value)
inline

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

Definition at line 155 of file ProcessingS3Input.h.

◆ WithLocalPath() [2/3]

ProcessingS3Input& Aws::SageMaker::Model::ProcessingS3Input::WithLocalPath ( const Aws::String value)
inline

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

Definition at line 146 of file ProcessingS3Input.h.

◆ WithLocalPath() [3/3]

ProcessingS3Input& Aws::SageMaker::Model::ProcessingS3Input::WithLocalPath ( const char *  value)
inline

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

Definition at line 164 of file ProcessingS3Input.h.

◆ WithS3CompressionType() [1/2]

ProcessingS3Input& Aws::SageMaker::Model::ProcessingS3Input::WithS3CompressionType ( const ProcessingS3CompressionType value)
inline

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.

Definition at line 381 of file ProcessingS3Input.h.

◆ WithS3CompressionType() [2/2]

ProcessingS3Input& Aws::SageMaker::Model::ProcessingS3Input::WithS3CompressionType ( ProcessingS3CompressionType &&  value)
inline

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.

Definition at line 390 of file ProcessingS3Input.h.

◆ WithS3DataDistributionType() [1/2]

ProcessingS3Input& Aws::SageMaker::Model::ProcessingS3Input::WithS3DataDistributionType ( const ProcessingS3DataDistributionType value)
inline

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.

Definition at line 328 of file ProcessingS3Input.h.

◆ WithS3DataDistributionType() [2/2]

ProcessingS3Input& Aws::SageMaker::Model::ProcessingS3Input::WithS3DataDistributionType ( ProcessingS3DataDistributionType &&  value)
inline

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.

Definition at line 335 of file ProcessingS3Input.h.

◆ WithS3DataType() [1/2]

ProcessingS3Input& Aws::SageMaker::Model::ProcessingS3Input::WithS3DataType ( const ProcessingS3DataType value)
inline

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.

Definition at line 220 of file ProcessingS3Input.h.

◆ WithS3DataType() [2/2]

ProcessingS3Input& Aws::SageMaker::Model::ProcessingS3Input::WithS3DataType ( ProcessingS3DataType &&  value)
inline

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.

Definition at line 231 of file ProcessingS3Input.h.

◆ WithS3InputMode() [1/2]

ProcessingS3Input& Aws::SageMaker::Model::ProcessingS3Input::WithS3InputMode ( const ProcessingS3InputMode value)
inline

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.

Definition at line 282 of file ProcessingS3Input.h.

◆ WithS3InputMode() [2/2]

ProcessingS3Input& Aws::SageMaker::Model::ProcessingS3Input::WithS3InputMode ( ProcessingS3InputMode &&  value)
inline

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.

Definition at line 292 of file ProcessingS3Input.h.

◆ WithS3Uri() [1/3]

ProcessingS3Input& Aws::SageMaker::Model::ProcessingS3Input::WithS3Uri ( Aws::String &&  value)
inline

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

Definition at line 85 of file ProcessingS3Input.h.

◆ WithS3Uri() [2/3]

ProcessingS3Input& Aws::SageMaker::Model::ProcessingS3Input::WithS3Uri ( const Aws::String value)
inline

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

Definition at line 79 of file ProcessingS3Input.h.

◆ WithS3Uri() [3/3]

ProcessingS3Input& Aws::SageMaker::Model::ProcessingS3Input::WithS3Uri ( const char *  value)
inline

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

Definition at line 91 of file ProcessingS3Input.h.


The documentation for this class was generated from the following file: