Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).
AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws ]
The Health API provides programmatic access to the Health information that appears in the Personal Health Dashboard . You can use the API operations to get information about events that might affect your Amazon Web Services services and resources.
Note
SubscriptionRequiredException
error.For authentication of requests, Health uses the Signature Version 4 Signing Process .
If your Amazon Web Services account is part of Organizations, you can use the Health organizational view feature. This feature provides a centralized view of Health events across all accounts in your organization. You can aggregate Health events in real time to identify accounts in your organization that are affected by an operational event or get notified of security vulnerabilities. Use the organizational view API operations to enable this feature and return event information. For more information, see Aggregating Health events in the Health User Guide .
Note
When you use the Health API operations to return Health events, see the following recommendations:
DescribeEventsForOrganization
operation to get all events in your organization, you might receive several page results. Specify the nextToken
in the next request to return more results.