| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::S3Control::JobDescriptor; | ||
| 3 | use Moose; | ||
| 4 | has ConfirmationRequired => (is => 'ro', isa => 'Bool'); | ||
| 5 | has CreationTime => (is => 'ro', isa => 'Str'); | ||
| 6 | has Description => (is => 'ro', isa => 'Str'); | ||
| 7 | has FailureReasons => (is => 'ro', isa => 'ArrayRef[Paws::S3Control::JobFailure]'); | ||
| 8 | has JobArn => (is => 'ro', isa => 'Str'); | ||
| 9 | has JobId => (is => 'ro', isa => 'Str'); | ||
| 10 | has Manifest => (is => 'ro', isa => 'Paws::S3Control::JobManifest'); | ||
| 11 | has Operation => (is => 'ro', isa => 'Paws::S3Control::JobOperation'); | ||
| 12 | has Priority => (is => 'ro', isa => 'Int'); | ||
| 13 | has ProgressSummary => (is => 'ro', isa => 'Paws::S3Control::JobProgressSummary'); | ||
| 14 | has Report => (is => 'ro', isa => 'Paws::S3Control::JobReport'); | ||
| 15 | has RoleArn => (is => 'ro', isa => 'Str'); | ||
| 16 | has Status => (is => 'ro', isa => 'Str'); | ||
| 17 | has StatusUpdateReason => (is => 'ro', isa => 'Str'); | ||
| 18 | has SuspendedCause => (is => 'ro', isa => 'Str'); | ||
| 19 | has SuspendedDate => (is => 'ro', isa => 'Str'); | ||
| 20 | has TerminationDate => (is => 'ro', isa => 'Str'); | ||
| 21 | |||
| 22 | 1; | ||
| 23 | |||
| 24 | ### main pod documentation begin ### | ||
| 25 | |||
| 26 | =head1 NAME | ||
| 27 | |||
| 28 | Paws::S3Control::JobDescriptor | ||
| 29 | |||
| 30 | =head1 USAGE | ||
| 31 | |||
| 32 | This class represents one of two things: | ||
| 33 | |||
| 34 | =head3 Arguments in a call to a service | ||
| 35 | |||
| 36 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 37 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 38 | |||
| 39 | As an example, if Att1 is expected to be a Paws::S3Control::JobDescriptor object: | ||
| 40 | |||
| 41 | $service_obj->Method(Att1 => { ConfirmationRequired => $value, ..., TerminationDate => $value }); | ||
| 42 | |||
| 43 | =head3 Results returned from an API call | ||
| 44 | |||
| 45 | Use accessors for each attribute. If Att1 is expected to be an Paws::S3Control::JobDescriptor object: | ||
| 46 | |||
| 47 | $result = $service_obj->Method(...); | ||
| 48 | $result->Att1->ConfirmationRequired | ||
| 49 | |||
| 50 | =head1 DESCRIPTION | ||
| 51 | |||
| 52 | A container element for the job configuration and status information | ||
| 53 | returned by a C<Describe Job> request. | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 ConfirmationRequired => Bool | ||
| 59 | |||
| 60 | Indicates whether confirmation is required before Amazon S3 begins | ||
| 61 | running the specified job. Confirmation is required only for jobs | ||
| 62 | created through the Amazon S3 console. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 CreationTime => Str | ||
| 66 | |||
| 67 | A timestamp indicating when this job was created. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 Description => Str | ||
| 71 | |||
| 72 | The description for this job, if one was provided in this job's | ||
| 73 | C<Create Job> request. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 FailureReasons => ArrayRef[L<Paws::S3Control::JobFailure>] | ||
| 77 | |||
| 78 | If the specified job failed, this field contains information describing | ||
| 79 | the failure. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 JobArn => Str | ||
| 83 | |||
| 84 | The Amazon Resource Name (ARN) for this job. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 JobId => Str | ||
| 88 | |||
| 89 | The ID for the specified job. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 Manifest => L<Paws::S3Control::JobManifest> | ||
| 93 | |||
| 94 | The configuration information for the specified job's manifest object. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 Operation => L<Paws::S3Control::JobOperation> | ||
| 98 | |||
| 99 | The operation that the specified job is configured to run on the | ||
| 100 | objects listed in the manifest. | ||
| 101 | |||
| 102 | |||
| 103 | =head2 Priority => Int | ||
| 104 | |||
| 105 | The priority of the specified job. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 ProgressSummary => L<Paws::S3Control::JobProgressSummary> | ||
| 109 | |||
| 110 | Describes the total number of tasks that the specified job has run, the | ||
| 111 | number of tasks that succeeded, and the number of tasks that failed. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 Report => L<Paws::S3Control::JobReport> | ||
| 115 | |||
| 116 | Contains the configuration information for the job-completion report if | ||
| 117 | you requested one in the C<Create Job> request. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 RoleArn => Str | ||
| 121 | |||
| 122 | The Amazon Resource Name (ARN) for the AWS Identity and Access | ||
| 123 | Management (IAM) role assigned to run the tasks for this job. | ||
| 124 | |||
| 125 | |||
| 126 | =head2 Status => Str | ||
| 127 | |||
| 128 | The current status of the specified job. | ||
| 129 | |||
| 130 | |||
| 131 | =head2 StatusUpdateReason => Str | ||
| 132 | |||
| 133 | The reason for updating the job. | ||
| 134 | |||
| 135 | |||
| 136 | =head2 SuspendedCause => Str | ||
| 137 | |||
| 138 | The reason why the specified job was suspended. A job is only suspended | ||
| 139 | if you create it through the Amazon S3 console. When you create the | ||
| 140 | job, it enters the C<Suspended> state to await confirmation before | ||
| 141 | running. After you confirm the job, it automatically exits the | ||
| 142 | C<Suspended> state. | ||
| 143 | |||
| 144 | |||
| 145 | =head2 SuspendedDate => Str | ||
| 146 | |||
| 147 | The timestamp when this job was suspended, if it has been suspended. | ||
| 148 | |||
| 149 | |||
| 150 | =head2 TerminationDate => Str | ||
| 151 | |||
| 152 | A timestamp indicating when this job terminated. A job's termination | ||
| 153 | date is the date and time when it succeeded, failed, or was canceled. | ||
| 154 | |||
| 155 | |||
| 156 | |||
| 157 | =head1 SEE ALSO | ||
| 158 | |||
| 159 | This class forms part of L<Paws>, describing an object used in L<Paws::S3Control> | ||
| 160 | |||
| 161 | =head1 BUGS and CONTRIBUTIONS | ||
| 162 | |||
| 163 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 164 | |||
| 165 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 166 | |||
| 167 | =cut | ||
| 168 |