NAME

Paws::ElasticBeanstalk::DescribeEnvironmentHealth - Arguments for method DescribeEnvironmentHealth on Paws::ElasticBeanstalk

DESCRIPTION

This class represents the parameters used for calling the method DescribeEnvironmentHealth on the AWS Elastic Beanstalk service. Use the attributes of this class as arguments to method DescribeEnvironmentHealth.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeEnvironmentHealth.

SYNOPSIS

  my $elasticbeanstalk = Paws->service('ElasticBeanstalk');
  # To view environment health
  # The following operation retrieves overall health information for an
  # environment named my-env:
  my $DescribeEnvironmentHealthResult =
    $elasticbeanstalk->DescribeEnvironmentHealth(
    'AttributeNames'  => ['All'],
    'EnvironmentName' => 'my-env'
    );

  # Results:
  my $ApplicationMetrics =
    $DescribeEnvironmentHealthResult->ApplicationMetrics;
  my $Causes          = $DescribeEnvironmentHealthResult->Causes;
  my $Color           = $DescribeEnvironmentHealthResult->Color;
  my $EnvironmentName = $DescribeEnvironmentHealthResult->EnvironmentName;
  my $HealthStatus    = $DescribeEnvironmentHealthResult->HealthStatus;
  my $InstancesHealth = $DescribeEnvironmentHealthResult->InstancesHealth;
  my $RefreshedAt     = $DescribeEnvironmentHealthResult->RefreshedAt;

# Returns a L<Paws::ElasticBeanstalk::DescribeEnvironmentHealthResult> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk/DescribeEnvironmentHealth

ATTRIBUTES

AttributeNames => ArrayRef[Str|Undef]

Specify the response elements to return. To retrieve all attributes, set to All. If no attribute names are specified, returns the name of the environment.

EnvironmentId => Str

Specify the environment by ID.

You must specify either this or an EnvironmentName, or both.

EnvironmentName => Str

Specify the environment by name.

You must specify either this or an EnvironmentName, or both.

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeEnvironmentHealth in Paws::ElasticBeanstalk

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues