@datafire/amazonaws_health

Client library for AWS Health APIs and Notifications

Installation and Usage

npm install --save @datafire/amazonaws_health

let amazonaws_health = require('@datafire/amazonaws_health').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_health.DescribeAffectedEntities({
  "filter": {
    "eventArns": []
  }
}).then(data => {
  console.log(data);
});

Description

AWS Health

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

Actions

DescribeAffectedEntities

amazonaws_health.DescribeAffectedEntities({
  "filter": {
    "eventArns": []
  }
}, context)

Input

input object
- maxResults string
- nextToken string
- filter required EntityFilter
- locale locale
- maxResults maxResults
- nextToken nextToken

Output

output DescribeAffectedEntitiesResponse

DescribeEntityAggregates

amazonaws_health.DescribeEntityAggregates({}, context)

Input

input object
- eventArns EventArnsList

Output

output DescribeEntityAggregatesResponse

DescribeEventAggregates

amazonaws_health.DescribeEventAggregates({
  "aggregateField": ""
}, context)

Input

input object
- maxResults string
- nextToken string
- aggregateField required eventAggregateField
- filter EventFilter
- maxResults maxResults
- nextToken nextToken

Output

output DescribeEventAggregatesResponse

DescribeEventDetails

amazonaws_health.DescribeEventDetails({
  "eventArns": []
}, context)

Input

input object
- eventArns required eventArnList
- locale locale

Output

output DescribeEventDetailsResponse

DescribeEventTypes

amazonaws_health.DescribeEventTypes({}, context)

Input

input object
- maxResults string
- nextToken string
- filter EventTypeFilter
- locale locale
- maxResults maxResults
- nextToken nextToken

Output

output DescribeEventTypesResponse

DescribeEvents

amazonaws_health.DescribeEvents({}, context)

Input

input object
- maxResults string
- nextToken string
- filter EventFilter
- locale locale
- maxResults maxResults
- nextToken nextToken

Output

output DescribeEventsResponse

Definitions

AffectedEntity

AffectedEntity object: Information about an entity that is affected by a Health event.
- awsAccountId accountId
- entityArn entityArn
- entityValue entityValue
- eventArn eventArn
- lastUpdatedTime timestamp
- statusCode entityStatusCode
- tags tagSet

DateTimeRange

DateTimeRange object: A range of dates and times that is used by the EventFilter and EntityFilter objects. If from is set and to is set: match items where the timestamp (startTime, endTime, or lastUpdatedTime) is between from and to inclusive. If from is set and to is not set: match items where the timestamp value is equal to or after from. If from is not set and to is set: match items where the timestamp value is equal to or before to.
- from timestamp
- to timestamp

DescribeAffectedEntitiesRequest

DescribeAffectedEntitiesRequest object
- filter required EntityFilter
- locale locale
- maxResults maxResults
- nextToken nextToken

DescribeAffectedEntitiesResponse

DescribeAffectedEntitiesResponse object
- entities EntityList
- nextToken nextToken

DescribeEntityAggregatesRequest

DescribeEntityAggregatesRequest object
- eventArns EventArnsList

DescribeEntityAggregatesResponse

DescribeEntityAggregatesResponse object
- entityAggregates EntityAggregateList

DescribeEventAggregatesRequest

DescribeEventAggregatesRequest object
- aggregateField required eventAggregateField
- filter EventFilter
- maxResults maxResults
- nextToken nextToken

DescribeEventAggregatesResponse

DescribeEventAggregatesResponse object
- eventAggregates EventAggregateList
- nextToken nextToken

DescribeEventDetailsFailedSet

DescribeEventDetailsFailedSet array
- items EventDetailsErrorItem

DescribeEventDetailsRequest

DescribeEventDetailsRequest object
- eventArns required eventArnList
- locale locale

DescribeEventDetailsResponse

DescribeEventDetailsResponse object
- failedSet DescribeEventDetailsFailedSet
- successfulSet DescribeEventDetailsSuccessfulSet

DescribeEventDetailsSuccessfulSet

DescribeEventDetailsSuccessfulSet array
- items EventDetails

DescribeEventTypesRequest

DescribeEventTypesRequest object
- filter EventTypeFilter
- locale locale
- maxResults maxResults
- nextToken nextToken

DescribeEventTypesResponse

DescribeEventTypesResponse object
- eventTypes EventTypeList
- nextToken nextToken

DescribeEventsRequest

DescribeEventsRequest object
- filter EventFilter
- locale locale
- maxResults maxResults
- nextToken nextToken

DescribeEventsResponse

DescribeEventsResponse object
- events EventList
- nextToken nextToken

EntityAggregate

EntityAggregate object: The number of entities that are affected by one or more events. Returned by the DescribeEntityAggregates operation.
- count count
- eventArn eventArn

EntityAggregateList

EntityAggregateList array
- items EntityAggregate

EntityFilter

EntityFilter object: The values to use to filter results from the DescribeAffectedEntities operation.
- entityArns entityArnList
- entityValues entityValueList
- eventArns required eventArnList
- lastUpdatedTimes dateTimeRangeList
- statusCodes entityStatusCodeList
- tags tagFilter

EntityList

EntityList array
- items AffectedEntity

Event

Event object: Summary information about an event, returned by the DescribeEvents operation. The DescribeEventDetails operation also returns this information, as well as the EventDescription and additional event metadata.
- arn eventArn
- availabilityZone availabilityZone
- endTime timestamp
- eventTypeCategory eventTypeCategory
- eventTypeCode eventTypeCode
- lastUpdatedTime timestamp
- region region
- service service
- startTime timestamp
- statusCode eventStatusCode

EventAggregate

EventAggregate object: The number of events of each issue type. Returned by the DescribeEventAggregates operation.
- aggregateValue aggregateValue
- count count

EventAggregateList

EventAggregateList array
- items EventAggregate

EventArnsList

EventArnsList array
- items eventArn

EventDescription

EventDescription object: The detailed description of the event. Included in the information returned by the DescribeEventDetails operation.
- latestDescription eventDescription

EventDetails

EventDetails object: Detailed information about an event. A combination of an Event object, an EventDescription object, and additional metadata about the event. Returned by the DescribeEventDetails operation.
- event Event
- eventDescription EventDescription
- eventMetadata eventMetadata

EventDetailsErrorItem

EventDetailsErrorItem object: Error information returned when a DescribeEventDetails operation cannot find a specified event.
- errorMessage string
- errorName string
- eventArn eventArn

EventFilter

EventFilter object: The values to use to filter results from the DescribeEvents and DescribeEventAggregates operations.
- availabilityZones availabilityZones
- endTimes dateTimeRangeList
- entityArns entityArnList
- entityValues entityValueList
- eventArns eventArnList
- eventStatusCodes eventStatusCodeList
- eventTypeCategories eventTypeCategoryList
- eventTypeCodes eventTypeList
- lastUpdatedTimes dateTimeRangeList
- regions regionList
- services serviceList
- startTimes dateTimeRangeList
- tags tagFilter

EventList

EventList array
- items Event

EventType

EventType object: Metadata about a type of event that is reported by AWS Health. Data consists of the category (for example, issue), the service (for example, EC2), and the event type code (for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT).
- category eventTypeCategory
- code eventTypeCode
- service service

EventTypeCategoryList

EventTypeCategoryList array
- items eventTypeCategory

EventTypeCodeList

EventTypeCodeList array
- items eventTypeCode

EventTypeFilter

EventTypeFilter object: The values to use to filter results from the DescribeEventTypes operation.
- eventTypeCategories EventTypeCategoryList
- eventTypeCodes EventTypeCodeList
- services serviceList

EventTypeList

EventTypeList array
- items EventType

InvalidPaginationToken

InvalidPaginationToken object: The specified pagination token (nextToken) is not valid.
- message string

UnsupportedLocale

UnsupportedLocale object: The specified locale is not supported.
- message string

accountId

accountId string

aggregateValue

aggregateValue string

availabilityZone

availabilityZone string

availabilityZones

availabilityZones array
- items availabilityZone

count

count integer

dateTimeRangeList

dateTimeRangeList array
- items DateTimeRange

entityArn

entityArn string

entityArnList

entityArnList array
- items entityArn

entityStatusCode

entityStatusCode string (values: IMPAIRED, UNIMPAIRED, UNKNOWN)

entityStatusCodeList

entityStatusCodeList array
- items entityStatusCode

entityValue

entityValue string

entityValueList

entityValueList array
- items entityValue

eventAggregateField

eventAggregateField string (values: eventTypeCategory)

eventArn

eventArn string

eventArnList

eventArnList array
- items eventArn

eventDescription

eventDescription string

eventMetadata

eventMetadata array
- items object
  - key metadataKey
  - value metadataValue

eventStatusCode

eventStatusCode string (values: open, closed, upcoming)

eventStatusCodeList

eventStatusCodeList array
- items eventStatusCode

eventType

eventType string

eventTypeCategory

eventTypeCategory string (values: issue, accountNotification, scheduledChange)

eventTypeCategoryList

eventTypeCategoryList array
- items eventTypeCategory

eventTypeCode

eventTypeCode string

eventTypeList

eventTypeList array
- items eventType

locale

locale string

maxResults

maxResults integer

metadataKey

metadataKey string

metadataValue

metadataValue string

nextToken

nextToken string

region

region string

regionList

regionList array
- items region

service

service string

serviceList

serviceList array
- items service

string

string string

tagFilter

tagFilter array
- items tagSet

tagKey

tagKey string

tagSet

tagSet array
- items object
  - key tagKey
  - value tagValue

tagValue

tagValue string

timestamp

timestamp string