Class: AWS.Health

Inherits:

AWS.Service

Object
AWS.Service
AWS.Health

show all

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 is presented in the AWS Personal Health Dashboard. You can get information about events that affect your AWS resources:

DescribeEvents: Summary information about events.
DescribeEventDetails: Detailed information about one or more events.
DescribeAffectedEntities: Information about AWS resources that are affected by one or more events.

In addition, these operations provide information about event types and summary counts of events or affected entities:

DescribeEventTypes: Information about the kinds of events that AWS Health tracks.
DescribeEventAggregates: A count of the number of events that meet specified criteria.
DescribeEntityAggregates: A count of the number of affected entities that meet specified criteria.

The Health API requires a Business or Enterprise support plan from AWS Support. Calling the Health API from an account that does not have a Business or Enterprise support plan causes a SubscriptionRequiredException.

For authentication of requests, AWS Health uses the Signature Version 4 Signing Process.

See the AWS Health User Guide for information about how to use the API.

Service Endpoint

The HTTP endpoint for the AWS Health API is:

https://health.us-east-1.amazonaws.com

Sending a Request Using Health

var health = new AWS.Health();
health.describeAffectedEntities(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();

Version:

2016-08-04

Constructor Summary

new AWS.Health(options = {}) ⇒ Object constructor
Constructs a service object.

Property Summary

endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary

describeAffectedEntities(params = {}, callback) ⇒ AWS.Request
Returns a list of entities that have been affected by the specified events, based on the specified 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.
describeEvents(params = {}, callback) ⇒ AWS.Request
Returns information about events that meet the specified filter criteria.
describeEventTypes(params = {}, callback) ⇒ AWS.Request
Returns the event types that meet the specified filter criteria.

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.

Examples:

Constructing a Health object

var health = new AWS.Health({apiVersion: '2016-08-04'});

Options Hash (options):

params (map) —
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
endpoint (String) —
The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.
accessKeyId (String) —
your AWS access key ID.
secretAccessKey (String) —
your AWS secret access key.
sessionToken (AWS.Credentials) —
the optional AWS session token to sign requests with.
credentials (AWS.Credentials) —
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
credentialProvider (AWS.CredentialProviderChain) —
the provider chain used to resolve credentials if no static credentials property is set.
region (String) —
the region to send service requests to. See AWS.Health.region for more information.
maxRetries (Integer) —
the maximum amount of retries to attempt with a request. See AWS.Health.maxRetries for more information.
maxRedirects (Integer) —
the maximum amount of redirects to follow with a request. See AWS.Health.maxRedirects for more information.
sslEnabled (Boolean) —
whether to enable SSL for requests.
paramValidation (Boolean|map) —
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
- max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
computeChecksums (Boolean) —
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
convertResponseTypes (Boolean) —
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.
correctClockSkew (Boolean) —
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.
s3ForcePathStyle (Boolean) —
whether to force path style URLs for S3 objects.
s3BucketEndpoint (Boolean) —
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.
s3DisableBodySigning (Boolean) —
whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.
retryDelayOptions (map) —
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
httpOptions (map) —
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
- connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
- timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
apiVersion (String, Date) —
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.
apiVersions (map<String, String|Date>) —
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
logger (#write, #log) —
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
systemClockOffset (Number) —
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.
signatureVersion (String) —
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
signatureCache (Boolean) —
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.
dynamoDbCrc32 (Boolean) —
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.
useAccelerateEndpoint (Boolean) —
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.
clientSideMonitoring (Boolean) —
whether to collect and publish this client's performance metrics of all its API requests.
endpointDiscoveryEnabled (Boolean) —
whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'
endpointCacheSize (Number) —
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
hostPrefixEnabled (Boolean) —
whether to marshal request parameters to the prefix of hostname. Defaults to true.

Property Details

endpoint ⇒ `AWS.Endpoint` (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

(AWS.Endpoint) —
an Endpoint object representing the endpoint URL for service requests.

Method Details

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.

Service Reference:

DescribeAffectedEntities

Examples:

Calling the describeAffectedEntities operation

var params = {
  filter: { /* required */
    eventArns: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    entityArns: [
      'STRING_VALUE',
      /* more items */
    ],
    entityValues: [
      'STRING_VALUE',
      /* more items */
    ],
    lastUpdatedTimes: [
      {
        from: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        to: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    statusCodes: [
      IMPAIRED | UNIMPAIRED | UNKNOWN,
      /* more items */
    ],
    tags: [
      {
        '<tagKey>': 'STRING_VALUE',
        /* '<tagKey>': ... */
      },
      /* more items */
    ]
  },
  locale: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
health.describeAffectedEntities(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- filter — (map)
  Values to narrow the results returned. At least one event ARN is required.
  - eventArns — required — (Array<String>)
    A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
  - entityArns — (Array<String>)
    A list of entity ARNs (unique identifiers).
  - entityValues — (Array<String>)
    A list of IDs for affected entities.
  - lastUpdatedTimes — (Array<map>)
    A list of the most recent dates and times that the entity was updated.
    - from — (Date)
      The starting date and time of a time range.
    - to — (Date)
      The ending date and time of a time range.
  - tags — (Array<map<String>>)
    A map of entity tags attached to the affected entity.
  - statusCodes — (Array<String>)
    A list of entity status codes (IMPAIRED, UNIMPAIRED, or UNKNOWN).
- locale — (String)
  The locale (language) to return information in. English (en) is the default and the only supported value at this time.
- nextToken — (String)
  If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
- maxResults — (Integer)
  The maximum number of items to return in one batch, between 10 and 100, inclusive.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - entities — (Array<map>)
    The entities that match the filter criteria.
    
    entityArn — (String)
    The unique identifier for the entity. Format: arn:aws:health:entity-region:aws-account:entity/entity-id . Example: arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K
    
    eventArn — (String)
    The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
    
    entityValue — (String)
    The ID of the affected entity.
    
    entityUrl — (String)
    
    awsAccountId — (String)
    The 12-digit AWS account number that contains the affected entity.
    
    lastUpdatedTime — (Date)
    The most recent time that the entity was updated.
    
    statusCode — (String)
    The most recent status of the entity affected by the event. The possible values are IMPAIRED, UNIMPAIRED, and UNKNOWN.
    Possible values include:
    
    "IMPAIRED"
    
    "UNIMPAIRED"
    
    "UNKNOWN"
    
    tags — (map<String>)
    A map of entity tags attached to the affected entity.
  - nextToken — (String)
    If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

DescribeEntityAggregates

Examples:

Calling the describeEntityAggregates operation

var params = {
  eventArns: [
    'STRING_VALUE',
    /* more items */
  ]
};
health.describeEntityAggregates(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- eventArns — (Array<String>)
  A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - entityAggregates — (Array<map>)
    The number of entities that are affected by each of the specified events.
    
    eventArn — (String)
    The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
    
    count — (Integer)
    The number entities that match the criteria for the specified events.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

DescribeEventAggregates

Examples:

Calling the describeEventAggregates operation

var params = {
  aggregateField: eventTypeCategory, /* required */
  filter: {
    availabilityZones: [
      'STRING_VALUE',
      /* more items */
    ],
    endTimes: [
      {
        from: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        to: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    entityArns: [
      'STRING_VALUE',
      /* more items */
    ],
    entityValues: [
      'STRING_VALUE',
      /* more items */
    ],
    eventArns: [
      'STRING_VALUE',
      /* more items */
    ],
    eventStatusCodes: [
      open | closed | upcoming,
      /* more items */
    ],
    eventTypeCategories: [
      issue | accountNotification | scheduledChange,
      /* more items */
    ],
    eventTypeCodes: [
      'STRING_VALUE',
      /* more items */
    ],
    lastUpdatedTimes: [
      {
        from: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        to: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    regions: [
      'STRING_VALUE',
      /* more items */
    ],
    services: [
      'STRING_VALUE',
      /* more items */
    ],
    startTimes: [
      {
        from: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        to: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    tags: [
      {
        '<tagKey>': 'STRING_VALUE',
        /* '<tagKey>': ... */
      },
      /* more items */
    ]
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
health.describeEventAggregates(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- filter — (map)
  Values to narrow the results returned.
  - eventArns — (Array<String>)
    A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
  - eventTypeCodes — (Array<String>)
    A list of unique identifiers for event types. For example, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED"
  - services — (Array<String>)
    The AWS services associated with the event. For example, EC2, RDS.
  - regions — (Array<String>)
    A list of AWS regions.
  - availabilityZones — (Array<String>)
    A list of AWS availability zones.
  - startTimes — (Array<map>)
    A list of dates and times that the event began.
    - from — (Date)
      The starting date and time of a time range.
    - to — (Date)
      The ending date and time of a time range.
  - endTimes — (Array<map>)
    A list of dates and times that the event ended.
    - from — (Date)
      The starting date and time of a time range.
    - to — (Date)
      The ending date and time of a time range.
  - lastUpdatedTimes — (Array<map>)
    A list of dates and times that the event was last updated.
    - from — (Date)
      The starting date and time of a time range.
    - to — (Date)
      The ending date and time of a time range.
  - entityArns — (Array<String>)
    A list of entity ARNs (unique identifiers).
  - entityValues — (Array<String>)
    A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).
  - eventTypeCategories — (Array<String>)
    A list of event type category codes (issue, scheduledChange, or accountNotification).
  - tags — (Array<map<String>>)
    A map of entity tags attached to the affected entity.
  - eventStatusCodes — (Array<String>)
    A list of event status codes.
- aggregateField — (String)
  The only currently supported value is eventTypeCategory.
  Possible values include:
  - "eventTypeCategory"
- maxResults — (Integer)
  The maximum number of items to return in one batch, between 10 and 100, inclusive.
- nextToken — (String)
  If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - eventAggregates — (Array<map>)
    The number of events in each category that meet the optional filter criteria.
    
    aggregateValue — (String)
    The issue type for the associated count.
    
    count — (Integer)
    The number of events of the associated issue type.
  - nextToken — (String)
    If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeEventDetails(params = {}, callback) ⇒ `AWS.Request`

Returns detailed information about one or more specified events. Information includes standard event data (region, service, etc., 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.

Service Reference:

DescribeEventDetails

Examples:

Calling the describeEventDetails operation

var params = {
  eventArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  locale: 'STRING_VALUE'
};
health.describeEventDetails(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- eventArns — (Array<String>)
  A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
- locale — (String)
  The locale (language) to return information in. English (en) is the default and the only supported value at this time.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - successfulSet — (Array<map>)
    Information about the events that could be retrieved.
    
    event — (map)
    Summary information about the event.
    
    arn — (String)
    The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
    
    service — (String)
    The AWS service that is affected by the event. For example, EC2, RDS.
    
    eventTypeCode — (String)
    The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
    
    eventTypeCategory — (String)
    The category of the event. Possible values are issue, scheduledChange, and accountNotification.
    Possible values include:
    
    "issue"
    
    "accountNotification"
    
    "scheduledChange"
    
    region — (String)
    The AWS region name of the event.
    
    availabilityZone — (String)
    The AWS Availability Zone of the event. For example, us-east-1a.
    
    startTime — (Date)
    The date and time that the event began.
    
    endTime — (Date)
    The date and time that the event ended.
    
    lastUpdatedTime — (Date)
    The most recent date and time that the event was updated.
    
    statusCode — (String)
    The most recent status of the event. Possible values are open, closed, and upcoming.
    Possible values include:
    
    "open"
    
    "closed"
    
    "upcoming"
    
    eventDescription — (map)
    The most recent description of the event.
    
    latestDescription — (String)
    The most recent description of the event.
    
    eventMetadata — (map<String>)
    Additional metadata about the event.
  - failedSet — (Array<map>)
    Error messages for any events that could not be retrieved.
    
    eventArn — (String)
    The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
    
    errorName — (String)
    The name of the error.
    
    errorMessage — (String)
    A message that describes the error.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

DescribeEvents

Examples:

Calling the describeEvents operation

var params = {
  filter: {
    availabilityZones: [
      'STRING_VALUE',
      /* more items */
    ],
    endTimes: [
      {
        from: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        to: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    entityArns: [
      'STRING_VALUE',
      /* more items */
    ],
    entityValues: [
      'STRING_VALUE',
      /* more items */
    ],
    eventArns: [
      'STRING_VALUE',
      /* more items */
    ],
    eventStatusCodes: [
      open | closed | upcoming,
      /* more items */
    ],
    eventTypeCategories: [
      issue | accountNotification | scheduledChange,
      /* more items */
    ],
    eventTypeCodes: [
      'STRING_VALUE',
      /* more items */
    ],
    lastUpdatedTimes: [
      {
        from: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        to: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    regions: [
      'STRING_VALUE',
      /* more items */
    ],
    services: [
      'STRING_VALUE',
      /* more items */
    ],
    startTimes: [
      {
        from: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        to: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    tags: [
      {
        '<tagKey>': 'STRING_VALUE',
        /* '<tagKey>': ... */
      },
      /* more items */
    ]
  },
  locale: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
health.describeEvents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- filter — (map)
  Values to narrow the results returned.
  - eventArns — (Array<String>)
    A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
  - eventTypeCodes — (Array<String>)
    A list of unique identifiers for event types. For example, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED"
  - services — (Array<String>)
    The AWS services associated with the event. For example, EC2, RDS.
  - regions — (Array<String>)
    A list of AWS regions.
  - availabilityZones — (Array<String>)
    A list of AWS availability zones.
  - startTimes — (Array<map>)
    A list of dates and times that the event began.
    - from — (Date)
      The starting date and time of a time range.
    - to — (Date)
      The ending date and time of a time range.
  - endTimes — (Array<map>)
    A list of dates and times that the event ended.
    - from — (Date)
      The starting date and time of a time range.
    - to — (Date)
      The ending date and time of a time range.
  - lastUpdatedTimes — (Array<map>)
    A list of dates and times that the event was last updated.
    - from — (Date)
      The starting date and time of a time range.
    - to — (Date)
      The ending date and time of a time range.
  - entityArns — (Array<String>)
    A list of entity ARNs (unique identifiers).
  - entityValues — (Array<String>)
    A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).
  - eventTypeCategories — (Array<String>)
    A list of event type category codes (issue, scheduledChange, or accountNotification).
  - tags — (Array<map<String>>)
    A map of entity tags attached to the affected entity.
  - eventStatusCodes — (Array<String>)
    A list of event status codes.
- nextToken — (String)
  If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
- maxResults — (Integer)
  The maximum number of items to return in one batch, between 10 and 100, inclusive.
- locale — (String)
  The locale (language) to return information in. English (en) is the default and the only supported value at this time.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - events — (Array<map>)
    The events that match the specified filter criteria.
    
    arn — (String)
    The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
    
    service — (String)
    The AWS service that is affected by the event. For example, EC2, RDS.
    
    eventTypeCode — (String)
    The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
    
    eventTypeCategory — (String)
    The category of the event. Possible values are issue, scheduledChange, and accountNotification.
    Possible values include:
    
    "issue"
    
    "accountNotification"
    
    "scheduledChange"
    
    region — (String)
    The AWS region name of the event.
    
    availabilityZone — (String)
    The AWS Availability Zone of the event. For example, us-east-1a.
    
    startTime — (Date)
    The date and time that the event began.
    
    endTime — (Date)
    The date and time that the event ended.
    
    lastUpdatedTime — (Date)
    The most recent date and time that the event was updated.
    
    statusCode — (String)
    The most recent status of the event. Possible values are open, closed, and upcoming.
    Possible values include:
    
    "open"
    
    "closed"
    
    "upcoming"
  - nextToken — (String)
    If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

DescribeEventTypes

Examples:

Calling the describeEventTypes operation

var params = {
  filter: {
    eventTypeCategories: [
      issue | accountNotification | scheduledChange,
      /* more items */
    ],
    eventTypeCodes: [
      'STRING_VALUE',
      /* more items */
    ],
    services: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  locale: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
health.describeEventTypes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- filter — (map)
  Values to narrow the results returned.
  - eventTypeCodes — (Array<String>)
    A list of event type codes.
  - services — (Array<String>)
    The AWS services associated with the event. For example, EC2, RDS.
  - eventTypeCategories — (Array<String>)
    A list of event type category codes (issue, scheduledChange, or accountNotification).
- locale — (String)
  The locale (language) to return information in. English (en) is the default and the only supported value at this time.
- nextToken — (String)
  If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
- maxResults — (Integer)
  The maximum number of items to return in one batch, between 10 and 100, inclusive.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - eventTypes — (Array<map>)
    A list of event types that match the filter criteria. Event types have a category (issue, accountNotification, or scheduledChange), a service (for example, EC2, RDS, DATAPIPELINE, BILLING), and a code (in the format AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT).
    
    service — (String)
    The AWS service that is affected by the event. For example, EC2, RDS.
    
    code — (String)
    The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
    
    category — (String)
    A list of event type category codes (issue, scheduledChange, or accountNotification).
    Possible values include:
    
    "issue"
    
    "accountNotification"
    
    "scheduledChange"
  - nextToken — (String)
    If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

Class: AWS.Health

Overview

Service Description

Sending a Request Using Health

Locking the API Version

Constructor Summary

Property Summary

Properties inherited from AWS.Service

Method Summary

Methods inherited from AWS.Service

Constructor Details

new AWS.Health(options = {}) ⇒ Object

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Method Details

describeAffectedEntities(params = {}, callback) ⇒ AWS.Request

describeEntityAggregates(params = {}, callback) ⇒ AWS.Request

describeEventAggregates(params = {}, callback) ⇒ AWS.Request

describeEventDetails(params = {}, callback) ⇒ AWS.Request

describeEvents(params = {}, callback) ⇒ AWS.Request

describeEventTypes(params = {}, callback) ⇒ AWS.Request

new AWS.Health(options = {}) ⇒ `Object`

endpoint ⇒ `AWS.Endpoint` (readwrite)

describeAffectedEntities(params = {}, callback) ⇒ `AWS.Request`

describeEntityAggregates(params = {}, callback) ⇒ `AWS.Request`

describeEventAggregates(params = {}, callback) ⇒ `AWS.Request`

describeEventDetails(params = {}, callback) ⇒ `AWS.Request`

describeEvents(params = {}, callback) ⇒ `AWS.Request`

describeEventTypes(params = {}, callback) ⇒ `AWS.Request`