« blib/lib/Paws/ECS/DescribeClustersResponse.pm
↑ Summary
blib/lib/Paws/ECS/DescribeContainerInstancesResponse.pm »
| 1 | |||
| 2 | package Paws::ECS::DescribeContainerInstances; | ||
| 3 | use Moose; | ||
| 4 | has Cluster => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'cluster' ); | ||
| 5 | has ContainerInstances => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'containerInstances' , required => 1); | ||
| 6 | has Include => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'include' ); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeContainerInstances'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECS::DescribeContainerInstancesResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::ECS::DescribeContainerInstances - Arguments for method DescribeContainerInstances on L<Paws::ECS> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method DescribeContainerInstances on the | ||
| 24 | L<Amazon EC2 Container Service|Paws::ECS> service. Use the attributes of this class | ||
| 25 | as arguments to method DescribeContainerInstances. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeContainerInstances. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $ecs = Paws->service('ECS'); | ||
| 32 | # To describe container instance | ||
| 33 | # This example provides a description of the specified container instance in | ||
| 34 | # your default region, using the container instance UUID as an identifier. | ||
| 35 | my $DescribeContainerInstancesResponse = $ecs->DescribeContainerInstances( | ||
| 36 | 'Cluster' => 'default', | ||
| 37 | 'ContainerInstances' => ['f2756532-8f13-4d53-87c9-aed50dc94cd7'] | ||
| 38 | ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $containerInstances = | ||
| 42 | $DescribeContainerInstancesResponse->containerInstances; | ||
| 43 | my $failures = $DescribeContainerInstancesResponse->failures; | ||
| 44 | |||
| 45 | # Returns a L<Paws::ECS::DescribeContainerInstancesResponse> 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/ecs/DescribeContainerInstances> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 Cluster => Str | ||
| 54 | |||
| 55 | The short name or full Amazon Resource Name (ARN) of the cluster that | ||
| 56 | hosts the container instances to describe. If you do not specify a | ||
| 57 | cluster, the default cluster is assumed. This parameter is required if | ||
| 58 | the container instance or container instances you are describing were | ||
| 59 | launched in any cluster other than the default cluster. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> ContainerInstances => ArrayRef[Str|Undef] | ||
| 64 | |||
| 65 | A list of up to 100 container instance IDs or full Amazon Resource Name | ||
| 66 | (ARN) entries. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 Include => ArrayRef[Str|Undef] | ||
| 71 | |||
| 72 | Specifies whether you want to see the resource tags for the container | ||
| 73 | instance. If C<TAGS> is specified, the tags are included in the | ||
| 74 | response. If this field is omitted, tags are not included in the | ||
| 75 | response. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head1 SEE ALSO | ||
| 81 | |||
| 82 | This class forms part of L<Paws>, documenting arguments for method DescribeContainerInstances in L<Paws::ECS> | ||
| 83 | |||
| 84 | =head1 BUGS and CONTRIBUTIONS | ||
| 85 | |||
| 86 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 87 | |||
| 88 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 89 | |||
| 90 | =cut | ||
| 91 |