« blib/lib/Paws/CloudWatchEvents/BatchArrayProperties.pm
↑ Summary
blib/lib/Paws/CloudWatchEvents/BatchRetryStrategy.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudWatchEvents::BatchParameters; | ||
| 3 | use Moose; | ||
| 4 | has ArrayProperties => (is => 'ro', isa => 'Paws::CloudWatchEvents::BatchArrayProperties'); | ||
| 5 | has JobDefinition => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has JobName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has RetryStrategy => (is => 'ro', isa => 'Paws::CloudWatchEvents::BatchRetryStrategy'); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::CloudWatchEvents::BatchParameters | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::CloudWatchEvents::BatchParameters object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { ArrayProperties => $value, ..., RetryStrategy => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudWatchEvents::BatchParameters object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->ArrayProperties | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | The custom parameters to be used when the target is an AWS Batch job. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 ArrayProperties => L<Paws::CloudWatchEvents::BatchArrayProperties> | ||
| 45 | |||
| 46 | The array properties for the submitted job, such as the size of the | ||
| 47 | array. The array size can be between 2 and 10,000. If you specify array | ||
| 48 | properties for a job, it becomes an array job. This parameter is used | ||
| 49 | only if the target is an AWS Batch job. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> JobDefinition => Str | ||
| 53 | |||
| 54 | The ARN or name of the job definition to use if the event target is an | ||
| 55 | AWS Batch job. This job definition must already exist. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> JobName => Str | ||
| 59 | |||
| 60 | The name to use for this execution of the job, if the target is an AWS | ||
| 61 | Batch job. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 RetryStrategy => L<Paws::CloudWatchEvents::BatchRetryStrategy> | ||
| 65 | |||
| 66 | The retry strategy to use for failed jobs, if the target is an AWS | ||
| 67 | Batch job. The retry strategy is the number of times to retry the | ||
| 68 | failed job execution. Valid values are 1E<ndash>10. When you specify a | ||
| 69 | retry strategy here, it overrides the retry strategy defined in the job | ||
| 70 | definition. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head1 SEE ALSO | ||
| 75 | |||
| 76 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudWatchEvents> | ||
| 77 | |||
| 78 | =head1 BUGS and CONTRIBUTIONS | ||
| 79 | |||
| 80 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 81 | |||
| 82 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 83 | |||
| 84 | =cut | ||
| 85 |