AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Module: Aws::Health

Defined in:


This module provides a client for making API requests to AWS Health APIs and Notifications.


The Client class provides one-to-one mapping for each API operation.

health = 'us-east-1')
#=> [:describe_affected_accounts_for_organization, :describe_affected_entities, :describe_affected_entities_for_organization, :describe_entity_aggregates, ...]

Each API operation method accepts a hash of request parameters and returns a response object.

resp = health.describe_affected_accounts_for_organization(params)

See Client for more information.


Errors returned from AWS Health APIs and Notifications are defined in the Errors module and extend Errors::ServiceError.

  # do stuff
rescue Aws::Health::Errors::ServiceError
  # rescues all errors returned by AWS Health APIs and Notifications

See Errors for more information.

Defined Under Namespace

Modules: Errors, Types Classes: Client