The Health API provides access to the Health information that appears in the\nHealth Dashboard. You can use\nthe API operations to get information about events that might affect your Amazon Web Services services and resources.
\nYou must have a Business, Enterprise On-Ramp, or Enterprise Support plan from Amazon Web Services Support to use the Health API. If you call the Health API from an\nAmazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a\nSubscriptionRequiredException error.
For API access, you need an access key ID and a secret access key. Use temporary\ncredentials instead of long-term access keys when possible. Temporary credentials include\nan access key ID, a secret access key, and a security token that indicates when the\ncredentials expire. For more information, see Best practices for managing\nAmazon Web Services access keys in the Amazon Web Services General Reference.
\nYou can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to call the\nHealth API operations. Health supports a multi-Region application architecture\nand has two regional endpoints in an active-passive configuration. You can use the high\navailability endpoint example to determine which Amazon Web Services Region is active, so that you can\nget the latest information from the API. For more information, see Accessing the Health\nAPI in the Health User Guide.
\nFor authentication of requests, Health uses the Signature Version 4 Signing\nProcess.
\nIf your Amazon Web Services account is part of Organizations, you can use the Health organizational\nview feature. This feature provides a centralized view of Health events across all\naccounts in your organization. You can aggregate Health events in real time to\nidentify accounts in your organization that are affected by an operational event or get\nnotified of security vulnerabilities. Use the organizational view API operations to enable\nthis feature and return event information. For more information, see Aggregating\nHealth events in the Health User Guide.
\nWhen you use the Health API operations to return Health events, see the\nfollowing recommendations:
\nUse the eventScopeCode parameter to specify whether to return Health\nevents that are public or account-specific.
\nUse pagination to view all events from the response. For example, if you call\nthe DescribeEventsForOrganization operation to get all events in your\norganization, you might receive several page results. Specify the\nnextToken in the next request to return more results.