« blib/lib/Paws/Batch/DeregisterJobDefinitionResponse.pm
↑ Summary
blib/lib/Paws/Batch/DescribeComputeEnvironmentsResponse.pm »
| 1 | |||
| 2 | package Paws::Batch::DescribeComputeEnvironments; | ||
| 3 | use Moose; | ||
| 4 | has ComputeEnvironments => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'computeEnvironments'); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeComputeEnvironments'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/describecomputeenvironments'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Batch::DescribeComputeEnvironmentsResponse'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Batch::DescribeComputeEnvironments - Arguments for method DescribeComputeEnvironments on L<Paws::Batch> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method DescribeComputeEnvironments on the | ||
| 25 | L<AWS Batch|Paws::Batch> service. Use the attributes of this class | ||
| 26 | as arguments to method DescribeComputeEnvironments. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeComputeEnvironments. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $batch = Paws->service('Batch'); | ||
| 33 | # To describe a compute environment | ||
| 34 | # This example describes the P2OnDemand compute environment. | ||
| 35 | my $DescribeComputeEnvironmentsResponse = | ||
| 36 | $batch->DescribeComputeEnvironments( | ||
| 37 | 'ComputeEnvironments' => ['P2OnDemand'] ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $computeEnvironments = | ||
| 41 | $DescribeComputeEnvironmentsResponse->computeEnvironments; | ||
| 42 | |||
| 43 | # Returns a L<Paws::Batch::DescribeComputeEnvironmentsResponse> object. | ||
| 44 | |||
| 45 | 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. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/batch/DescribeComputeEnvironments> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 ComputeEnvironments => ArrayRef[Str|Undef] | ||
| 52 | |||
| 53 | A list of up to 100 compute environment names or full Amazon Resource | ||
| 54 | Name (ARN) entries. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 MaxResults => Int | ||
| 59 | |||
| 60 | The maximum number of cluster results returned by | ||
| 61 | C<DescribeComputeEnvironments> in paginated output. When this parameter | ||
| 62 | is used, C<DescribeComputeEnvironments> only returns C<maxResults> | ||
| 63 | results in a single page along with a C<nextToken> response element. | ||
| 64 | The remaining results of the initial request can be seen by sending | ||
| 65 | another C<DescribeComputeEnvironments> request with the returned | ||
| 66 | C<nextToken> value. This value can be between 1 and 100. If this | ||
| 67 | parameter isn't used, then C<DescribeComputeEnvironments> returns up to | ||
| 68 | 100 results and a C<nextToken> value if applicable. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 NextToken => Str | ||
| 73 | |||
| 74 | The C<nextToken> value returned from a previous paginated | ||
| 75 | C<DescribeComputeEnvironments> request where C<maxResults> was used and | ||
| 76 | the results exceeded the value of that parameter. Pagination continues | ||
| 77 | from the end of the previous results that returned the C<nextToken> | ||
| 78 | value. This value is C<null> when there are no more results to return. | ||
| 79 | |||
| 80 | This token should be treated as an opaque identifier that's only used | ||
| 81 | to retrieve the next items in a list and not for other programmatic | ||
| 82 | purposes. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head1 SEE ALSO | ||
| 88 | |||
| 89 | This class forms part of L<Paws>, documenting arguments for method DescribeComputeEnvironments in L<Paws::Batch> | ||
| 90 | |||
| 91 | =head1 BUGS and CONTRIBUTIONS | ||
| 92 | |||
| 93 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 94 | |||
| 95 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 96 | |||
| 97 | =cut | ||
| 98 |