« blib/lib/Paws/ElasticBeanstalk/DescribeEnvironmentResources.pm
↑ Summary
blib/lib/Paws/ElasticBeanstalk/DescribeInstancesHealthResult.pm »
| 1 | |||
| 2 | package Paws::ElasticBeanstalk::DescribeInstancesHealth; | ||
| 3 | use Moose; | ||
| 4 | has AttributeNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has EnvironmentId => (is => 'ro', isa => 'Str'); | ||
| 6 | has EnvironmentName => (is => 'ro', isa => 'Str'); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeInstancesHealth'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ElasticBeanstalk::DescribeInstancesHealthResult'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeInstancesHealthResult'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::ElasticBeanstalk::DescribeInstancesHealth - Arguments for method DescribeInstancesHealth on L<Paws::ElasticBeanstalk> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method DescribeInstancesHealth on the | ||
| 25 | L<AWS Elastic Beanstalk|Paws::ElasticBeanstalk> service. Use the attributes of this class | ||
| 26 | as arguments to method DescribeInstancesHealth. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeInstancesHealth. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $elasticbeanstalk = Paws->service('ElasticBeanstalk'); | ||
| 33 | # To view environment health | ||
| 34 | # The following operation retrieves health information for instances in an | ||
| 35 | # environment named my-env: | ||
| 36 | my $DescribeInstancesHealthResult = | ||
| 37 | $elasticbeanstalk->DescribeInstancesHealth( | ||
| 38 | 'AttributeNames' => ['All'], | ||
| 39 | 'EnvironmentName' => 'my-env' | ||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $InstanceHealthList = $DescribeInstancesHealthResult->InstanceHealthList; | ||
| 44 | my $RefreshedAt = $DescribeInstancesHealthResult->RefreshedAt; | ||
| 45 | |||
| 46 | # Returns a L<Paws::ElasticBeanstalk::DescribeInstancesHealthResult> object. | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk/DescribeInstancesHealth> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 AttributeNames => ArrayRef[Str|Undef] | ||
| 55 | |||
| 56 | Specifies the response elements you wish to receive. To retrieve all | ||
| 57 | attributes, set to C<All>. If no attribute names are specified, returns | ||
| 58 | a list of instances. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 EnvironmentId => Str | ||
| 63 | |||
| 64 | Specify the AWS Elastic Beanstalk environment by ID. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 EnvironmentName => Str | ||
| 69 | |||
| 70 | Specify the AWS Elastic Beanstalk environment by name. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 NextToken => Str | ||
| 75 | |||
| 76 | Specify the pagination token returned by a previous call. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head1 SEE ALSO | ||
| 82 | |||
| 83 | This class forms part of L<Paws>, documenting arguments for method DescribeInstancesHealth in L<Paws::ElasticBeanstalk> | ||
| 84 | |||
| 85 | =head1 BUGS and CONTRIBUTIONS | ||
| 86 | |||
| 87 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 88 | |||
| 89 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 90 | |||
| 91 | =cut | ||
| 92 |