« blib/lib/Paws/Batch/UntagResourceResponse.pm
↑ Summary
blib/lib/Paws/Batch/UpdateComputeEnvironmentResponse.pm »
| 1 | |||
| 2 | package Paws::Batch::UpdateComputeEnvironment; | ||
| 3 | use Moose; | ||
| 4 | has ComputeEnvironment => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'computeEnvironment', required => 1); | ||
| 5 | has ComputeResources => (is => 'ro', isa => 'Paws::Batch::ComputeResourceUpdate', traits => ['NameInRequest'], request_name => 'computeResources'); | ||
| 6 | has ServiceRole => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'serviceRole'); | ||
| 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 => 'UpdateComputeEnvironment'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/updatecomputeenvironment'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Batch::UpdateComputeEnvironmentResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Batch::UpdateComputeEnvironment - Arguments for method UpdateComputeEnvironment on L<Paws::Batch> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method UpdateComputeEnvironment on the | ||
| 26 | L<AWS Batch|Paws::Batch> service. Use the attributes of this class | ||
| 27 | as arguments to method UpdateComputeEnvironment. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateComputeEnvironment. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $batch = Paws->service('Batch'); | ||
| 34 | # To update a compute environment | ||
| 35 | # This example disables the P2OnDemand compute environment so it can be deleted. | ||
| 36 | my $UpdateComputeEnvironmentResponse = $batch->UpdateComputeEnvironment( | ||
| 37 | 'ComputeEnvironment' => 'P2OnDemand', | ||
| 38 | 'State' => 'DISABLED' | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $computeEnvironmentArn = | ||
| 43 | $UpdateComputeEnvironmentResponse->computeEnvironmentArn; | ||
| 44 | my $computeEnvironmentName = | ||
| 45 | $UpdateComputeEnvironmentResponse->computeEnvironmentName; | ||
| 46 | |||
| 47 | # Returns a L<Paws::Batch::UpdateComputeEnvironmentResponse> object. | ||
| 48 | |||
| 49 | 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. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/batch/UpdateComputeEnvironment> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> ComputeEnvironment => Str | ||
| 56 | |||
| 57 | The name or full Amazon Resource Name (ARN) of the compute environment | ||
| 58 | to update. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 ComputeResources => L<Paws::Batch::ComputeResourceUpdate> | ||
| 63 | |||
| 64 | Details of the compute resources managed by the compute environment. | ||
| 65 | Required for a managed compute environment. For more information, see | ||
| 66 | Compute Environments | ||
| 67 | (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) | ||
| 68 | in the I<AWS Batch User Guide>. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 ServiceRole => Str | ||
| 73 | |||
| 74 | The full Amazon Resource Name (ARN) of the IAM role that allows AWS | ||
| 75 | Batch to make calls to other AWS services on your behalf. For more | ||
| 76 | information, see AWS Batch service IAM role | ||
| 77 | (https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html) | ||
| 78 | in the I<AWS Batch User Guide>. | ||
| 79 | |||
| 80 | If the compute environment has a service-linked role, it cannot be | ||
| 81 | changed to use a regular IAM role. If the compute environment has a | ||
| 82 | regular IAM role, it cannot be changed to use a service-linked role. | ||
| 83 | |||
| 84 | If your specified role has a path other than C</>, then you must either | ||
| 85 | specify the full role ARN (this is recommended) or prefix the role name | ||
| 86 | with the path. | ||
| 87 | |||
| 88 | Depending on how you created your AWS Batch service role, its ARN might | ||
| 89 | contain the C<service-role> path prefix. When you only specify the name | ||
| 90 | of the service role, AWS Batch assumes that your ARN doesn't use the | ||
| 91 | C<service-role> path prefix. Because of this, we recommend that you | ||
| 92 | specify the full ARN of your service role when you create compute | ||
| 93 | environments. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 State => Str | ||
| 98 | |||
| 99 | The state of the compute environment. Compute environments in the | ||
| 100 | C<ENABLED> state can accept jobs from a queue and scale in or out | ||
| 101 | automatically based on the workload demand of its associated queues. | ||
| 102 | |||
| 103 | If the state is C<ENABLED>, then the AWS Batch scheduler can attempt to | ||
| 104 | place jobs from an associated job queue on the compute resources within | ||
| 105 | the environment. If the compute environment is managed, then it can | ||
| 106 | scale its instances out or in automatically, based on the job queue | ||
| 107 | demand. | ||
| 108 | |||
| 109 | If the state is C<DISABLED>, then the AWS Batch scheduler doesn't | ||
| 110 | attempt to place jobs within the environment. Jobs in a C<STARTING> or | ||
| 111 | C<RUNNING> state continue to progress normally. Managed compute | ||
| 112 | environments in the C<DISABLED> state don't scale out. However, they | ||
| 113 | scale in to C<minvCpus> value after instances become idle. | ||
| 114 | |||
| 115 | Valid values are: C<"ENABLED">, C<"DISABLED"> | ||
| 116 | |||
| 117 | |||
| 118 | =head1 SEE ALSO | ||
| 119 | |||
| 120 | This class forms part of L<Paws>, documenting arguments for method UpdateComputeEnvironment in L<Paws::Batch> | ||
| 121 | |||
| 122 | =head1 BUGS and CONTRIBUTIONS | ||
| 123 | |||
| 124 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 125 | |||
| 126 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 127 | |||
| 128 | =cut | ||
| 129 |