« blib/lib/Paws/Comprehend/DocumentClassifierInputDataConfig.pm
↑ Summary
blib/lib/Paws/Comprehend/DocumentClassifierProperties.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Comprehend::DocumentClassifierOutputDataConfig; | ||
| 3 | use Moose; | ||
| 4 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 5 | has S3Uri => (is => 'ro', isa => 'Str'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::Comprehend::DocumentClassifierOutputDataConfig | ||
| 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::Comprehend::DocumentClassifierOutputDataConfig object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { KmsKeyId => $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::Comprehend::DocumentClassifierOutputDataConfig object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->KmsKeyId | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Provides output results configuration parameters for custom classifier | ||
| 38 | jobs. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 KmsKeyId => Str | ||
| 44 | |||
| 45 | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend | ||
| 46 | uses to encrypt the output results from an analysis job. The KmsKeyId | ||
| 47 | can be one of the following formats: | ||
| 48 | |||
| 49 | =over | ||
| 50 | |||
| 51 | =item * | ||
| 52 | |||
| 53 | KMS Key ID: C<"1234abcd-12ab-34cd-56ef-1234567890ab"> | ||
| 54 | |||
| 55 | =item * | ||
| 56 | |||
| 57 | Amazon Resource Name (ARN) of a KMS Key: | ||
| 58 | C<"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"> | ||
| 59 | |||
| 60 | =item * | ||
| 61 | |||
| 62 | KMS Key Alias: C<"alias/ExampleAlias"> | ||
| 63 | |||
| 64 | =item * | ||
| 65 | |||
| 66 | ARN of a KMS Key Alias: | ||
| 67 | C<"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"> | ||
| 68 | |||
| 69 | =back | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 S3Uri => Str | ||
| 74 | |||
| 75 | When you use the C<OutputDataConfig> object while creating a custom | ||
| 76 | classifier, you specify the Amazon S3 location where you want to write | ||
| 77 | the confusion matrix. The URI must be in the same region as the API | ||
| 78 | endpoint that you are calling. The location is used as the prefix for | ||
| 79 | the actual location of this output file. | ||
| 80 | |||
| 81 | When the custom classifier job is finished, the service creates the | ||
| 82 | output file in a directory specific to the job. The C<S3Uri> field | ||
| 83 | contains the location of the output file, called C<output.tar.gz>. It | ||
| 84 | is a compressed archive that contains the confusion matrix. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head1 SEE ALSO | ||
| 89 | |||
| 90 | This class forms part of L<Paws>, describing an object used in L<Paws::Comprehend> | ||
| 91 | |||
| 92 | =head1 BUGS and CONTRIBUTIONS | ||
| 93 | |||
| 94 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 95 | |||
| 96 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 97 | |||
| 98 | =cut | ||
| 99 |