AWS Health APIs and Notifications
Health The Health API provides access to the Health information that appears in the Health Dashboard . You can use the API operations to get information about…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Health
The Health API provides access to the Health information that appears in the
Health Dashboard . You can use
the API operations to get information about events that might affect your Amazon Web Services services and resources.
You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan from Amazon Web Services Support to use the Health API. If you're in an Amazon Web Services Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Health API with a Business, Enterprise On-Ramp, or Enterprise Support plan. If you call the Health API from an
Amazon Web Services account that isn't enrolled in one of these plans, then you receive a
SubscriptionRequiredException error.
For API access, you need an access key ID and a secret access key. Use temporary
credentials instead of long-term access keys when possible. Temporary credentials include
an access key ID, a secret access key, and a security token that indicates when the
credentials expire. For more information, see Best practices for managing
Amazon Web Services access keys in the Amazon Web Services General Reference .
You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to call the
Health API operations. Health supports a multi-Region application architecture
and has two regional endpoints in an active-passive configuration. You can use the high
availability endpoint example to determine which Amazon Web Services Region is active, so that you can
get the latest information from the API. For more information, see Accessing the Health
API in the Health User Guide .
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 .
When you use the Health API operations to return Health events, see the
following recommendations:
Use the eventScopeCode parameter to specify whether to return Health
events that are public or account-specific.
Use pagination to view all events from the response. For example, if you call
the 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.
Endpoints 27
- POSTConfigure tags
/#X-Amz-Target=AWSHealth_20160804.ConfigureTagsConfigures which resource tag keys are tracked by Health for your account. This operation replaces the existing configuration with the specified tag keys.… - POSTConfigure tags for organization
/#X-Amz-Target=AWSHealth_20160804.ConfigureTagsForOrganizationConfigures which tag keys are tracked by Health for all accounts in your organization. This operation replaces the existing configuration with the specified… - POSTDescribe affected accounts for organization
/#X-Amz-Target=AWSHealth_20160804.DescribeAffectedAccountsForOrganizationReturns a list of accounts in the organization from Organizations that are affected by the provided event. For more information about the different types of… - POSTDescribe affected entities
/#X-Amz-Target=AWSHealth_20160804.DescribeAffectedEntitiesReturns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer… - POSTDescribe affected entities for organization
/#X-Amz-Target=AWSHealth_20160804.DescribeAffectedEntitiesForOrganizationReturns a list of entities that have been affected by one or more events for one or more accounts in your organization in Organizations, based on the filter… - POSTDescribe entity aggregates
/#X-Amz-Target=AWSHealth_20160804.DescribeEntityAggregatesReturns the number of entities that are affected by each of the specified events. - POSTDescribe entity aggregates for organization
/#X-Amz-Target=AWSHealth_20160804.DescribeEntityAggregatesForOrganizationReturns a list of entity aggregates for your Organizations that are affected by each of the specified events. - POSTDescribe event aggregates
/#X-Amz-Target=AWSHealth_20160804.DescribeEventAggregatesReturns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in… - POSTDescribe event details
/#X-Amz-Target=AWSHealth_20160804.DescribeEventDetailsReturns detailed information about one or more specified events. Information includes standard event data (Amazon Web Services Region, service, and so on, as… - POSTDescribe event details for organization
/#X-Amz-Target=AWSHealth_20160804.DescribeEventDetailsForOrganizationReturns detailed information about one or more specified events for one or more Amazon Web Services accounts in your organization. This information includes… - POSTDescribe event types
/#X-Amz-Target=AWSHealth_20160804.DescribeEventTypesReturns the event types that meet the specified filter criteria. You can use this API operation to find information about the Health event, such as the… - POSTDescribe events
/#X-Amz-Target=AWSHealth_20160804.DescribeEventsReturns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description,… - POSTDescribe events for organization
/#X-Amz-Target=AWSHealth_20160804.DescribeEventsForOrganizationReturns information about events across your organization in Organizations. You can use the filters parameter to specify the events that you want to return.… - POSTDescribe health service status for organization
/#X-Amz-Target=AWSHealth_20160804.DescribeHealthServiceStatusForOrganizationThis operation provides status information on enabling or disabling Health to work with your organization. To call this operation, you must use the… - POSTDescribe service lifecycle
/#X-Amz-Target=AWSHealth_20160804.DescribeServiceLifecycleReturns lifecycle information for Amazon Web Services services, including end-of-life dates, version recommendations, and lifecycle events. - POSTDescribe tag keys
/#X-Amz-Target=AWSHealth_20160804.DescribeTagKeysReturns the list of resource tag keys configured for Health event tracking in your account. - POSTDescribe tag keys for organization
/#X-Amz-Target=AWSHealth_20160804.DescribeTagKeysForOrganizationReturns the list of tag keys configured for Health event tracking across your organization. - POSTDescribe tags
/#X-Amz-Target=AWSHealth_20160804.DescribeTagsReturns the resource tags associated with Health events for your account. Use this operation to retrieve the actual tag key-value pairs attached to affected… - POSTDescribe tags for organization
/#X-Amz-Target=AWSHealth_20160804.DescribeTagsForOrganizationReturns the tags associated with Health events across all accounts in your organization. - POSTDescribe tags onboarding status
/#X-Amz-Target=AWSHealth_20160804.DescribeTagsOnboardingStatusReturns the current onboarding status of the Health tags feature for your account. - POSTDescribe tags onboarding status for organization
/#X-Amz-Target=AWSHealth_20160804.DescribeTagsOnboardingStatusForOrganizationReturns the current onboarding status of the Health tags feature for your organization. - POSTDisable health service access for organization
/#X-Amz-Target=AWSHealth_20160804.DisableHealthServiceAccessForOrganizationDisables Health from working with Organizations. To call this operation, you must sign in to the organization's management account. For more information, see… - POSTDisable tags
/#X-Amz-Target=AWSHealth_20160804.DisableTagsDisables the Health tags feature for your account. After disabling, Health events will no longer include resource tag information. Previously configured tag… - POSTDisable tags for organization
/#X-Amz-Target=AWSHealth_20160804.DisableTagsForOrganizationDisables the Health tags feature for all accounts in your organization. - POSTEnable health service access for organization
/#X-Amz-Target=AWSHealth_20160804.EnableHealthServiceAccessForOrganizationEnables Health to work with Organizations. You can use the organizational view feature to aggregate events from all Amazon Web Services accounts in your… - POSTEnable tags
/#X-Amz-Target=AWSHealth_20160804.EnableTagsEnables the Health tags feature for your account. Once enabled, Health events will include resource tag information for affected entities. If the feature is… - POSTEnable tags for organization
/#X-Amz-Target=AWSHealth_20160804.EnableTagsForOrganizationEnables the Health tags feature for all accounts in your organization. Once enabled, Health events will include resource tag information for affected entities…
API details
- Base URL
https://health.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 27 operations on 27 pathsPOST 27
- Description format
- AWS Smithy model, API version
2016-08-04 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Health APIs and Notifications in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Health APIs and Notifications collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Configure tags” (POST /#X-Amz-Target=AWSHealth_20160804.ConfigureTags), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Health APIs and Notifications?
Health The Health API provides access to the Health information that appears in the Health Dashboard . You can use the API operations to get information about… It is listed under Communication and has 27 endpoints.
Who publishes the AWS Health APIs and Notifications?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS Health APIs and Notifications?
Requests go to https://health.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Health APIs and Notifications?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Health APIs and Notifications have?
27 operations on 27 paths (27 POST).
Is forking the AWS Health APIs and Notifications free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.