« blib/lib/Paws/ComprehendMedical/ComprehendMedicalAsyncJobFilter.pm
↑ Summary
blib/lib/Paws/ComprehendMedical/DescribeEntitiesDetectionV2Job.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ComprehendMedical::ComprehendMedicalAsyncJobProperties; | ||
| 3 | use Moose; | ||
| 4 | has DataAccessRoleArn => (is => 'ro', isa => 'Str'); | ||
| 5 | has EndTime => (is => 'ro', isa => 'Str'); | ||
| 6 | has ExpirationTime => (is => 'ro', isa => 'Str'); | ||
| 7 | has InputDataConfig => (is => 'ro', isa => 'Paws::ComprehendMedical::InputDataConfig'); | ||
| 8 | has JobId => (is => 'ro', isa => 'Str'); | ||
| 9 | has JobName => (is => 'ro', isa => 'Str'); | ||
| 10 | has JobStatus => (is => 'ro', isa => 'Str'); | ||
| 11 | has KMSKey => (is => 'ro', isa => 'Str'); | ||
| 12 | has LanguageCode => (is => 'ro', isa => 'Str'); | ||
| 13 | has ManifestFilePath => (is => 'ro', isa => 'Str'); | ||
| 14 | has Message => (is => 'ro', isa => 'Str'); | ||
| 15 | has ModelVersion => (is => 'ro', isa => 'Str'); | ||
| 16 | has OutputDataConfig => (is => 'ro', isa => 'Paws::ComprehendMedical::OutputDataConfig'); | ||
| 17 | has SubmitTime => (is => 'ro', isa => 'Str'); | ||
| 18 | |||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::ComprehendMedical::ComprehendMedicalAsyncJobProperties | ||
| 26 | |||
| 27 | =head1 USAGE | ||
| 28 | |||
| 29 | This class represents one of two things: | ||
| 30 | |||
| 31 | =head3 Arguments in a call to a service | ||
| 32 | |||
| 33 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 34 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 35 | |||
| 36 | As an example, if Att1 is expected to be a Paws::ComprehendMedical::ComprehendMedicalAsyncJobProperties object: | ||
| 37 | |||
| 38 | $service_obj->Method(Att1 => { DataAccessRoleArn => $value, ..., SubmitTime => $value }); | ||
| 39 | |||
| 40 | =head3 Results returned from an API call | ||
| 41 | |||
| 42 | Use accessors for each attribute. If Att1 is expected to be an Paws::ComprehendMedical::ComprehendMedicalAsyncJobProperties object: | ||
| 43 | |||
| 44 | $result = $service_obj->Method(...); | ||
| 45 | $result->Att1->DataAccessRoleArn | ||
| 46 | |||
| 47 | =head1 DESCRIPTION | ||
| 48 | |||
| 49 | Provides information about a detection job. | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 DataAccessRoleArn => Str | ||
| 55 | |||
| 56 | The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical | ||
| 57 | read access to your input data. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 EndTime => Str | ||
| 61 | |||
| 62 | The time that the detection job completed. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 ExpirationTime => Str | ||
| 66 | |||
| 67 | The date and time that job metadata is deleted from the server. Output | ||
| 68 | files in your S3 bucket will not be deleted. After the metadata is | ||
| 69 | deleted, the job will no longer appear in the results of the | ||
| 70 | C<ListEntitiesDetectionV2Job> or the C<ListPHIDetectionJobs> operation. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 InputDataConfig => L<Paws::ComprehendMedical::InputDataConfig> | ||
| 74 | |||
| 75 | The input data configuration that you supplied when you created the | ||
| 76 | detection job. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 JobId => Str | ||
| 80 | |||
| 81 | The identifier assigned to the detection job. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 JobName => Str | ||
| 85 | |||
| 86 | The name that you assigned to the detection job. | ||
| 87 | |||
| 88 | |||
| 89 | =head2 JobStatus => Str | ||
| 90 | |||
| 91 | The current status of the detection job. If the status is C<FAILED>, | ||
| 92 | the C<Message> field shows the reason for the failure. | ||
| 93 | |||
| 94 | |||
| 95 | =head2 KMSKey => Str | ||
| 96 | |||
| 97 | The AWS Key Management Service key, if any, used to encrypt the output | ||
| 98 | files. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 LanguageCode => Str | ||
| 102 | |||
| 103 | The language code of the input documents. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 ManifestFilePath => Str | ||
| 107 | |||
| 108 | The path to the file that describes the results of a batch job. | ||
| 109 | |||
| 110 | |||
| 111 | =head2 Message => Str | ||
| 112 | |||
| 113 | A description of the status of a job. | ||
| 114 | |||
| 115 | |||
| 116 | =head2 ModelVersion => Str | ||
| 117 | |||
| 118 | The version of the model used to analyze the documents. The version | ||
| 119 | number looks like X.X.X. You can use this information to track the | ||
| 120 | model used for a particular batch of documents. | ||
| 121 | |||
| 122 | |||
| 123 | =head2 OutputDataConfig => L<Paws::ComprehendMedical::OutputDataConfig> | ||
| 124 | |||
| 125 | The output data configuration that you supplied when you created the | ||
| 126 | detection job. | ||
| 127 | |||
| 128 | |||
| 129 | =head2 SubmitTime => Str | ||
| 130 | |||
| 131 | The time that the detection job was submitted for processing. | ||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head1 SEE ALSO | ||
| 136 | |||
| 137 | This class forms part of L<Paws>, describing an object used in L<Paws::ComprehendMedical> | ||
| 138 | |||
| 139 | =head1 BUGS and CONTRIBUTIONS | ||
| 140 | |||
| 141 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 142 | |||
| 143 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 144 | |||
| 145 | =cut | ||
| 146 |