« blib/lib/Paws/Comprehend/DocumentClassificationJobFilter.pm
↑ Summary
blib/lib/Paws/Comprehend/DocumentClassifierFilter.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Comprehend::DocumentClassificationJobProperties; | ||
| 3 | use Moose; | ||
| 4 | has DataAccessRoleArn => (is => 'ro', isa => 'Str'); | ||
| 5 | has DocumentClassifierArn => (is => 'ro', isa => 'Str'); | ||
| 6 | has EndTime => (is => 'ro', isa => 'Str'); | ||
| 7 | has InputDataConfig => (is => 'ro', isa => 'Paws::Comprehend::InputDataConfig'); | ||
| 8 | has JobId => (is => 'ro', isa => 'Str'); | ||
| 9 | has JobName => (is => 'ro', isa => 'Str'); | ||
| 10 | has JobStatus => (is => 'ro', isa => 'Str'); | ||
| 11 | has Message => (is => 'ro', isa => 'Str'); | ||
| 12 | has OutputDataConfig => (is => 'ro', isa => 'Paws::Comprehend::OutputDataConfig'); | ||
| 13 | has SubmitTime => (is => 'ro', isa => 'Str'); | ||
| 14 | has VolumeKmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 15 | has VpcConfig => (is => 'ro', isa => 'Paws::Comprehend::VpcConfig'); | ||
| 16 | |||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::Comprehend::DocumentClassificationJobProperties | ||
| 24 | |||
| 25 | =head1 USAGE | ||
| 26 | |||
| 27 | This class represents one of two things: | ||
| 28 | |||
| 29 | =head3 Arguments in a call to a service | ||
| 30 | |||
| 31 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 32 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 33 | |||
| 34 | As an example, if Att1 is expected to be a Paws::Comprehend::DocumentClassificationJobProperties object: | ||
| 35 | |||
| 36 | $service_obj->Method(Att1 => { DataAccessRoleArn => $value, ..., VpcConfig => $value }); | ||
| 37 | |||
| 38 | =head3 Results returned from an API call | ||
| 39 | |||
| 40 | Use accessors for each attribute. If Att1 is expected to be an Paws::Comprehend::DocumentClassificationJobProperties object: | ||
| 41 | |||
| 42 | $result = $service_obj->Method(...); | ||
| 43 | $result->Att1->DataAccessRoleArn | ||
| 44 | |||
| 45 | =head1 DESCRIPTION | ||
| 46 | |||
| 47 | Provides information about a document classification job. | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 DataAccessRoleArn => Str | ||
| 53 | |||
| 54 | The Amazon Resource Name (ARN) of the AWS identity and Access | ||
| 55 | Management (IAM) role that grants Amazon Comprehend read access to your | ||
| 56 | input data. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 DocumentClassifierArn => Str | ||
| 60 | |||
| 61 | The Amazon Resource Name (ARN) that identifies the document classifier. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 EndTime => Str | ||
| 65 | |||
| 66 | The time that the document classification job completed. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 InputDataConfig => L<Paws::Comprehend::InputDataConfig> | ||
| 70 | |||
| 71 | The input data configuration that you supplied when you created the | ||
| 72 | document classification job. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 JobId => Str | ||
| 76 | |||
| 77 | The identifier assigned to the document classification job. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 JobName => Str | ||
| 81 | |||
| 82 | The name that you assigned to the document classification job. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 JobStatus => Str | ||
| 86 | |||
| 87 | The current status of the document classification job. If the status is | ||
| 88 | C<FAILED>, the C<Message> field shows the reason for the failure. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 Message => Str | ||
| 92 | |||
| 93 | A description of the status of the job. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 OutputDataConfig => L<Paws::Comprehend::OutputDataConfig> | ||
| 97 | |||
| 98 | The output data configuration that you supplied when you created the | ||
| 99 | document classification job. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 SubmitTime => Str | ||
| 103 | |||
| 104 | The time that the document classification job was submitted for | ||
| 105 | processing. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 VolumeKmsKeyId => Str | ||
| 109 | |||
| 110 | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend | ||
| 111 | uses to encrypt data on the storage volume attached to the ML compute | ||
| 112 | instance(s) that process the analysis job. The VolumeKmsKeyId can be | ||
| 113 | either of the following formats: | ||
| 114 | |||
| 115 | =over | ||
| 116 | |||
| 117 | =item * | ||
| 118 | |||
| 119 | KMS Key ID: C<"1234abcd-12ab-34cd-56ef-1234567890ab"> | ||
| 120 | |||
| 121 | =item * | ||
| 122 | |||
| 123 | Amazon Resource Name (ARN) of a KMS Key: | ||
| 124 | C<"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"> | ||
| 125 | |||
| 126 | =back | ||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head2 VpcConfig => L<Paws::Comprehend::VpcConfig> | ||
| 131 | |||
| 132 | Configuration parameters for a private Virtual Private Cloud (VPC) | ||
| 133 | containing the resources you are using for your document classification | ||
| 134 | job. For more information, see Amazon VPC | ||
| 135 | (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). | ||
| 136 | |||
| 137 | |||
| 138 | |||
| 139 | =head1 SEE ALSO | ||
| 140 | |||
| 141 | This class forms part of L<Paws>, describing an object used in L<Paws::Comprehend> | ||
| 142 | |||
| 143 | =head1 BUGS and CONTRIBUTIONS | ||
| 144 | |||
| 145 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 146 | |||
| 147 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 148 | |||
| 149 | =cut | ||
| 150 |