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