| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Batch::JobDetail; | ||
| 3 | use Moose; | ||
| 4 | has ArrayProperties => (is => 'ro', isa => 'Paws::Batch::ArrayPropertiesDetail', request_name => 'arrayProperties', traits => ['NameInRequest']); | ||
| 5 | has Attempts => (is => 'ro', isa => 'ArrayRef[Paws::Batch::AttemptDetail]', request_name => 'attempts', traits => ['NameInRequest']); | ||
| 6 | has Container => (is => 'ro', isa => 'Paws::Batch::ContainerDetail', request_name => 'container', traits => ['NameInRequest']); | ||
| 7 | has CreatedAt => (is => 'ro', isa => 'Int', request_name => 'createdAt', traits => ['NameInRequest']); | ||
| 8 | has DependsOn => (is => 'ro', isa => 'ArrayRef[Paws::Batch::JobDependency]', request_name => 'dependsOn', traits => ['NameInRequest']); | ||
| 9 | has JobArn => (is => 'ro', isa => 'Str', request_name => 'jobArn', traits => ['NameInRequest']); | ||
| 10 | has JobDefinition => (is => 'ro', isa => 'Str', request_name => 'jobDefinition', traits => ['NameInRequest'], required => 1); | ||
| 11 | has JobId => (is => 'ro', isa => 'Str', request_name => 'jobId', traits => ['NameInRequest'], required => 1); | ||
| 12 | has JobName => (is => 'ro', isa => 'Str', request_name => 'jobName', traits => ['NameInRequest'], required => 1); | ||
| 13 | has JobQueue => (is => 'ro', isa => 'Str', request_name => 'jobQueue', traits => ['NameInRequest'], required => 1); | ||
| 14 | has NodeDetails => (is => 'ro', isa => 'Paws::Batch::NodeDetails', request_name => 'nodeDetails', traits => ['NameInRequest']); | ||
| 15 | has NodeProperties => (is => 'ro', isa => 'Paws::Batch::NodeProperties', request_name => 'nodeProperties', traits => ['NameInRequest']); | ||
| 16 | has Parameters => (is => 'ro', isa => 'Paws::Batch::ParametersMap', request_name => 'parameters', traits => ['NameInRequest']); | ||
| 17 | has PlatformCapabilities => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'platformCapabilities', traits => ['NameInRequest']); | ||
| 18 | has PropagateTags => (is => 'ro', isa => 'Bool', request_name => 'propagateTags', traits => ['NameInRequest']); | ||
| 19 | has RetryStrategy => (is => 'ro', isa => 'Paws::Batch::RetryStrategy', request_name => 'retryStrategy', traits => ['NameInRequest']); | ||
| 20 | has StartedAt => (is => 'ro', isa => 'Int', request_name => 'startedAt', traits => ['NameInRequest'], required => 1); | ||
| 21 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest'], required => 1); | ||
| 22 | has StatusReason => (is => 'ro', isa => 'Str', request_name => 'statusReason', traits => ['NameInRequest']); | ||
| 23 | has StoppedAt => (is => 'ro', isa => 'Int', request_name => 'stoppedAt', traits => ['NameInRequest']); | ||
| 24 | has Tags => (is => 'ro', isa => 'Paws::Batch::TagrisTagsMap', request_name => 'tags', traits => ['NameInRequest']); | ||
| 25 | has Timeout => (is => 'ro', isa => 'Paws::Batch::JobTimeout', request_name => 'timeout', traits => ['NameInRequest']); | ||
| 26 | |||
| 27 | 1; | ||
| 28 | |||
| 29 | ### main pod documentation begin ### | ||
| 30 | |||
| 31 | =head1 NAME | ||
| 32 | |||
| 33 | Paws::Batch::JobDetail | ||
| 34 | |||
| 35 | =head1 USAGE | ||
| 36 | |||
| 37 | This class represents one of two things: | ||
| 38 | |||
| 39 | =head3 Arguments in a call to a service | ||
| 40 | |||
| 41 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 42 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 43 | |||
| 44 | As an example, if Att1 is expected to be a Paws::Batch::JobDetail object: | ||
| 45 | |||
| 46 | $service_obj->Method(Att1 => { ArrayProperties => $value, ..., Timeout => $value }); | ||
| 47 | |||
| 48 | =head3 Results returned from an API call | ||
| 49 | |||
| 50 | Use accessors for each attribute. If Att1 is expected to be an Paws::Batch::JobDetail object: | ||
| 51 | |||
| 52 | $result = $service_obj->Method(...); | ||
| 53 | $result->Att1->ArrayProperties | ||
| 54 | |||
| 55 | =head1 DESCRIPTION | ||
| 56 | |||
| 57 | An object representing an AWS Batch job. | ||
| 58 | |||
| 59 | =head1 ATTRIBUTES | ||
| 60 | |||
| 61 | |||
| 62 | =head2 ArrayProperties => L<Paws::Batch::ArrayPropertiesDetail> | ||
| 63 | |||
| 64 | The array properties of the job, if it is an array job. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 Attempts => ArrayRef[L<Paws::Batch::AttemptDetail>] | ||
| 68 | |||
| 69 | A list of job attempts associated with this job. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 Container => L<Paws::Batch::ContainerDetail> | ||
| 73 | |||
| 74 | An object representing the details of the container that's associated | ||
| 75 | with the job. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 CreatedAt => Int | ||
| 79 | |||
| 80 | The Unix timestamp (in milliseconds) for when the job was created. For | ||
| 81 | non-array jobs and parent array jobs, this is when the job entered the | ||
| 82 | C<SUBMITTED> state (at the time SubmitJob was called). For array child | ||
| 83 | jobs, this is when the child job was spawned by its parent and entered | ||
| 84 | the C<PENDING> state. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 DependsOn => ArrayRef[L<Paws::Batch::JobDependency>] | ||
| 88 | |||
| 89 | A list of job IDs that this job depends on. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 JobArn => Str | ||
| 93 | |||
| 94 | The Amazon Resource Name (ARN) of the job. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 B<REQUIRED> JobDefinition => Str | ||
| 98 | |||
| 99 | The job definition that's used by this job. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 B<REQUIRED> JobId => Str | ||
| 103 | |||
| 104 | The ID for the job. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 B<REQUIRED> JobName => Str | ||
| 108 | |||
| 109 | The name of the job. | ||
| 110 | |||
| 111 | |||
| 112 | =head2 B<REQUIRED> JobQueue => Str | ||
| 113 | |||
| 114 | The Amazon Resource Name (ARN) of the job queue that the job is | ||
| 115 | associated with. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 NodeDetails => L<Paws::Batch::NodeDetails> | ||
| 119 | |||
| 120 | An object representing the details of a node that's associated with a | ||
| 121 | multi-node parallel job. | ||
| 122 | |||
| 123 | |||
| 124 | =head2 NodeProperties => L<Paws::Batch::NodeProperties> | ||
| 125 | |||
| 126 | An object representing the node properties of a multi-node parallel | ||
| 127 | job. | ||
| 128 | |||
| 129 | This isn't applicable to jobs running on Fargate resources. | ||
| 130 | |||
| 131 | |||
| 132 | =head2 Parameters => L<Paws::Batch::ParametersMap> | ||
| 133 | |||
| 134 | Additional parameters passed to the job that replace parameter | ||
| 135 | substitution placeholders or override any corresponding parameter | ||
| 136 | defaults from the job definition. | ||
| 137 | |||
| 138 | |||
| 139 | =head2 PlatformCapabilities => ArrayRef[Str|Undef] | ||
| 140 | |||
| 141 | The platform capabilities required by the job definition. If no value | ||
| 142 | is specified, it defaults to C<EC2>. Jobs run on Fargate resources | ||
| 143 | specify C<FARGATE>. | ||
| 144 | |||
| 145 | |||
| 146 | =head2 PropagateTags => Bool | ||
| 147 | |||
| 148 | Specifies whether to propagate the tags from the job or job definition | ||
| 149 | to the corresponding Amazon ECS task. If no value is specified, the | ||
| 150 | tags aren't propagated. Tags can only be propagated to the tasks during | ||
| 151 | task creation. For tags with the same name, job tags are given priority | ||
| 152 | over job definitions tags. If the total number of combined tags from | ||
| 153 | the job and job definition is over 50, the job is moved to the | ||
| 154 | C<FAILED> state. | ||
| 155 | |||
| 156 | |||
| 157 | =head2 RetryStrategy => L<Paws::Batch::RetryStrategy> | ||
| 158 | |||
| 159 | The retry strategy to use for this job if an attempt fails. | ||
| 160 | |||
| 161 | |||
| 162 | =head2 B<REQUIRED> StartedAt => Int | ||
| 163 | |||
| 164 | The Unix timestamp (in milliseconds) for when the job was started (when | ||
| 165 | the job transitioned from the C<STARTING> state to the C<RUNNING> | ||
| 166 | state). This parameter isn't provided for child jobs of array jobs or | ||
| 167 | multi-node parallel jobs. | ||
| 168 | |||
| 169 | |||
| 170 | =head2 B<REQUIRED> Status => Str | ||
| 171 | |||
| 172 | The current status for the job. | ||
| 173 | |||
| 174 | If your jobs don't progress to C<STARTING>, see Jobs Stuck in RUNNABLE | ||
| 175 | Status | ||
| 176 | (https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#job_stuck_in_runnable) | ||
| 177 | in the troubleshooting section of the I<AWS Batch User Guide>. | ||
| 178 | |||
| 179 | |||
| 180 | =head2 StatusReason => Str | ||
| 181 | |||
| 182 | A short, human-readable string to provide additional details about the | ||
| 183 | current status of the job. | ||
| 184 | |||
| 185 | |||
| 186 | =head2 StoppedAt => Int | ||
| 187 | |||
| 188 | The Unix timestamp (in milliseconds) for when the job was stopped (when | ||
| 189 | the job transitioned from the C<RUNNING> state to a terminal state, | ||
| 190 | such as C<SUCCEEDED> or C<FAILED>). | ||
| 191 | |||
| 192 | |||
| 193 | =head2 Tags => L<Paws::Batch::TagrisTagsMap> | ||
| 194 | |||
| 195 | The tags applied to the job. | ||
| 196 | |||
| 197 | |||
| 198 | =head2 Timeout => L<Paws::Batch::JobTimeout> | ||
| 199 | |||
| 200 | The timeout configuration for the job. | ||
| 201 | |||
| 202 | |||
| 203 | |||
| 204 | =head1 SEE ALSO | ||
| 205 | |||
| 206 | This class forms part of L<Paws>, describing an object used in L<Paws::Batch> | ||
| 207 | |||
| 208 | =head1 BUGS and CONTRIBUTIONS | ||
| 209 | |||
| 210 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 211 | |||
| 212 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 213 | |||
| 214 | =cut | ||
| 215 |