« blib/lib/Paws/Batch/UpdateComputeEnvironmentResponse.pm
↑ Summary
blib/lib/Paws/Batch/UpdateJobQueueResponse.pm »
| 1 | |||
| 2 | package Paws::Batch::UpdateJobQueue; | ||
| 3 | use Moose; | ||
| 4 | has ComputeEnvironmentOrder => (is => 'ro', isa => 'ArrayRef[Paws::Batch::ComputeEnvironmentOrder]', traits => ['NameInRequest'], request_name => 'computeEnvironmentOrder'); | ||
| 5 | has JobQueue => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'jobQueue', required => 1); | ||
| 6 | has Priority => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'priority'); | ||
| 7 | has State => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'state'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateJobQueue'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/updatejobqueue'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Batch::UpdateJobQueueResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Batch::UpdateJobQueue - Arguments for method UpdateJobQueue on L<Paws::Batch> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method UpdateJobQueue on the | ||
| 26 | L<AWS Batch|Paws::Batch> service. Use the attributes of this class | ||
| 27 | as arguments to method UpdateJobQueue. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateJobQueue. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $batch = Paws->service('Batch'); | ||
| 34 | # To update a job queue | ||
| 35 | # This example disables a job queue so that it can be deleted. | ||
| 36 | my $UpdateJobQueueResponse = $batch->UpdateJobQueue( | ||
| 37 | 'JobQueue' => 'GPGPU', | ||
| 38 | 'State' => 'DISABLED' | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $jobQueueArn = $UpdateJobQueueResponse->jobQueueArn; | ||
| 43 | my $jobQueueName = $UpdateJobQueueResponse->jobQueueName; | ||
| 44 | |||
| 45 | # Returns a L<Paws::Batch::UpdateJobQueueResponse> object. | ||
| 46 | |||
| 47 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 48 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/batch/UpdateJobQueue> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 ComputeEnvironmentOrder => ArrayRef[L<Paws::Batch::ComputeEnvironmentOrder>] | ||
| 54 | |||
| 55 | Details the set of compute environments mapped to a job queue and their | ||
| 56 | order relative to each other. This is one of the parameters used by the | ||
| 57 | job scheduler to determine which compute environment should run a given | ||
| 58 | job. Compute environments must be in the C<VALID> state before you can | ||
| 59 | associate them with a job queue. All of the compute environments must | ||
| 60 | be either EC2 (C<EC2> or C<SPOT>) or Fargate (C<FARGATE> or | ||
| 61 | C<FARGATE_SPOT>). EC2 and Fargate compute environments can't be mixed. | ||
| 62 | |||
| 63 | All compute environments that are associated with a job queue must | ||
| 64 | share the same architecture. AWS Batch doesn't support mixing compute | ||
| 65 | environment architecture types in a single job queue. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> JobQueue => Str | ||
| 70 | |||
| 71 | The name or the Amazon Resource Name (ARN) of the job queue. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 Priority => Int | ||
| 76 | |||
| 77 | The priority of the job queue. Job queues with a higher priority (or a | ||
| 78 | higher integer value for the C<priority> parameter) are evaluated first | ||
| 79 | when associated with the same compute environment. Priority is | ||
| 80 | determined in descending order, for example, a job queue with a | ||
| 81 | priority value of C<10> is given scheduling preference over a job queue | ||
| 82 | with a priority value of C<1>. All of the compute environments must be | ||
| 83 | either EC2 (C<EC2> or C<SPOT>) or Fargate (C<FARGATE> or | ||
| 84 | C<FARGATE_SPOT>). EC2 and Fargate compute environments can't be mixed. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 State => Str | ||
| 89 | |||
| 90 | Describes the queue's ability to accept new jobs. If the job queue | ||
| 91 | state is C<ENABLED>, it can accept jobs. If the job queue state is | ||
| 92 | C<DISABLED>, new jobs can't be added to the queue, but jobs already in | ||
| 93 | the queue can finish. | ||
| 94 | |||
| 95 | Valid values are: C<"ENABLED">, C<"DISABLED"> | ||
| 96 | |||
| 97 | |||
| 98 | =head1 SEE ALSO | ||
| 99 | |||
| 100 | This class forms part of L<Paws>, documenting arguments for method UpdateJobQueue in L<Paws::Batch> | ||
| 101 | |||
| 102 | =head1 BUGS and CONTRIBUTIONS | ||
| 103 | |||
| 104 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 105 | |||
| 106 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 107 | |||
| 108 | =cut | ||
| 109 |