describeInstancesHealth method

Future<DescribeInstancesHealthResult> describeInstancesHealth({ List<InstancesHealthAttribute>? attributeNames, String? environmentId, String? environmentName, String? nextToken, })

Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.

May throw InvalidRequestException. May throw ElasticBeanstalkServiceException.

Parameter attributeNames : Specifies the response elements you wish to receive. To retrieve all attributes, set to All. If no attribute names are specified, returns a list of instances.

Parameter environmentId : Specify the AWS Elastic Beanstalk environment by ID.

Parameter environmentName : Specify the AWS Elastic Beanstalk environment by name.

Parameter nextToken : Specify the pagination token returned by a previous call.

Implementation

Future<DescribeInstancesHealthResult> describeInstancesHealth({
  List<InstancesHealthAttribute>? attributeNames,
  String? environmentId,
  String? environmentName,
  String? nextToken,
}) async {
  _s.validateStringLength(
    'environmentName',
    environmentName,
    4,
    40,
  );
  _s.validateStringLength(
    'nextToken',
    nextToken,
    1,
    100,
  );
  final $request = <String, dynamic>{};
  attributeNames?.also((arg) =>
      $request['AttributeNames'] = arg.map((e) => e.toValue()).toList());
  environmentId?.also((arg) => $request['EnvironmentId'] = arg);
  environmentName?.also((arg) => $request['EnvironmentName'] = arg);
  nextToken?.also((arg) => $request['NextToken'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeInstancesHealth',
    version: '2010-12-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeInstancesHealthRequest'],
    shapes: shapes,
    resultWrapper: 'DescribeInstancesHealthResult',
  );
  return DescribeInstancesHealthResult.fromXml($result);
}