| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SageMaker::TransformS3DataSource; | ||
| 3 | use Moose; | ||
| 4 | has S3DataType => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has S3Uri => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::SageMaker::TransformS3DataSource | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::SageMaker::TransformS3DataSource object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { S3DataType => $value, ..., S3Uri => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::SageMaker::TransformS3DataSource object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->S3DataType | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Describes the S3 data source. | ||
| 38 | |||
| 39 | =head1 ATTRIBUTES | ||
| 40 | |||
| 41 | |||
| 42 | =head2 B<REQUIRED> S3DataType => Str | ||
| 43 | |||
| 44 | If you choose C<S3Prefix>, C<S3Uri> identifies a key name prefix. | ||
| 45 | Amazon SageMaker uses all objects with the specified key name prefix | ||
| 46 | for batch transform. | ||
| 47 | |||
| 48 | If you choose C<ManifestFile>, C<S3Uri> identifies an object that is a | ||
| 49 | manifest file containing a list of object keys that you want Amazon | ||
| 50 | SageMaker to use for batch transform. | ||
| 51 | |||
| 52 | The following values are compatible: C<ManifestFile>, C<S3Prefix> | ||
| 53 | |||
| 54 | The following value is not compatible: C<AugmentedManifestFile> | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> S3Uri => Str | ||
| 58 | |||
| 59 | Depending on the value specified for the C<S3DataType>, identifies | ||
| 60 | either a key name prefix or a manifest. For example: | ||
| 61 | |||
| 62 | =over | ||
| 63 | |||
| 64 | =item * | ||
| 65 | |||
| 66 | A key name prefix might look like this: | ||
| 67 | C<s3://bucketname/exampleprefix>. | ||
| 68 | |||
| 69 | =item * | ||
| 70 | |||
| 71 | A manifest might look like this: C<s3://bucketname/example.manifest> | ||
| 72 | |||
| 73 | The manifest is an S3 object which is a JSON file with the following | ||
| 74 | format: | ||
| 75 | |||
| 76 | C<[ {"prefix": "s3://customer_bucket/some/prefix/"},> | ||
| 77 | |||
| 78 | C<"relative/path/to/custdata-1",> | ||
| 79 | |||
| 80 | C<"relative/path/custdata-2",> | ||
| 81 | |||
| 82 | C<...> | ||
| 83 | |||
| 84 | C<"relative/path/custdata-N"> | ||
| 85 | |||
| 86 | C<]> | ||
| 87 | |||
| 88 | The preceding JSON matches the following C<S3Uris>: | ||
| 89 | |||
| 90 | C<s3://customer_bucket/some/prefix/relative/path/to/custdata-1> | ||
| 91 | |||
| 92 | C<s3://customer_bucket/some/prefix/relative/path/custdata-2> | ||
| 93 | |||
| 94 | C<...> | ||
| 95 | |||
| 96 | C<s3://customer_bucket/some/prefix/relative/path/custdata-N> | ||
| 97 | |||
| 98 | The complete set of C<S3Uris> in this manifest constitutes the input | ||
| 99 | data for the channel for this datasource. The object that each | ||
| 100 | C<S3Uris> points to must be readable by the IAM role that Amazon | ||
| 101 | SageMaker uses to perform tasks on your behalf. | ||
| 102 | |||
| 103 | =back | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head1 SEE ALSO | ||
| 109 | |||
| 110 | This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker> | ||
| 111 | |||
| 112 | =head1 BUGS and CONTRIBUTIONS | ||
| 113 | |||
| 114 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 115 | |||
| 116 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 117 | |||
| 118 | =cut | ||
| 119 |