models.health-2016-08-04-model.json Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-health Show documentation
Show all versions of aws-java-sdk-health Show documentation
The AWS Java SDK for AWS Health APIs and Notifications module holds the client classes that are used for communicating with AWS Health APIs and Notifications service.
{
"authorizers" : { },
"metadata" : {
"apiVersion" : "2016-08-04",
"endpointPrefix" : "health",
"jsonVersion" : "1.1",
"protocol" : "json",
"resultWrapped" : false,
"serviceAbbreviation" : "AWSHealth",
"serviceFullName" : "AWS Health APIs and Notifications",
"signatureVersion" : "v4",
"signingName" : "health",
"targetPrefix" : "AWSHealth_20160804",
"uid" : "health-2016-08-04",
"xmlNamespace" : null
},
"operations" : {
"DescribeAffectedEntities" : {
"authorizer" : null,
"authtype" : "IAM",
"deprecated" : false,
"documentation" : "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.
",
"errors" : [ {
"documentation" : null,
"error" : null,
"exception" : false,
"fault" : false,
"shape" : "InvalidPaginationToken"
}, {
"documentation" : null,
"error" : null,
"exception" : false,
"fault" : false,
"shape" : "UnsupportedLocale"
} ],
"http" : {
"method" : "POST",
"requestUri" : "/",
"responseCode" : null
},
"input" : {
"documentation" : null,
"locationName" : null,
"shape" : "DescribeAffectedEntitiesRequest",
"xmlNamespace" : null
},
"name" : "DescribeAffectedEntities",
"output" : {
"documentation" : null,
"locationName" : null,
"resultWrapper" : null,
"shape" : "DescribeAffectedEntitiesResponse"
}
},
"DescribeEntityAggregates" : {
"authorizer" : null,
"authtype" : "IAM",
"deprecated" : false,
"documentation" : "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.
",
"errors" : null,
"http" : {
"method" : "POST",
"requestUri" : "/",
"responseCode" : null
},
"input" : {
"documentation" : null,
"locationName" : null,
"shape" : "DescribeEntityAggregatesRequest",
"xmlNamespace" : null
},
"name" : "DescribeEntityAggregates",
"output" : {
"documentation" : null,
"locationName" : null,
"resultWrapper" : null,
"shape" : "DescribeEntityAggregatesResponse"
}
},
"DescribeEventAggregates" : {
"authorizer" : null,
"authtype" : "IAM",
"deprecated" : false,
"documentation" : "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.
",
"errors" : [ {
"documentation" : null,
"error" : null,
"exception" : false,
"fault" : false,
"shape" : "InvalidPaginationToken"
} ],
"http" : {
"method" : "POST",
"requestUri" : "/",
"responseCode" : null
},
"input" : {
"documentation" : null,
"locationName" : null,
"shape" : "DescribeEventAggregatesRequest",
"xmlNamespace" : null
},
"name" : "DescribeEventAggregates",
"output" : {
"documentation" : null,
"locationName" : null,
"resultWrapper" : null,
"shape" : "DescribeEventAggregatesResponse"
}
},
"DescribeEventDetails" : {
"authorizer" : null,
"authtype" : "IAM",
"deprecated" : false,
"documentation" : "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.
",
"errors" : [ {
"documentation" : null,
"error" : null,
"exception" : false,
"fault" : false,
"shape" : "UnsupportedLocale"
} ],
"http" : {
"method" : "POST",
"requestUri" : "/",
"responseCode" : null
},
"input" : {
"documentation" : null,
"locationName" : null,
"shape" : "DescribeEventDetailsRequest",
"xmlNamespace" : null
},
"name" : "DescribeEventDetails",
"output" : {
"documentation" : null,
"locationName" : null,
"resultWrapper" : null,
"shape" : "DescribeEventDetailsResponse"
}
},
"DescribeEventTypes" : {
"authorizer" : null,
"authtype" : "IAM",
"deprecated" : false,
"documentation" : "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.
",
"errors" : [ {
"documentation" : null,
"error" : null,
"exception" : false,
"fault" : false,
"shape" : "InvalidPaginationToken"
}, {
"documentation" : null,
"error" : null,
"exception" : false,
"fault" : false,
"shape" : "UnsupportedLocale"
} ],
"http" : {
"method" : "POST",
"requestUri" : "/",
"responseCode" : null
},
"input" : {
"documentation" : null,
"locationName" : null,
"shape" : "DescribeEventTypesRequest",
"xmlNamespace" : null
},
"name" : "DescribeEventTypes",
"output" : {
"documentation" : null,
"locationName" : null,
"resultWrapper" : null,
"shape" : "DescribeEventTypesResponse"
}
},
"DescribeEvents" : {
"authorizer" : null,
"authtype" : "IAM",
"deprecated" : false,
"documentation" : "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.
",
"errors" : [ {
"documentation" : null,
"error" : null,
"exception" : false,
"fault" : false,
"shape" : "InvalidPaginationToken"
}, {
"documentation" : null,
"error" : null,
"exception" : false,
"fault" : false,
"shape" : "UnsupportedLocale"
} ],
"http" : {
"method" : "POST",
"requestUri" : "/",
"responseCode" : null
},
"input" : {
"documentation" : null,
"locationName" : null,
"shape" : "DescribeEventsRequest",
"xmlNamespace" : null
},
"name" : "DescribeEvents",
"output" : {
"documentation" : null,
"locationName" : null,
"resultWrapper" : null,
"shape" : "DescribeEventsResponse"
}
}
},
"shapes" : {
"AffectedEntity" : {
"deprecated" : false,
"documentation" : "Information about an entity that is affected by a Health event.
",
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"awsAccountId" : {
"deprecated" : false,
"documentation" : "The 12-digit AWS account number that contains the affected entity.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "accountId",
"streaming" : false,
"xmlNamespace" : null
},
"entityArn" : {
"deprecated" : false,
"documentation" : "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
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "entityArn",
"streaming" : false,
"xmlNamespace" : null
},
"entityValue" : {
"deprecated" : false,
"documentation" : "The ID of the affected entity.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "entityValue",
"streaming" : false,
"xmlNamespace" : null
},
"eventArn" : {
"deprecated" : false,
"documentation" : "The unique identifier for the event. Format: arn:aws:health:event-region::event/EVENT_TYPE_PLUS_ID . Example: arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "eventArn",
"streaming" : false,
"xmlNamespace" : null
},
"lastUpdatedTime" : {
"deprecated" : false,
"documentation" : "The most recent time that the entity was updated.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "timestamp",
"streaming" : false,
"xmlNamespace" : null
},
"statusCode" : {
"deprecated" : false,
"documentation" : "The most recent status of the entity affected by the event. The possible values are IMPAIRED, UNIMPAIRED, and UNKNOWN.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "entityStatusCode",
"streaming" : false,
"xmlNamespace" : null
},
"tags" : {
"deprecated" : false,
"documentation" : "A map of entity tags attached to the affected entity.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "tagSet",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"DateTimeRange" : {
"deprecated" : false,
"documentation" : "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.
",
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"from" : {
"deprecated" : false,
"documentation" : "The starting date and time of a time range.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "timestamp",
"streaming" : false,
"xmlNamespace" : null
},
"to" : {
"deprecated" : false,
"documentation" : "The ending date and time of a time range.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "timestamp",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"DescribeAffectedEntitiesRequest" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"filter" : {
"deprecated" : false,
"documentation" : "Values to narrow the results returned. At least one event ARN is required.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "EntityFilter",
"streaming" : false,
"xmlNamespace" : null
},
"locale" : {
"deprecated" : false,
"documentation" : "The locale (language) to return information in. English (en) is the default and the only supported value at this time.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "locale",
"streaming" : false,
"xmlNamespace" : null
},
"maxResults" : {
"deprecated" : false,
"documentation" : "The maximum number of items to return in one batch, between 10 and 100, inclusive.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "maxResults",
"streaming" : false,
"xmlNamespace" : null
},
"nextToken" : {
"deprecated" : false,
"documentation" : "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.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "nextToken",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : [ "filter" ],
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"DescribeAffectedEntitiesResponse" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"entities" : {
"deprecated" : false,
"documentation" : "The entities that match the filter criteria.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "EntityList",
"streaming" : false,
"xmlNamespace" : null
},
"nextToken" : {
"deprecated" : false,
"documentation" : "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.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "nextToken",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"DescribeEntityAggregatesRequest" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"eventArns" : {
"deprecated" : false,
"documentation" : "A list of event ARNs (unique identifiers). For example: \"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331\", \"arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz\"
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "EventArnsList",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"DescribeEntityAggregatesResponse" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"entityAggregates" : {
"deprecated" : false,
"documentation" : "The number of entities that are affected by each of the specified events.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "EntityAggregateList",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"DescribeEventAggregatesRequest" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"aggregateField" : {
"deprecated" : false,
"documentation" : "The only currently supported value is eventTypeCategory.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "eventAggregateField",
"streaming" : false,
"xmlNamespace" : null
},
"filter" : {
"deprecated" : false,
"documentation" : "Values to narrow the results returned.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "EventFilter",
"streaming" : false,
"xmlNamespace" : null
},
"maxResults" : {
"deprecated" : false,
"documentation" : "The maximum number of items to return in one batch, between 10 and 100, inclusive.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "maxResults",
"streaming" : false,
"xmlNamespace" : null
},
"nextToken" : {
"deprecated" : false,
"documentation" : "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.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "nextToken",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : [ "aggregateField" ],
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"DescribeEventAggregatesResponse" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"eventAggregates" : {
"deprecated" : false,
"documentation" : "The number of events in each category that meet the optional filter criteria.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "EventAggregateList",
"streaming" : false,
"xmlNamespace" : null
},
"nextToken" : {
"deprecated" : false,
"documentation" : "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.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "nextToken",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"DescribeEventDetailsFailedSet" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "EventDetailsErrorItem",
"streaming" : false,
"xmlNamespace" : null
},
"members" : { },
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "list",
"value" : null,
"wrapper" : false
},
"DescribeEventDetailsRequest" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"eventArns" : {
"deprecated" : false,
"documentation" : "A list of event ARNs (unique identifiers). For example: \"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331\", \"arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz\"
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "eventArnList",
"streaming" : false,
"xmlNamespace" : null
},
"locale" : {
"deprecated" : false,
"documentation" : "The locale (language) to return information in. English (en) is the default and the only supported value at this time.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "locale",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : [ "eventArns" ],
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"DescribeEventDetailsResponse" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"failedSet" : {
"deprecated" : false,
"documentation" : "Error messages for any events that could not be retrieved.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "DescribeEventDetailsFailedSet",
"streaming" : false,
"xmlNamespace" : null
},
"successfulSet" : {
"deprecated" : false,
"documentation" : "Information about the events that could be retrieved.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "DescribeEventDetailsSuccessfulSet",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"DescribeEventDetailsSuccessfulSet" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "EventDetails",
"streaming" : false,
"xmlNamespace" : null
},
"members" : { },
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "list",
"value" : null,
"wrapper" : false
},
"DescribeEventTypesRequest" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"filter" : {
"deprecated" : false,
"documentation" : "Values to narrow the results returned.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "EventTypeFilter",
"streaming" : false,
"xmlNamespace" : null
},
"locale" : {
"deprecated" : false,
"documentation" : "The locale (language) to return information in. English (en) is the default and the only supported value at this time.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "locale",
"streaming" : false,
"xmlNamespace" : null
},
"maxResults" : {
"deprecated" : false,
"documentation" : "The maximum number of items to return in one batch, between 10 and 100, inclusive.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "maxResults",
"streaming" : false,
"xmlNamespace" : null
},
"nextToken" : {
"deprecated" : false,
"documentation" : "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.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "nextToken",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"DescribeEventTypesResponse" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"eventTypes" : {
"deprecated" : false,
"documentation" : "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).
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "EventTypeList",
"streaming" : false,
"xmlNamespace" : null
},
"nextToken" : {
"deprecated" : false,
"documentation" : "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.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "nextToken",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"DescribeEventsRequest" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"filter" : {
"deprecated" : false,
"documentation" : "Values to narrow the results returned.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "EventFilter",
"streaming" : false,
"xmlNamespace" : null
},
"locale" : {
"deprecated" : false,
"documentation" : "The locale (language) to return information in. English (en) is the default and the only supported value at this time.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "locale",
"streaming" : false,
"xmlNamespace" : null
},
"maxResults" : {
"deprecated" : false,
"documentation" : "The maximum number of items to return in one batch, between 10 and 100, inclusive.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "maxResults",
"streaming" : false,
"xmlNamespace" : null
},
"nextToken" : {
"deprecated" : false,
"documentation" : "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.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "nextToken",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"DescribeEventsResponse" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"events" : {
"deprecated" : false,
"documentation" : "The events that match the specified filter criteria.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "EventList",
"streaming" : false,
"xmlNamespace" : null
},
"nextToken" : {
"deprecated" : false,
"documentation" : "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.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "nextToken",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"EntityAggregate" : {
"deprecated" : false,
"documentation" : "The number of entities that are affected by one or more events. Returned by the DescribeEntityAggregates operation.
",
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"count" : {
"deprecated" : false,
"documentation" : "The number entities that match the criteria for the specified events.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "count",
"streaming" : false,
"xmlNamespace" : null
},
"eventArn" : {
"deprecated" : false,
"documentation" : "The unique identifier for the event. Format: arn:aws:health:event-region::event/EVENT_TYPE_PLUS_ID . Example: arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "eventArn",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"EntityAggregateList" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "EntityAggregate",
"streaming" : false,
"xmlNamespace" : null
},
"members" : { },
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "list",
"value" : null,
"wrapper" : false
},
"EntityFilter" : {
"deprecated" : false,
"documentation" : "The values to use to filter results from the DescribeAffectedEntities operation.
",
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"entityArns" : {
"deprecated" : false,
"documentation" : "A list of entity ARNs (unique identifiers).
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "entityArnList",
"streaming" : false,
"xmlNamespace" : null
},
"entityValues" : {
"deprecated" : false,
"documentation" : "A list of IDs for affected entities.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "entityValueList",
"streaming" : false,
"xmlNamespace" : null
},
"eventArns" : {
"deprecated" : false,
"documentation" : "A list of event ARNs (unique identifiers). For example: \"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331\", \"arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz\"
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "eventArnList",
"streaming" : false,
"xmlNamespace" : null
},
"lastUpdatedTimes" : {
"deprecated" : false,
"documentation" : "A list of the most recent dates and times that the entity was updated.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "dateTimeRangeList",
"streaming" : false,
"xmlNamespace" : null
},
"statusCodes" : {
"deprecated" : false,
"documentation" : "A list of entity status codes (IMPAIRED, UNIMPAIRED, or UNKNOWN).
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "entityStatusCodeList",
"streaming" : false,
"xmlNamespace" : null
},
"tags" : {
"deprecated" : false,
"documentation" : "A map of entity tags attached to the affected entity.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "tagFilter",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : [ "eventArns" ],
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"EntityList" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "AffectedEntity",
"streaming" : false,
"xmlNamespace" : null
},
"members" : { },
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "list",
"value" : null,
"wrapper" : false
},
"Event" : {
"deprecated" : false,
"documentation" : "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.
",
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"arn" : {
"deprecated" : false,
"documentation" : "The unique identifier for the event. Format: arn:aws:health:event-region::event/EVENT_TYPE_PLUS_ID . Example: arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "eventArn",
"streaming" : false,
"xmlNamespace" : null
},
"availabilityZone" : {
"deprecated" : false,
"documentation" : "The AWS Availability Zone of the event. For example, us-east-1a.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "availabilityZone",
"streaming" : false,
"xmlNamespace" : null
},
"endTime" : {
"deprecated" : false,
"documentation" : "The date and time that the event ended.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "timestamp",
"streaming" : false,
"xmlNamespace" : null
},
"eventTypeCategory" : {
"deprecated" : false,
"documentation" : "The
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "eventTypeCategory",
"streaming" : false,
"xmlNamespace" : null
},
"eventTypeCode" : {
"deprecated" : false,
"documentation" : "The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "eventTypeCode",
"streaming" : false,
"xmlNamespace" : null
},
"lastUpdatedTime" : {
"deprecated" : false,
"documentation" : "The most recent date and time that the event was updated.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "timestamp",
"streaming" : false,
"xmlNamespace" : null
},
"region" : {
"deprecated" : false,
"documentation" : "The AWS region name of the event.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "region",
"streaming" : false,
"xmlNamespace" : null
},
"service" : {
"deprecated" : false,
"documentation" : "The AWS service that is affected by the event. For example, EC2, RDS.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "service",
"streaming" : false,
"xmlNamespace" : null
},
"startTime" : {
"deprecated" : false,
"documentation" : "The date and time that the event began.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "timestamp",
"streaming" : false,
"xmlNamespace" : null
},
"statusCode" : {
"deprecated" : false,
"documentation" : "The most recent status of the event. Possible values are open, closed, and upcoming.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "eventStatusCode",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"EventAggregate" : {
"deprecated" : false,
"documentation" : "The number of events of each issue type. Returned by the DescribeEventAggregates operation.
",
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"aggregateValue" : {
"deprecated" : false,
"documentation" : "The issue type for the associated count.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "aggregateValue",
"streaming" : false,
"xmlNamespace" : null
},
"count" : {
"deprecated" : false,
"documentation" : "The number of events of the associated issue type.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "count",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"EventAggregateList" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "EventAggregate",
"streaming" : false,
"xmlNamespace" : null
},
"members" : { },
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "list",
"value" : null,
"wrapper" : false
},
"EventArnsList" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 50,
"member" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "eventArn",
"streaming" : false,
"xmlNamespace" : null
},
"members" : { },
"min" : 1,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "list",
"value" : null,
"wrapper" : false
},
"EventDescription" : {
"deprecated" : false,
"documentation" : "The detailed description of the event. Included in the information returned by the DescribeEventDetails operation.
",
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"latestDescription" : {
"deprecated" : false,
"documentation" : "The most recent description of the event.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "eventDescription",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"EventDetails" : {
"deprecated" : false,
"documentation" : "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.
",
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"event" : {
"deprecated" : false,
"documentation" : "Summary information about the event.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "Event",
"streaming" : false,
"xmlNamespace" : null
},
"eventDescription" : {
"deprecated" : false,
"documentation" : "The most recent description of the event.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "EventDescription",
"streaming" : false,
"xmlNamespace" : null
},
"eventMetadata" : {
"deprecated" : false,
"documentation" : "Additional metadata about the event.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "eventMetadata",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"EventDetailsErrorItem" : {
"deprecated" : false,
"documentation" : "Error information returned when a DescribeEventDetails operation cannot find a specified event.
",
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"errorMessage" : {
"deprecated" : false,
"documentation" : "A message that describes the error.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "string",
"streaming" : false,
"xmlNamespace" : null
},
"errorName" : {
"deprecated" : false,
"documentation" : "The name of the error.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "string",
"streaming" : false,
"xmlNamespace" : null
},
"eventArn" : {
"deprecated" : false,
"documentation" : "The unique identifier for the event. Format: arn:aws:health:event-region::event/EVENT_TYPE_PLUS_ID . Example: arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "eventArn",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"EventFilter" : {
"deprecated" : false,
"documentation" : "The values to use to filter results from the DescribeEvents and DescribeEventAggregates operations.
",
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"availabilityZones" : {
"deprecated" : false,
"documentation" : "A list of AWS availability zones.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "availabilityZones",
"streaming" : false,
"xmlNamespace" : null
},
"endTimes" : {
"deprecated" : false,
"documentation" : "A list of dates and times that the event ended.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "dateTimeRangeList",
"streaming" : false,
"xmlNamespace" : null
},
"entityArns" : {
"deprecated" : false,
"documentation" : "A list of entity ARNs (unique identifiers).
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "entityArnList",
"streaming" : false,
"xmlNamespace" : null
},
"entityValues" : {
"deprecated" : false,
"documentation" : "A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "entityValueList",
"streaming" : false,
"xmlNamespace" : null
},
"eventArns" : {
"deprecated" : false,
"documentation" : "A list of event ARNs (unique identifiers). For example: \"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331\", \"arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz\"
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "eventArnList",
"streaming" : false,
"xmlNamespace" : null
},
"eventStatusCodes" : {
"deprecated" : false,
"documentation" : "A list of event status codes.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "eventStatusCodeList",
"streaming" : false,
"xmlNamespace" : null
},
"eventTypeCategories" : {
"deprecated" : false,
"documentation" : "A list of event type category codes (issue, scheduledChange, or accountNotification).
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "eventTypeCategoryList",
"streaming" : false,
"xmlNamespace" : null
},
"eventTypeCodes" : {
"deprecated" : false,
"documentation" : "A list of unique identifiers for event types. For example, \"AWS_EC2_SYSTEM_MAINTENANCE_EVENT\",\"AWS_RDS_MAINTENANCE_SCHEDULED\"
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "eventTypeList",
"streaming" : false,
"xmlNamespace" : null
},
"lastUpdatedTimes" : {
"deprecated" : false,
"documentation" : "A list of dates and times that the event was last updated.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "dateTimeRangeList",
"streaming" : false,
"xmlNamespace" : null
},
"regions" : {
"deprecated" : false,
"documentation" : "A list of AWS regions.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "regionList",
"streaming" : false,
"xmlNamespace" : null
},
"services" : {
"deprecated" : false,
"documentation" : "The AWS services associated with the event. For example, EC2, RDS.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "serviceList",
"streaming" : false,
"xmlNamespace" : null
},
"startTimes" : {
"deprecated" : false,
"documentation" : "A list of dates and times that the event began.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "dateTimeRangeList",
"streaming" : false,
"xmlNamespace" : null
},
"tags" : {
"deprecated" : false,
"documentation" : "A map of entity tags attached to the affected entity.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "tagFilter",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"EventList" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "Event",
"streaming" : false,
"xmlNamespace" : null
},
"members" : { },
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "list",
"value" : null,
"wrapper" : false
},
"EventType" : {
"deprecated" : false,
"documentation" : "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).
",
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"category" : {
"deprecated" : false,
"documentation" : "A list of event type category codes (issue, scheduledChange, or accountNotification).
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "eventTypeCategory",
"streaming" : false,
"xmlNamespace" : null
},
"code" : {
"deprecated" : false,
"documentation" : "The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "eventTypeCode",
"streaming" : false,
"xmlNamespace" : null
},
"service" : {
"deprecated" : false,
"documentation" : "The AWS service that is affected by the event. For example, EC2, RDS.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "service",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"EventTypeCategoryList" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 10,
"member" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "eventTypeCategory",
"streaming" : false,
"xmlNamespace" : null
},
"members" : { },
"min" : 1,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "list",
"value" : null,
"wrapper" : false
},
"EventTypeCodeList" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 10,
"member" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "eventTypeCode",
"streaming" : false,
"xmlNamespace" : null
},
"members" : { },
"min" : 1,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "list",
"value" : null,
"wrapper" : false
},
"EventTypeFilter" : {
"deprecated" : false,
"documentation" : "The values to use to filter results from the DescribeEventTypes operation.
",
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"eventTypeCategories" : {
"deprecated" : false,
"documentation" : "A list of event type category codes (issue, scheduledChange, or accountNotification).
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "EventTypeCategoryList",
"streaming" : false,
"xmlNamespace" : null
},
"eventTypeCodes" : {
"deprecated" : false,
"documentation" : "A list of event type codes.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "EventTypeCodeList",
"streaming" : false,
"xmlNamespace" : null
},
"services" : {
"deprecated" : false,
"documentation" : "The AWS services associated with the event. For example, EC2, RDS.
",
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "serviceList",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"EventTypeList" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "EventType",
"streaming" : false,
"xmlNamespace" : null
},
"members" : { },
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "list",
"value" : null,
"wrapper" : false
},
"InvalidPaginationToken" : {
"deprecated" : false,
"documentation" : "The specified pagination token (nextToken) is not valid.
",
"enum" : null,
"error" : null,
"exception" : true,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"message" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "string",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"UnsupportedLocale" : {
"deprecated" : false,
"documentation" : "The specified locale is not supported.
",
"enum" : null,
"error" : null,
"exception" : true,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : {
"message" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "string",
"streaming" : false,
"xmlNamespace" : null
}
},
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "structure",
"value" : null,
"wrapper" : false
},
"accountId" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : { },
"min" : 0,
"pattern" : "[0-9]{12}",
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "string",
"value" : null,
"wrapper" : false
},
"aggregateValue" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : { },
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "string",
"value" : null,
"wrapper" : false
},
"availabilityZone" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : { },
"min" : 0,
"pattern" : "[a-z]{2}\\-[0-9a-z\\-]{4,16}",
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "string",
"value" : null,
"wrapper" : false
},
"availabilityZones" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "availabilityZone",
"streaming" : false,
"xmlNamespace" : null
},
"members" : { },
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "list",
"value" : null,
"wrapper" : false
},
"count" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : { },
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "integer",
"value" : null,
"wrapper" : false
},
"dateTimeRangeList" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 10,
"member" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "DateTimeRange",
"streaming" : false,
"xmlNamespace" : null
},
"members" : { },
"min" : 1,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "list",
"value" : null,
"wrapper" : false
},
"entityArn" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 1600,
"member" : null,
"members" : { },
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "string",
"value" : null,
"wrapper" : false
},
"entityArnList" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 100,
"member" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "entityArn",
"streaming" : false,
"xmlNamespace" : null
},
"members" : { },
"min" : 1,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "list",
"value" : null,
"wrapper" : false
},
"entityStatusCode" : {
"deprecated" : false,
"documentation" : null,
"enum" : [ "IMPAIRED", "UNIMPAIRED", "UNKNOWN" ],
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : { },
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "string",
"value" : null,
"wrapper" : false
},
"entityStatusCodeList" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 3,
"member" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "entityStatusCode",
"streaming" : false,
"xmlNamespace" : null
},
"members" : { },
"min" : 1,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "list",
"value" : null,
"wrapper" : false
},
"entityValue" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 256,
"member" : null,
"members" : { },
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "string",
"value" : null,
"wrapper" : false
},
"entityValueList" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 100,
"member" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "entityValue",
"streaming" : false,
"xmlNamespace" : null
},
"members" : { },
"min" : 1,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "list",
"value" : null,
"wrapper" : false
},
"eventAggregateField" : {
"deprecated" : false,
"documentation" : null,
"enum" : [ "eventTypeCategory" ],
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : { },
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "string",
"value" : null,
"wrapper" : false
},
"eventArn" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 1600,
"member" : null,
"members" : { },
"min" : 0,
"pattern" : "arn:aws:health:[^:]*:[^:]*:event/[\\w-]+",
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "string",
"value" : null,
"wrapper" : false
},
"eventArnList" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 10,
"member" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "eventArn",
"streaming" : false,
"xmlNamespace" : null
},
"members" : { },
"min" : 1,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "list",
"value" : null,
"wrapper" : false
},
"eventDescription" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : { },
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "string",
"value" : null,
"wrapper" : false
},
"eventMetadata" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "metadataKey",
"streaming" : false,
"xmlNamespace" : null
},
"max" : 0,
"member" : null,
"members" : { },
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "map",
"value" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "metadataValue",
"streaming" : false,
"xmlNamespace" : null
},
"wrapper" : false
},
"eventStatusCode" : {
"deprecated" : false,
"documentation" : null,
"enum" : [ "open", "closed", "upcoming" ],
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : { },
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "string",
"value" : null,
"wrapper" : false
},
"eventStatusCodeList" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 6,
"member" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "eventStatusCode",
"streaming" : false,
"xmlNamespace" : null
},
"members" : { },
"min" : 1,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "list",
"value" : null,
"wrapper" : false
},
"eventType" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 100,
"member" : null,
"members" : { },
"min" : 3,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "string",
"value" : null,
"wrapper" : false
},
"eventTypeCategory" : {
"deprecated" : false,
"documentation" : null,
"enum" : [ "issue", "accountNotification", "scheduledChange" ],
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 255,
"member" : null,
"members" : { },
"min" : 3,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "string",
"value" : null,
"wrapper" : false
},
"eventTypeCategoryList" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 10,
"member" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "eventTypeCategory",
"streaming" : false,
"xmlNamespace" : null
},
"members" : { },
"min" : 1,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "list",
"value" : null,
"wrapper" : false
},
"eventTypeCode" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 100,
"member" : null,
"members" : { },
"min" : 3,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "string",
"value" : null,
"wrapper" : false
},
"eventTypeList" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 10,
"member" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "eventType",
"streaming" : false,
"xmlNamespace" : null
},
"members" : { },
"min" : 1,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "list",
"value" : null,
"wrapper" : false
},
"locale" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 256,
"member" : null,
"members" : { },
"min" : 2,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "string",
"value" : null,
"wrapper" : false
},
"maxResults" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 100,
"member" : null,
"members" : { },
"min" : 10,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "integer",
"value" : null,
"wrapper" : false
},
"metadataKey" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : { },
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "string",
"value" : null,
"wrapper" : false
},
"metadataValue" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 10240,
"member" : null,
"members" : { },
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "string",
"value" : null,
"wrapper" : false
},
"nextToken" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : { },
"min" : 0,
"pattern" : "[a-zA-Z0-9=/+_.-]{4,512}",
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "string",
"value" : null,
"wrapper" : false
},
"region" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : { },
"min" : 0,
"pattern" : "[^:/]{2,25}",
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "string",
"value" : null,
"wrapper" : false
},
"regionList" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 10,
"member" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "region",
"streaming" : false,
"xmlNamespace" : null
},
"members" : { },
"min" : 1,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "list",
"value" : null,
"wrapper" : false
},
"service" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 30,
"member" : null,
"members" : { },
"min" : 2,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "string",
"value" : null,
"wrapper" : false
},
"serviceList" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 10,
"member" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "service",
"streaming" : false,
"xmlNamespace" : null
},
"members" : { },
"min" : 1,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "list",
"value" : null,
"wrapper" : false
},
"string" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : { },
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "string",
"value" : null,
"wrapper" : false
},
"tagFilter" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 50,
"member" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "tagSet",
"streaming" : false,
"xmlNamespace" : null
},
"members" : { },
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "list",
"value" : null,
"wrapper" : false
},
"tagKey" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 127,
"member" : null,
"members" : { },
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "string",
"value" : null,
"wrapper" : false
},
"tagSet" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "tagKey",
"streaming" : false,
"xmlNamespace" : null
},
"max" : 50,
"member" : null,
"members" : { },
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "map",
"value" : {
"deprecated" : false,
"documentation" : null,
"flattened" : false,
"idempotencyToken" : false,
"location" : null,
"locationName" : null,
"payload" : false,
"queryName" : null,
"shape" : "tagValue",
"streaming" : false,
"xmlNamespace" : null
},
"wrapper" : false
},
"tagValue" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 255,
"member" : null,
"members" : { },
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "string",
"value" : null,
"wrapper" : false
},
"timestamp" : {
"deprecated" : false,
"documentation" : null,
"enum" : null,
"error" : null,
"exception" : false,
"fault" : false,
"flattened" : false,
"key" : null,
"max" : 0,
"member" : null,
"members" : { },
"min" : 0,
"pattern" : null,
"payload" : null,
"required" : null,
"streaming" : false,
"type" : "timestamp",
"value" : null,
"wrapper" : false
}
},
"documentation" : "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
"
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy