« blib/lib/Paws/SageMaker/ProcessingResources.pm
↑ Summary
blib/lib/Paws/SageMaker/ProcessingS3Output.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SageMaker::ProcessingS3Input; | ||
| 3 | use Moose; | ||
| 4 | has LocalPath => (is => 'ro', isa => 'Str'); | ||
| 5 | has S3CompressionType => (is => 'ro', isa => 'Str'); | ||
| 6 | has S3DataDistributionType => (is => 'ro', isa => 'Str'); | ||
| 7 | has S3DataType => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has S3InputMode => (is => 'ro', isa => 'Str'); | ||
| 9 | has S3Uri => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::SageMaker::ProcessingS3Input | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::SageMaker::ProcessingS3Input object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { LocalPath => $value, ..., S3Uri => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::SageMaker::ProcessingS3Input object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->LocalPath | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Configuration for downloading input data from Amazon S3 into the | ||
| 42 | processing container. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 LocalPath => Str | ||
| 48 | |||
| 49 | The local path in your container where you want Amazon SageMaker to | ||
| 50 | write input data to. C<LocalPath> is an absolute path to the input data | ||
| 51 | and must begin with C</opt/ml/processing/>. C<LocalPath> is a required | ||
| 52 | parameter when C<AppManaged> is C<False> (default). | ||
| 53 | |||
| 54 | |||
| 55 | =head2 S3CompressionType => Str | ||
| 56 | |||
| 57 | Whether to GZIP-decompress the data in Amazon S3 as it is streamed into | ||
| 58 | the processing container. C<Gzip> can only be used when C<Pipe> mode is | ||
| 59 | specified as the C<S3InputMode>. In C<Pipe> mode, Amazon SageMaker | ||
| 60 | streams input data from the source directly to your container without | ||
| 61 | using the EBS volume. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 S3DataDistributionType => Str | ||
| 65 | |||
| 66 | Whether to distribute the data from Amazon S3 to all processing | ||
| 67 | instances with C<FullyReplicated>, or whether the data from Amazon S3 | ||
| 68 | is shared by Amazon S3 key, downloading one shard of data to each | ||
| 69 | processing instance. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 B<REQUIRED> S3DataType => Str | ||
| 73 | |||
| 74 | Whether you use an C<S3Prefix> or a C<ManifestFile> for the data type. | ||
| 75 | If you choose C<S3Prefix>, C<S3Uri> identifies a key name prefix. | ||
| 76 | Amazon SageMaker uses all objects with the specified key name prefix | ||
| 77 | for the processing job. If you choose C<ManifestFile>, C<S3Uri> | ||
| 78 | identifies an object that is a manifest file containing a list of | ||
| 79 | object keys that you want Amazon SageMaker to use for the processing | ||
| 80 | job. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 S3InputMode => Str | ||
| 84 | |||
| 85 | Whether to use C<File> or C<Pipe> input mode. In File mode, Amazon | ||
| 86 | SageMaker copies the data from the input source onto the local ML | ||
| 87 | storage volume before starting your processing container. This is the | ||
| 88 | most commonly used input mode. In C<Pipe> mode, Amazon SageMaker | ||
| 89 | streams input data from the source directly to your processing | ||
| 90 | container into named pipes without using the ML storage volume. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 B<REQUIRED> S3Uri => Str | ||
| 94 | |||
| 95 | The URI of the Amazon S3 prefix Amazon SageMaker downloads data | ||
| 96 | required to run a processing job. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head1 SEE ALSO | ||
| 101 | |||
| 102 | This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker> | ||
| 103 | |||
| 104 | =head1 BUGS and CONTRIBUTIONS | ||
| 105 | |||
| 106 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 107 | |||
| 108 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 109 | |||
| 110 | =cut | ||
| 111 |