« blib/lib/Paws/SageMaker/TransformJobSummary.pm
↑ Summary
blib/lib/Paws/SageMaker/TransformResources.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SageMaker::TransformOutput; | ||
| 3 | use Moose; | ||
| 4 | has Accept => (is => 'ro', isa => 'Str'); | ||
| 5 | has AssembleWith => (is => 'ro', isa => 'Str'); | ||
| 6 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 7 | has S3OutputPath => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::SageMaker::TransformOutput | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::SageMaker::TransformOutput object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { Accept => $value, ..., S3OutputPath => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::SageMaker::TransformOutput object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->Accept | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Describes the results of a transform job. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 Accept => Str | ||
| 45 | |||
| 46 | The MIME type used to specify the output data. Amazon SageMaker uses | ||
| 47 | the MIME type with each http call to transfer data from the transform | ||
| 48 | job. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 AssembleWith => Str | ||
| 52 | |||
| 53 | Defines how to assemble the results of the transform job as a single S3 | ||
| 54 | object. Choose a format that is most convenient to you. To concatenate | ||
| 55 | the results in binary format, specify C<None>. To add a newline | ||
| 56 | character at the end of every transformed record, specify C<Line>. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 KmsKeyId => Str | ||
| 60 | |||
| 61 | The Amazon Web Services Key Management Service (Amazon Web Services | ||
| 62 | KMS) key that Amazon SageMaker uses to encrypt the model artifacts at | ||
| 63 | rest using Amazon S3 server-side encryption. The C<KmsKeyId> can be any | ||
| 64 | of the following formats: | ||
| 65 | |||
| 66 | =over | ||
| 67 | |||
| 68 | =item * | ||
| 69 | |||
| 70 | Key ID: C<1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | Key ARN: | ||
| 75 | C<arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | Alias name: C<alias/ExampleAlias> | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | Alias name ARN: | ||
| 84 | C<arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias> | ||
| 85 | |||
| 86 | =back | ||
| 87 | |||
| 88 | If you don't provide a KMS key ID, Amazon SageMaker uses the default | ||
| 89 | KMS key for Amazon S3 for your role's account. For more information, | ||
| 90 | see KMS-Managed Encryption Keys | ||
| 91 | (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) | ||
| 92 | in the I<Amazon Simple Storage Service Developer Guide.> | ||
| 93 | |||
| 94 | The KMS key policy must grant permission to the IAM role that you | ||
| 95 | specify in your CreateModel request. For more information, see Using | ||
| 96 | Key Policies in Amazon Web Services KMS | ||
| 97 | (http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) | ||
| 98 | in the I<Amazon Web Services Key Management Service Developer Guide>. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 B<REQUIRED> S3OutputPath => Str | ||
| 102 | |||
| 103 | The Amazon S3 path where you want Amazon SageMaker to store the results | ||
| 104 | of the transform job. For example, C<s3://bucket-name/key-name-prefix>. | ||
| 105 | |||
| 106 | For every S3 object used as input for the transform job, batch | ||
| 107 | transform stores the transformed data with an .C<out> suffix in a | ||
| 108 | corresponding subfolder in the location in the output prefix. For | ||
| 109 | example, for the input data stored at | ||
| 110 | C<s3://bucket-name/input-name-prefix/dataset01/data.csv>, batch | ||
| 111 | transform stores the transformed data at | ||
| 112 | C<s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out>. | ||
| 113 | Batch transform doesn't upload partially processed objects. For an | ||
| 114 | input S3 object that contains multiple records, it creates an .C<out> | ||
| 115 | file only if the transform job succeeds on the entire file. When the | ||
| 116 | input contains multiple S3 objects, the batch transform job processes | ||
| 117 | the listed S3 objects and uploads only the output for successfully | ||
| 118 | processed objects. If any object fails in the transform job batch | ||
| 119 | transform marks the job as failed to prompt investigation. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head1 SEE ALSO | ||
| 124 | |||
| 125 | This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker> | ||
| 126 | |||
| 127 | =head1 BUGS and CONTRIBUTIONS | ||
| 128 | |||
| 129 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 130 | |||
| 131 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 132 | |||
| 133 | =cut | ||
| 134 |