« blib/lib/Paws/ECS/DescribeCapacityProvidersResponse.pm
↑ Summary
blib/lib/Paws/ECS/DescribeClustersResponse.pm »
| 1 | |||
| 2 | package Paws::ECS::DescribeClusters; | ||
| 3 | use Moose; | ||
| 4 | has Clusters => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'clusters' ); | ||
| 5 | has Include => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'include' ); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeClusters'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECS::DescribeClustersResponse'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::ECS::DescribeClusters - Arguments for method DescribeClusters on L<Paws::ECS> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method DescribeClusters on the | ||
| 23 | L<Amazon EC2 Container Service|Paws::ECS> service. Use the attributes of this class | ||
| 24 | as arguments to method DescribeClusters. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeClusters. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $ecs = Paws->service('ECS'); | ||
| 31 | # To describe a cluster | ||
| 32 | # This example provides a description of the specified cluster in your default | ||
| 33 | # region. | ||
| 34 | my $DescribeClustersResponse = | ||
| 35 | $ecs->DescribeClusters( 'Clusters' => ['default'] ); | ||
| 36 | |||
| 37 | # Results: | ||
| 38 | my $clusters = $DescribeClustersResponse->clusters; | ||
| 39 | my $failures = $DescribeClustersResponse->failures; | ||
| 40 | |||
| 41 | # Returns a L<Paws::ECS::DescribeClustersResponse> object. | ||
| 42 | |||
| 43 | 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. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ecs/DescribeClusters> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 Clusters => ArrayRef[Str|Undef] | ||
| 50 | |||
| 51 | A list of up to 100 cluster names or full cluster Amazon Resource Name | ||
| 52 | (ARN) entries. If you do not specify a cluster, the default cluster is | ||
| 53 | assumed. | ||
| 54 | |||
| 55 | |||
| 56 | |||
| 57 | =head2 Include => ArrayRef[Str|Undef] | ||
| 58 | |||
| 59 | Whether to include additional information about the clusters in the | ||
| 60 | response. If this field is omitted, this information isn't included. | ||
| 61 | |||
| 62 | If C<ATTACHMENTS> is specified, the attachments for the container | ||
| 63 | instances or tasks within the cluster are included. | ||
| 64 | |||
| 65 | If C<SETTINGS> is specified, the settings for the cluster are included. | ||
| 66 | |||
| 67 | If C<STATISTICS> is specified, the task and service count is included, | ||
| 68 | separated by launch type. | ||
| 69 | |||
| 70 | If C<TAGS> is specified, the metadata tags associated with the cluster | ||
| 71 | are included. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head1 SEE ALSO | ||
| 77 | |||
| 78 | This class forms part of L<Paws>, documenting arguments for method DescribeClusters in L<Paws::ECS> | ||
| 79 | |||
| 80 | =head1 BUGS and CONTRIBUTIONS | ||
| 81 | |||
| 82 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 83 | |||
| 84 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 85 | |||
| 86 | =cut | ||
| 87 |