Icon

AWS Health (version v1.*.*)

describe_affected_entities

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.

Parameters

$body

Type: object

{
"filter" : {
"statusCodes" : [ "string. Possible values: IMPAIRED | UNIMPAIRED | UNKNOWN" ],
"eventArns" : [ "string" ],
"lastUpdatedTimes" : [ {
"from" : "The starting date and time of a time range.",
"to" : "The ending date and time of a time range."
} ],
"entityArns" : [ "string" ],
"entityValues" : [ "string" ],
"tags" : [ {
"<string>" : "string"
} ]
},
"locale" : "The locale (language) to return information in. English (en) is the default and the only supported value at this time."
}

describe_entity_aggregates

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.

Parameters

$body

Type: object

{
"eventArns" : [ "string" ]
}

describe_event_aggregates

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.

Parameters

$body

Type: object

{
"filter" : {
"regions" : [ "string" ],
"eventStatusCodes" : [ "string. Possible values: open | closed | upcoming" ],
"eventTypeCategories" : [ "string. Possible values: issue | accountNotification | scheduledChange | investigation" ],
"eventArns" : [ "string" ],
"lastUpdatedTimes" : [ {
"from" : "The starting date and time of a time range.",
"to" : "The ending date and time of a time range."
} ],
"availabilityZones" : [ "string" ],
"services" : [ "string" ],
"entityArns" : [ "string" ],
"tags" : [ {
"<string>" : "string"
} ],
"endTimes" : [ {
"from" : "The starting date and time of a time range.",
"to" : "The ending date and time of a time range."
} ],
"eventTypeCodes" : [ "string" ],
"entityValues" : [ "string" ],
"startTimes" : [ {
"from" : "The starting date and time of a time range.",
"to" : "The ending date and time of a time range."
} ]
},
"aggregateField" : "The only currently supported value is eventTypeCategory."
}

describe_event_details

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.

Parameters

$body

Type: object

{
"eventArns" : [ "string" ],
"locale" : "The locale (language) to return information in. English (en) is the default and the only supported value at this time."
}

describe_event_types

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.

Parameters

$body

Type: object

{
"filter" : {
"eventTypeCodes" : [ "string" ],
"eventTypeCategories" : [ "string. Possible values: issue | accountNotification | scheduledChange | investigation" ],
"services" : [ "string" ]
},
"locale" : "The locale (language) to return information in. English (en) is the default and the only supported value at this time."
}

describe_events

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.

Parameters

$body

Type: object

{
"filter" : {
"regions" : [ "string" ],
"eventStatusCodes" : [ "string. Possible values: open | closed | upcoming" ],
"eventTypeCategories" : [ "string. Possible values: issue | accountNotification | scheduledChange | investigation" ],
"eventArns" : [ "string" ],
"lastUpdatedTimes" : [ {
"from" : "The starting date and time of a time range.",
"to" : "The ending date and time of a time range."
} ],
"availabilityZones" : [ "string" ],
"services" : [ "string" ],
"entityArns" : [ "string" ],
"tags" : [ {
"<string>" : "string"
} ],
"endTimes" : [ {
"from" : "The starting date and time of a time range.",
"to" : "The ending date and time of a time range."
} ],
"eventTypeCodes" : [ "string" ],
"entityValues" : [ "string" ],
"startTimes" : [ {
"from" : "The starting date and time of a time range.",
"to" : "The ending date and time of a time range."
} ]
},
"locale" : "The locale (language) to return information in. English (en) is the default and the only supported value at this time."
}