Class: AWS.Health
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.Health
- Identifier:
- health
- API Version:
- 2016-08-04
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
The AWS Health API provides programmatic access to the AWS Health information that appears in the AWS Personal Health Dashboard. You can use the API operations to get information about AWS Health events that affect your AWS services and resources.
SubscriptionRequiredException
error. AWS Health has a single endpoint: health.us-east-1.amazonaws.com (HTTPS). Use this endpoint to call the AWS Health API operations.
For authentication of requests, AWS Health uses the Signature Version 4 Signing Process.
If your AWS account is part of AWS Organizations, you can use the AWS Health organizational view feature. This feature provides a centralized view of AWS Health events across all accounts in your organization. You can aggregate AWS 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 AWS Health events in the AWS Health User Guide.
- Use the eventScopeCode parameter to specify whether to return AWS 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 thenextToken
in the next request to return more results.
Sending a Request Using Health
var health = new AWS.Health();
health.describeAffectedAccountsForOrganization(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the Health object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var health = new AWS.Health({apiVersion: '2016-08-04'});
You can also set the API version globally in AWS.config.apiVersions
using
the health service identifier:
AWS.config.apiVersions = {
health: '2016-08-04',
// other service API versions
};
var health = new AWS.Health();
Constructor Summary collapse
-
new AWS.Health(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
describeAffectedAccountsForOrganization(params = {}, callback) ⇒ AWS.Request
Returns a list of accounts in the organization from AWS Organizations that are affected by the provided event.
-
describeAffectedEntities(params = {}, callback) ⇒ AWS.Request
Returns a list of entities that have been affected by the specified events, based on the specified filter criteria.
-
describeAffectedEntitiesForOrganization(params = {}, callback) ⇒ AWS.Request
Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in AWS Organizations, based on the filter criteria.
-
describeEntityAggregates(params = {}, callback) ⇒ AWS.Request
Returns the number of entities that are affected by each of the specified events.
-
describeEventAggregates(params = {}, callback) ⇒ AWS.Request
Returns the number of events of each event type (issue, scheduled change, and account notification).
-
describeEventDetails(params = {}, callback) ⇒ AWS.Request
Returns detailed information about one or more specified events.
-
describeEventDetailsForOrganization(params = {}, callback) ⇒ AWS.Request
Returns detailed information about one or more specified events for one or more accounts in your organization.
-
describeEvents(params = {}, callback) ⇒ AWS.Request
Returns information about events that meet the specified filter criteria.
-
describeEventsForOrganization(params = {}, callback) ⇒ AWS.Request
Returns information about events across your organization in AWS Organizations.
-
describeEventTypes(params = {}, callback) ⇒ AWS.Request
Returns the event types that meet the specified filter criteria.
-
describeHealthServiceStatusForOrganization(params = {}, callback) ⇒ AWS.Request
This operation provides status information on enabling or disabling AWS Health to work with your organization.
-
disableHealthServiceAccessForOrganization(params = {}, callback) ⇒ AWS.Request
Disables AWS Health from working with AWS Organizations.
-
enableHealthServiceAccessForOrganization(params = {}, callback) ⇒ AWS.Request
Calling this operation enables AWS Health to work with AWS Organizations.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.Health(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Property Details
Method Details
describeAffectedAccountsForOrganization(params = {}, callback) ⇒ AWS.Request
Returns a list of accounts in the organization from AWS Organizations that are affected by the provided event. For more information about the different types of AWS Health events, see Event.
Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account.
nextToken
parameter in the next request to return more results. describeAffectedEntities(params = {}, callback) ⇒ AWS.Request
Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this.
At least one event ARN is required. Results are sorted by the lastUpdatedTime
of the entity, starting with the most recent.
nextToken
parameter in the next request to return more results. describeAffectedEntitiesForOrganization(params = {}, callback) ⇒ AWS.Request
Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in AWS Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service.
At least one event Amazon Resource Name (ARN) and account ID are required. Results are sorted by the lastUpdatedTime
of the entity, starting with the most recent.
Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account.
nextToken
parameter in the next request to return more results. describeEntityAggregates(params = {}, callback) ⇒ AWS.Request
Returns the number of entities that are affected by each of the specified events. If no events are specified, the counts of all affected entities are returned.
describeEventAggregates(params = {}, callback) ⇒ AWS.Request
Returns 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 each category are returned.
nextToken
parameter in the next request to return more results. describeEventDetails(params = {}, callback) ⇒ AWS.Request
Returns detailed information about one or more specified events. Information includes standard event data (Region, service, and so on, as returned by DescribeEvents), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included. To retrieve those, use the DescribeAffectedEntities operation.
If a specified event cannot be retrieved, an error message is returned for that event.
describeEventDetailsForOrganization(params = {}, callback) ⇒ AWS.Request
Returns detailed information about one or more specified events for one or more accounts in your organization. Information includes standard event data (Region, service, and so on, as returned by DescribeEventsForOrganization), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included; to retrieve those, use the DescribeAffectedEntitiesForOrganization operation.
Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account.
When you call the DescribeEventDetailsForOrganization
operation, you specify the organizationEventDetailFilters
object in the request. Depending on the AWS Health event type, note the following differences:
-
If the event is public, the
awsAccountId
parameter must be empty. If you specify an account ID for a public event, then an error message is returned. That's because the event might apply to all AWS accounts and isn't specific to an account in your organization. -
If the event is specific to an account, then you must specify the
awsAccountId
parameter in the request. If you don't specify an account ID, an error message returns because the event is specific to an AWS account in your organization.
For more information, see Event.
describeEvents(params = {}, callback) ⇒ AWS.Request
Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations.
If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime
, starting with the most recent event.
- When you call the
DescribeEvents
operation and specify an entity for theentityValues
parameter, AWS Health might return public events that aren't specific to that resource. For example, if you callDescribeEvents
and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, AWS Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use theservices
parameter in thefilter
object. For more information, see Event. - This API operation uses pagination. Specify the
nextToken
parameter in the next request to return more results.
describeEventsForOrganization(params = {}, callback) ⇒ AWS.Request
Returns information about events across your organization in AWS Organizations. You can use thefilters
parameter to specify the events that you want to return. Events are returned in a summary form and don't include the affected accounts, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the following operations:
If you don't specify a filter
, the DescribeEventsForOrganizations
returns all events across your organization. Results are sorted by lastModifiedTime
, starting with the most recent event.
For more information about the different types of AWS Health events, see Event.
Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master AWS account.
nextToken
parameter in the next request to return more results. describeEventTypes(params = {}, callback) ⇒ AWS.Request
Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular order.
nextToken
parameter in the next request to return more results. describeHealthServiceStatusForOrganization(params = {}, callback) ⇒ AWS.Request
This operation provides status information on enabling or disabling AWS Health to work with your organization. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master account.
disableHealthServiceAccessForOrganization(params = {}, callback) ⇒ AWS.Request
Disables AWS Health from working with AWS Organizations. To call this operation, you must sign in as an AWS Identity and Access Management (IAM) user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master AWS account. For more information, see Aggregating AWS Health events in the AWS Health User Guide.
This operation doesn't remove the service-linked role (SLR) from the AWS master account in your organization. You must use the IAM console, API, or AWS Command Line Interface (AWS CLI) to remove the SLR. For more information, see Deleting a Service-Linked Role in the IAM User Guide.
enableHealthServiceAccessForOrganization(params = {}, callback) ⇒ AWS.Request
Calling this operation enables AWS Health to work with AWS Organizations. This applies a service-linked role (SLR) to the master account in the organization. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master account.
For more information, see Aggregating AWS Health events in the AWS Health User Guide.