« blib/lib/Paws/Personalize/AutoMLResult.pm
↑ Summary
blib/lib/Paws/Personalize/BatchInferenceJobConfig.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Personalize::BatchInferenceJob; | ||
| 3 | use Moose; | ||
| 4 | has BatchInferenceJobArn => (is => 'ro', isa => 'Str', request_name => 'batchInferenceJobArn', traits => ['NameInRequest']); | ||
| 5 | has BatchInferenceJobConfig => (is => 'ro', isa => 'Paws::Personalize::BatchInferenceJobConfig', request_name => 'batchInferenceJobConfig', traits => ['NameInRequest']); | ||
| 6 | has CreationDateTime => (is => 'ro', isa => 'Str', request_name => 'creationDateTime', traits => ['NameInRequest']); | ||
| 7 | has FailureReason => (is => 'ro', isa => 'Str', request_name => 'failureReason', traits => ['NameInRequest']); | ||
| 8 | has FilterArn => (is => 'ro', isa => 'Str', request_name => 'filterArn', traits => ['NameInRequest']); | ||
| 9 | has JobInput => (is => 'ro', isa => 'Paws::Personalize::BatchInferenceJobInput', request_name => 'jobInput', traits => ['NameInRequest']); | ||
| 10 | has JobName => (is => 'ro', isa => 'Str', request_name => 'jobName', traits => ['NameInRequest']); | ||
| 11 | has JobOutput => (is => 'ro', isa => 'Paws::Personalize::BatchInferenceJobOutput', request_name => 'jobOutput', traits => ['NameInRequest']); | ||
| 12 | has LastUpdatedDateTime => (is => 'ro', isa => 'Str', request_name => 'lastUpdatedDateTime', traits => ['NameInRequest']); | ||
| 13 | has NumResults => (is => 'ro', isa => 'Int', request_name => 'numResults', traits => ['NameInRequest']); | ||
| 14 | has RoleArn => (is => 'ro', isa => 'Str', request_name => 'roleArn', traits => ['NameInRequest']); | ||
| 15 | has SolutionVersionArn => (is => 'ro', isa => 'Str', request_name => 'solutionVersionArn', traits => ['NameInRequest']); | ||
| 16 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 17 | |||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::Personalize::BatchInferenceJob | ||
| 25 | |||
| 26 | =head1 USAGE | ||
| 27 | |||
| 28 | This class represents one of two things: | ||
| 29 | |||
| 30 | =head3 Arguments in a call to a service | ||
| 31 | |||
| 32 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 33 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 34 | |||
| 35 | As an example, if Att1 is expected to be a Paws::Personalize::BatchInferenceJob object: | ||
| 36 | |||
| 37 | $service_obj->Method(Att1 => { BatchInferenceJobArn => $value, ..., Status => $value }); | ||
| 38 | |||
| 39 | =head3 Results returned from an API call | ||
| 40 | |||
| 41 | Use accessors for each attribute. If Att1 is expected to be an Paws::Personalize::BatchInferenceJob object: | ||
| 42 | |||
| 43 | $result = $service_obj->Method(...); | ||
| 44 | $result->Att1->BatchInferenceJobArn | ||
| 45 | |||
| 46 | =head1 DESCRIPTION | ||
| 47 | |||
| 48 | Contains information on a batch inference job. | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 BatchInferenceJobArn => Str | ||
| 54 | |||
| 55 | The Amazon Resource Name (ARN) of the batch inference job. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 BatchInferenceJobConfig => L<Paws::Personalize::BatchInferenceJobConfig> | ||
| 59 | |||
| 60 | A string to string map of the configuration details of a batch | ||
| 61 | inference job. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 CreationDateTime => Str | ||
| 65 | |||
| 66 | The time at which the batch inference job was created. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 FailureReason => Str | ||
| 70 | |||
| 71 | If the batch inference job failed, the reason for the failure. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 FilterArn => Str | ||
| 75 | |||
| 76 | The ARN of the filter used on the batch inference job. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 JobInput => L<Paws::Personalize::BatchInferenceJobInput> | ||
| 80 | |||
| 81 | The Amazon S3 path that leads to the input data used to generate the | ||
| 82 | batch inference job. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 JobName => Str | ||
| 86 | |||
| 87 | The name of the batch inference job. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 JobOutput => L<Paws::Personalize::BatchInferenceJobOutput> | ||
| 91 | |||
| 92 | The Amazon S3 bucket that contains the output data generated by the | ||
| 93 | batch inference job. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 LastUpdatedDateTime => Str | ||
| 97 | |||
| 98 | The time at which the batch inference job was last updated. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 NumResults => Int | ||
| 102 | |||
| 103 | The number of recommendations generated by the batch inference job. | ||
| 104 | This number includes the error messages generated for failed input | ||
| 105 | records. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 RoleArn => Str | ||
| 109 | |||
| 110 | The ARN of the Amazon Identity and Access Management (IAM) role that | ||
| 111 | requested the batch inference job. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 SolutionVersionArn => Str | ||
| 115 | |||
| 116 | The Amazon Resource Name (ARN) of the solution version from which the | ||
| 117 | batch inference job was created. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 Status => Str | ||
| 121 | |||
| 122 | The status of the batch inference job. The status is one of the | ||
| 123 | following values: | ||
| 124 | |||
| 125 | =over | ||
| 126 | |||
| 127 | =item * | ||
| 128 | |||
| 129 | PENDING | ||
| 130 | |||
| 131 | =item * | ||
| 132 | |||
| 133 | IN PROGRESS | ||
| 134 | |||
| 135 | =item * | ||
| 136 | |||
| 137 | ACTIVE | ||
| 138 | |||
| 139 | =item * | ||
| 140 | |||
| 141 | CREATE FAILED | ||
| 142 | |||
| 143 | =back | ||
| 144 | |||
| 145 | |||
| 146 | |||
| 147 | |||
| 148 | =head1 SEE ALSO | ||
| 149 | |||
| 150 | This class forms part of L<Paws>, describing an object used in L<Paws::Personalize> | ||
| 151 | |||
| 152 | =head1 BUGS and CONTRIBUTIONS | ||
| 153 | |||
| 154 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 155 | |||
| 156 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 157 | |||
| 158 | =cut | ||
| 159 |