Upload
others
View
60
Download
0
Embed Size (px)
Citation preview
AWS Health API Reference
AWS Health: API ReferenceCopyright © 2020 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.
Amazon's trademarks and trade dress may not be used in connection with any product or service that is notAmazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages ordiscredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who mayor may not be affiliated with, connected to, or sponsored by Amazon.
AWS Health API Reference
Table of ContentsWelcome .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Actions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
DescribeAffectedAccountsForOrganization .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
DescribeAffectedEntities ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
DescribeAffectedEntitiesForOrganization .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
DescribeEntityAggregates .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
DescribeEventAggregates .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
DescribeEventDetails ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
DescribeEventDetailsForOrganization .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
DescribeEvents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
API Version 2016-08-04iii
AWS Health API Reference
Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
DescribeEventsForOrganization .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
DescribeEventTypes .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
DescribeHealthServiceStatusForOrganization .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
DisableHealthServiceAccessForOrganization .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
EnableHealthServiceAccessForOrganization .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Data Types .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37AffectedEntity ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
DateTimeRange .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
EntityAggregate .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
EntityFilter ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Event .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
EventAccountFilter ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
EventAggregate .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
EventDescription .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
EventDetails ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
API Version 2016-08-04iv
AWS Health API Reference
Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
EventDetailsErrorItem ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
EventFilter ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
EventType .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
EventTypeFilter ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
OrganizationAffectedEntitiesErrorItem ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
OrganizationEvent .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
OrganizationEventDetails ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
OrganizationEventDetailsErrorItem ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
OrganizationEventFilter ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Common Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Common Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
API Version 2016-08-04v
AWS Health API Reference
WelcomeThe AWS Health API provides programmatic access to the AWS Health information that is presentedin the AWS Personal Health Dashboard. You can get information about events that affect your AWSresources:
• DescribeEvents (p. 24): Summary information about events.• DescribeEventDetails (p. 18): Detailed information about one or more events.• DescribeAffectedEntities (p. 7): 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 oraffected entities:
• DescribeEventTypes (p. 31): Information about the kinds of events that AWS Health tracks.• DescribeEventAggregates (p. 15): A count of the number of events that meet specified criteria.• DescribeEntityAggregates (p. 13): A count of the number of affected entities that meet specified
criteria.
AWS Health integrates with AWS Organizations to provide a centralized view of AWS Health eventsacross all accounts in your organization.
• DescribeEventsForOrganization (p. 28): Summary information about events across the organization.• DescribeAffectedAccountsForOrganization (p. 4): List of accounts in your organization impacted by
an event.• DescribeEventDetailsForOrganization (p. 21): Detailed information about events in your
organization.• DescribeAffectedEntitiesForOrganization (p. 10): Information about AWS resources in your
organization that are affected by events.
You can use the following operations to enable or disable AWS Health from working with AWSOrganizations.
• EnableHealthServiceAccessForOrganization (p. 36): Enables AWS Health to work with AWSOrganizations.
• DisableHealthServiceAccessForOrganization (p. 35): Disables AWS Health from working with AWSOrganizations.
• DescribeHealthServiceStatusForOrganization (p. 34): Status information about enabling ordisabling AWS Health from working with AWS Organizations.
The Health API requires a Business or Enterprise support plan from AWS Support. Calling theHealth API from an account that does not have a Business or Enterprise support plan causes aSubscriptionRequiredException.
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
API Version 2016-08-041
AWS Health API Reference
The HTTP endpoint for the AWS Health API is:
• https://health.us-east-1.amazonaws.com
This document was last published on April 23, 2020.
API Version 2016-08-042
AWS Health API Reference
ActionsThe following actions are supported:
• DescribeAffectedAccountsForOrganization (p. 4)• DescribeAffectedEntities (p. 7)• DescribeAffectedEntitiesForOrganization (p. 10)• DescribeEntityAggregates (p. 13)• DescribeEventAggregates (p. 15)• DescribeEventDetails (p. 18)• DescribeEventDetailsForOrganization (p. 21)• DescribeEvents (p. 24)• DescribeEventsForOrganization (p. 28)• DescribeEventTypes (p. 31)• DescribeHealthServiceStatusForOrganization (p. 34)• DisableHealthServiceAccessForOrganization (p. 35)• EnableHealthServiceAccessForOrganization (p. 36)
API Version 2016-08-043
AWS Health API ReferenceDescribeAffectedAccountsForOrganization
DescribeAffectedAccountsForOrganizationReturns a list of accounts in the organization from AWS Organizations that are affected by the providedevent.
Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. Todo this, call the EnableHealthServiceAccessForOrganization (p. 36) operation from your organization'smaster account.
Request Syntax{ "eventArn": "string", "maxResults": number, "nextToken": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 67).
The request accepts the following data in JSON format.
eventArn (p. 4)
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
Type: String
Length Constraints: Maximum length of 1600.
Pattern: arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]*:[^:]*:event(?:/[\w-]+){3}
Required: YesmaxResults (p. 4)
The maximum number of items to return in one batch, between 10 and 100, inclusive.
Type: Integer
Valid Range: Minimum value of 10. Maximum value of 100.
Required: NonextToken (p. 4)
If the results of a search are large, only a portion of the results are returned, and a nextTokenpagination token is returned in the response. To retrieve the next batch of results, reissue the searchrequest and include the returned token. When all results have been returned, the response does notcontain a pagination token value.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 10000.
API Version 2016-08-044
AWS Health API ReferenceResponse Syntax
Pattern: [a-zA-Z0-9=/+_.-]{4,10000}
Required: No
Response Syntax{ "affectedAccounts": [ "string" ], "nextToken": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
affectedAccounts (p. 5)
A JSON set of elements of the affected accounts.
Type: Array of strings
Length Constraints: Maximum length of 12.
Pattern: ^\S+$nextToken (p. 5)
If the results of a search are large, only a portion of the results are returned, and a nextTokenpagination token is returned in the response. To retrieve the next batch of results, reissue the searchrequest and include the returned token. When all results have been returned, the response does notcontain a pagination token value.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 10000.
Pattern: [a-zA-Z0-9=/+_.-]{4,10000}
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 69).
InvalidPaginationToken
The specified pagination token (nextToken) is not valid.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
API Version 2016-08-045
AWS Health API ReferenceSee Also
• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2016-08-046
AWS Health API ReferenceDescribeAffectedEntities
DescribeAffectedEntitiesReturns a list of entities that have been affected by the specified events, based on the specified filtercriteria. Entities can refer to individual customer resources, groups of customer resources, or any otherconstruct, 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, startingwith the most recent.
Request Syntax{ "filter": { "entityArns": [ "string" ], "entityValues": [ "string" ], "eventArns": [ "string" ], "lastUpdatedTimes": [ { "from": number, "to": number } ], "statusCodes": [ "string" ], "tags": [ { "string" : "string" } ] }, "locale": "string", "maxResults": number, "nextToken": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 67).
The request accepts the following data in JSON format.
filter (p. 7)
Values to narrow the results returned. At least one event ARN is required.
Type: EntityFilter (p. 42) object
Required: Yes
locale (p. 7)
The locale (language) to return information in. English (en) is the default and the only supportedvalue at this time.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 256.
API Version 2016-08-047
AWS Health API ReferenceResponse Syntax
Pattern: .{2,256}
Required: NomaxResults (p. 7)
The maximum number of items to return in one batch, between 10 and 100, inclusive.
Type: Integer
Valid Range: Minimum value of 10. Maximum value of 100.
Required: NonextToken (p. 7)
If the results of a search are large, only a portion of the results are returned, and a nextTokenpagination token is returned in the response. To retrieve the next batch of results, reissue the searchrequest and include the returned token. When all results have been returned, the response does notcontain a pagination token value.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 10000.
Pattern: [a-zA-Z0-9=/+_.-]{4,10000}
Required: No
Response Syntax{ "entities": [ { "awsAccountId": "string", "entityArn": "string", "entityUrl": "string", "entityValue": "string", "eventArn": "string", "lastUpdatedTime": number, "statusCode": "string", "tags": { "string" : "string" } } ], "nextToken": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
entities (p. 8)
The entities that match the filter criteria.
Type: Array of AffectedEntity (p. 38) objects
API Version 2016-08-048
AWS Health API ReferenceErrors
nextToken (p. 8)
If the results of a search are large, only a portion of the results are returned, and a nextTokenpagination token is returned in the response. To retrieve the next batch of results, reissue the searchrequest and include the returned token. When all results have been returned, the response does notcontain a pagination token value.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 10000.
Pattern: [a-zA-Z0-9=/+_.-]{4,10000}
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 69).
InvalidPaginationToken
The specified pagination token (nextToken) is not valid.
HTTP Status Code: 400UnsupportedLocale
The specified locale is not supported.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2016-08-049
AWS Health API ReferenceDescribeAffectedEntitiesForOrganization
DescribeAffectedEntitiesForOrganizationReturns a list of entities that have been affected by one or more events for one or more accounts in yourorganization in AWS Organizations, based on the filter criteria. Entities can refer to individual customerresources, groups of customer resources, or any other construct, depending on the AWS service.
At least one event ARN and account ID are required. Results are sorted by the lastUpdatedTime of theentity, starting with the most recent.
Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. Todo this, call the EnableHealthServiceAccessForOrganization (p. 36) operation from your organization'smaster account.
Request Syntax{ "locale": "string", "maxResults": number, "nextToken": "string", "organizationEntityFilters": [ { "awsAccountId": "string", "eventArn": "string" } ]}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 67).
The request accepts the following data in JSON format.
locale (p. 10)
The locale (language) to return information in. English (en) is the default and the only supportedvalue at this time.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 256.
Pattern: .{2,256}
Required: NomaxResults (p. 10)
The maximum number of items to return in one batch, between 10 and 100, inclusive.
Type: Integer
Valid Range: Minimum value of 10. Maximum value of 100.
Required: NonextToken (p. 10)
If the results of a search are large, only a portion of the results are returned, and a nextTokenpagination token is returned in the response. To retrieve the next batch of results, reissue the search
API Version 2016-08-0410
AWS Health API ReferenceResponse Syntax
request and include the returned token. When all results have been returned, the response does notcontain a pagination token value.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 10000.
Pattern: [a-zA-Z0-9=/+_.-]{4,10000}
Required: NoorganizationEntityFilters (p. 10)
A JSON set of elements including the awsAccountId and the eventArn.
Type: Array of EventAccountFilter (p. 47) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
Response Syntax{ "entities": [ { "awsAccountId": "string", "entityArn": "string", "entityUrl": "string", "entityValue": "string", "eventArn": "string", "lastUpdatedTime": number, "statusCode": "string", "tags": { "string" : "string" } } ], "failedSet": [ { "awsAccountId": "string", "errorMessage": "string", "errorName": "string", "eventArn": "string" } ], "nextToken": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
entities (p. 11)
A JSON set of elements including the awsAccountId and its entityArn, entityValue and itsentityArn, lastUpdatedTime, statusCode, and tags.
Type: Array of AffectedEntity (p. 38) objects
API Version 2016-08-0411
AWS Health API ReferenceErrors
failedSet (p. 11)
A JSON set of elements of the failed response, including the awsAccountId, errorMessage,errorName, and eventArn.
Type: Array of OrganizationAffectedEntitiesErrorItem (p. 57) objectsnextToken (p. 11)
If the results of a search are large, only a portion of the results are returned, and a nextTokenpagination token is returned in the response. To retrieve the next batch of results, reissue the searchrequest and include the returned token. When all results have been returned, the response does notcontain a pagination token value.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 10000.
Pattern: [a-zA-Z0-9=/+_.-]{4,10000}
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 69).
InvalidPaginationToken
The specified pagination token (nextToken) is not valid.
HTTP Status Code: 400UnsupportedLocale
The specified locale is not supported.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2016-08-0412
AWS Health API ReferenceDescribeEntityAggregates
DescribeEntityAggregatesReturns the number of entities that are affected by each of the specified events. If no events arespecified, the counts of all affected entities are returned.
Request Syntax{ "eventArns": [ "string" ]}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 67).
The request accepts the following data in JSON format.
eventArns (p. 13)
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"
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Length Constraints: Maximum length of 1600.
Pattern: arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]*:[^:]*:event(?:/[\w-]+){3}
Required: No
Response Syntax{ "entityAggregates": [ { "count": number, "eventArn": "string" } ]}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
entityAggregates (p. 13)
The number of entities that are affected by each of the specified events.
API Version 2016-08-0413
AWS Health API ReferenceErrors
Type: Array of EntityAggregate (p. 41) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 69).
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2016-08-0414
AWS Health API ReferenceDescribeEventAggregates
DescribeEventAggregatesReturns the number of events of each event type (issue, scheduled change, and account notification). Ifno filter is specified, the counts of all events in each category are returned.
Request Syntax{ "aggregateField": "string", "filter": { "availabilityZones": [ "string" ], "endTimes": [ { "from": number, "to": number } ], "entityArns": [ "string" ], "entityValues": [ "string" ], "eventArns": [ "string" ], "eventStatusCodes": [ "string" ], "eventTypeCategories": [ "string" ], "eventTypeCodes": [ "string" ], "lastUpdatedTimes": [ { "from": number, "to": number } ], "regions": [ "string" ], "services": [ "string" ], "startTimes": [ { "from": number, "to": number } ], "tags": [ { "string" : "string" } ] }, "maxResults": number, "nextToken": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 67).
The request accepts the following data in JSON format.
aggregateField (p. 15)
The only currently supported value is eventTypeCategory.
Type: String
API Version 2016-08-0415
AWS Health API ReferenceResponse Syntax
Valid Values: eventTypeCategory
Required: Yesfilter (p. 15)
Values to narrow the results returned.
Type: EventFilter (p. 52) object
Required: NomaxResults (p. 15)
The maximum number of items to return in one batch, between 10 and 100, inclusive.
Type: Integer
Valid Range: Minimum value of 10. Maximum value of 100.
Required: NonextToken (p. 15)
If the results of a search are large, only a portion of the results are returned, and a nextTokenpagination token is returned in the response. To retrieve the next batch of results, reissue the searchrequest and include the returned token. When all results have been returned, the response does notcontain a pagination token value.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 10000.
Pattern: [a-zA-Z0-9=/+_.-]{4,10000}
Required: No
Response Syntax{ "eventAggregates": [ { "aggregateValue": "string", "count": number } ], "nextToken": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
eventAggregates (p. 16)
The number of events in each category that meet the optional filter criteria.
Type: Array of EventAggregate (p. 48) objects
API Version 2016-08-0416
AWS Health API ReferenceErrors
nextToken (p. 16)
If the results of a search are large, only a portion of the results are returned, and a nextTokenpagination token is returned in the response. To retrieve the next batch of results, reissue the searchrequest and include the returned token. When all results have been returned, the response does notcontain a pagination token value.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 10000.
Pattern: [a-zA-Z0-9=/+_.-]{4,10000}
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 69).
InvalidPaginationToken
The specified pagination token (nextToken) is not valid.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2016-08-0417
AWS Health API ReferenceDescribeEventDetails
DescribeEventDetailsReturns detailed information about one or more specified events. Information includes standard eventdata (region, service, and so on, as returned by DescribeEvents (p. 24)), a detailed event description,and possible additional metadata that depends upon the nature of the event. Affected entities are notincluded; to retrieve those, use the DescribeAffectedEntities (p. 7) operation.
If a specified event cannot be retrieved, an error message is returned for that event.
Request Syntax{ "eventArns": [ "string" ], "locale": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 67).
The request accepts the following data in JSON format.
eventArns (p. 18)
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"
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Maximum length of 1600.
Pattern: arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]*:[^:]*:event(?:/[\w-]+){3}
Required: Yeslocale (p. 18)
The locale (language) to return information in. English (en) is the default and the only supportedvalue at this time.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 256.
Pattern: .{2,256}
Required: No
Response Syntax{ "failedSet": [ {
API Version 2016-08-0418
AWS Health API ReferenceResponse Elements
"errorMessage": "string", "errorName": "string", "eventArn": "string" } ], "successfulSet": [ { "event": { "arn": "string", "availabilityZone": "string", "endTime": number, "eventTypeCategory": "string", "eventTypeCode": "string", "lastUpdatedTime": number, "region": "string", "service": "string", "startTime": number, "statusCode": "string" }, "eventDescription": { "latestDescription": "string" }, "eventMetadata": { "string" : "string" } } ]}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
failedSet (p. 18)
Error messages for any events that could not be retrieved.
Type: Array of EventDetailsErrorItem (p. 51) objectssuccessfulSet (p. 18)
Information about the events that could be retrieved.
Type: Array of EventDetails (p. 50) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 69).
UnsupportedLocale
The specified locale is not supported.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
API Version 2016-08-0419
AWS Health API ReferenceSee Also
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2016-08-0420
AWS Health API ReferenceDescribeEventDetailsForOrganization
DescribeEventDetailsForOrganizationReturns detailed information about one or more specified events for one or more accounts in yourorganization. Information includes standard event data (Region, service, and so on, as returned byDescribeEventsForOrganization (p. 28), a detailed event description, and possible additional metadatathat depends upon the nature of the event. Affected entities are not included; to retrieve those, use theDescribeAffectedEntitiesForOrganization (p. 10) operation.
Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. Todo this, call the EnableHealthServiceAccessForOrganization (p. 36) operation from your organization'smaster account.
Request Syntax{ "locale": "string", "organizationEventDetailFilters": [ { "awsAccountId": "string", "eventArn": "string" } ]}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 67).
The request accepts the following data in JSON format.
locale (p. 21)
The locale (language) to return information in. English (en) is the default and the only supportedvalue at this time.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 256.
Pattern: .{2,256}
Required: NoorganizationEventDetailFilters (p. 21)
A set of JSON elements that includes the awsAccountId and the eventArn.
Type: Array of EventAccountFilter (p. 47) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
Response Syntax{
API Version 2016-08-0421
AWS Health API ReferenceResponse Elements
"failedSet": [ { "awsAccountId": "string", "errorMessage": "string", "errorName": "string", "eventArn": "string" } ], "successfulSet": [ { "awsAccountId": "string", "event": { "arn": "string", "availabilityZone": "string", "endTime": number, "eventTypeCategory": "string", "eventTypeCode": "string", "lastUpdatedTime": number, "region": "string", "service": "string", "startTime": number, "statusCode": "string" }, "eventDescription": { "latestDescription": "string" }, "eventMetadata": { "string" : "string" } } ]}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
failedSet (p. 21)
Error messages for any events that could not be retrieved.
Type: Array of OrganizationEventDetailsErrorItem (p. 62) objects
successfulSet (p. 21)
Information about the events that could be retrieved.
Type: Array of OrganizationEventDetails (p. 61) objects
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 69).
UnsupportedLocale
The specified locale is not supported.
HTTP Status Code: 400
API Version 2016-08-0422
AWS Health API ReferenceSee Also
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2016-08-0423
AWS Health API ReferenceDescribeEvents
DescribeEventsReturns information about events that meet the specified filter criteria. Events are returned in asummary form and do not include the detailed description, any additional metadata that depends on theevent type, or any affected resources. To retrieve that information, use the DescribeEventDetails (p. 18)and DescribeAffectedEntities (p. 7) operations.
If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime,starting with the most recent.
Request Syntax
{ "filter": { "availabilityZones": [ "string" ], "endTimes": [ { "from": number, "to": number } ], "entityArns": [ "string" ], "entityValues": [ "string" ], "eventArns": [ "string" ], "eventStatusCodes": [ "string" ], "eventTypeCategories": [ "string" ], "eventTypeCodes": [ "string" ], "lastUpdatedTimes": [ { "from": number, "to": number } ], "regions": [ "string" ], "services": [ "string" ], "startTimes": [ { "from": number, "to": number } ], "tags": [ { "string" : "string" } ] }, "locale": "string", "maxResults": number, "nextToken": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 67).
The request accepts the following data in JSON format.
API Version 2016-08-0424
AWS Health API ReferenceResponse Syntax
filter (p. 24)
Values to narrow the results returned.
Type: EventFilter (p. 52) object
Required: Nolocale (p. 24)
The locale (language) to return information in. English (en) is the default and the only supportedvalue at this time.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 256.
Pattern: .{2,256}
Required: NomaxResults (p. 24)
The maximum number of items to return in one batch, between 10 and 100, inclusive.
Type: Integer
Valid Range: Minimum value of 10. Maximum value of 100.
Required: NonextToken (p. 24)
If the results of a search are large, only a portion of the results are returned, and a nextTokenpagination token is returned in the response. To retrieve the next batch of results, reissue the searchrequest and include the returned token. When all results have been returned, the response does notcontain a pagination token value.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 10000.
Pattern: [a-zA-Z0-9=/+_.-]{4,10000}
Required: No
Response Syntax{ "events": [ { "arn": "string", "availabilityZone": "string", "endTime": number, "eventTypeCategory": "string", "eventTypeCode": "string", "lastUpdatedTime": number, "region": "string", "service": "string", "startTime": number, "statusCode": "string" }
API Version 2016-08-0425
AWS Health API ReferenceResponse Elements
], "nextToken": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
events (p. 25)
The events that match the specified filter criteria.
Type: Array of Event (p. 44) objectsnextToken (p. 25)
If the results of a search are large, only a portion of the results are returned, and a nextTokenpagination token is returned in the response. To retrieve the next batch of results, reissue the searchrequest and include the returned token. When all results have been returned, the response does notcontain a pagination token value.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 10000.
Pattern: [a-zA-Z0-9=/+_.-]{4,10000}
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 69).
InvalidPaginationToken
The specified pagination token (nextToken) is not valid.
HTTP Status Code: 400UnsupportedLocale
The specified locale is not supported.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3
API Version 2016-08-0426
AWS Health API ReferenceSee Also
• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2016-08-0427
AWS Health API ReferenceDescribeEventsForOrganization
DescribeEventsForOrganizationReturns information about events across your organization in AWS Organizations, meeting the specifiedfilter criteria. Events are returned in a summary form and do not include the accounts impacted,detailed description, any additional metadata that depends on the event type, or any affectedresources. To retrieve that information, use the DescribeAffectedAccountsForOrganization (p. 4),DescribeEventDetailsForOrganization (p. 21), and DescribeAffectedEntitiesForOrganization (p. 10)operations.
If no filter criteria are specified, all events across your organization are returned. Results are sorted bylastModifiedTime, starting with the most recent.
Before you can call this operation, you must first enable Health to work with AWS Organizations. To dothis, call the EnableHealthServiceAccessForOrganization (p. 36) operation from your organization'smaster account.
Request Syntax{ "filter": { "awsAccountIds": [ "string" ], "endTime": { "from": number, "to": number }, "entityArns": [ "string" ], "entityValues": [ "string" ], "eventStatusCodes": [ "string" ], "eventTypeCategories": [ "string" ], "eventTypeCodes": [ "string" ], "lastUpdatedTime": { "from": number, "to": number }, "regions": [ "string" ], "services": [ "string" ], "startTime": { "from": number, "to": number } }, "locale": "string", "maxResults": number, "nextToken": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 67).
The request accepts the following data in JSON format.
filter (p. 28)
Values to narrow the results returned.
Type: OrganizationEventFilter (p. 64) object
API Version 2016-08-0428
AWS Health API ReferenceResponse Syntax
Required: Nolocale (p. 28)
The locale (language) to return information in. English (en) is the default and the only supportedvalue at this time.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 256.
Pattern: .{2,256}
Required: NomaxResults (p. 28)
The maximum number of items to return in one batch, between 10 and 100, inclusive.
Type: Integer
Valid Range: Minimum value of 10. Maximum value of 100.
Required: NonextToken (p. 28)
If the results of a search are large, only a portion of the results are returned, and a nextTokenpagination token is returned in the response. To retrieve the next batch of results, reissue the searchrequest and include the returned token. When all results have been returned, the response does notcontain a pagination token value.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 10000.
Pattern: [a-zA-Z0-9=/+_.-]{4,10000}
Required: No
Response Syntax{ "events": [ { "arn": "string", "endTime": number, "eventTypeCategory": "string", "eventTypeCode": "string", "lastUpdatedTime": number, "region": "string", "service": "string", "startTime": number, "statusCode": "string" } ], "nextToken": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
API Version 2016-08-0429
AWS Health API ReferenceErrors
The following data is returned in JSON format by the service.
events (p. 29)
The events that match the specified filter criteria.
Type: Array of OrganizationEvent (p. 59) objectsnextToken (p. 29)
If the results of a search are large, only a portion of the results are returned, and a nextTokenpagination token is returned in the response. To retrieve the next batch of results, reissue the searchrequest and include the returned token. When all results have been returned, the response does notcontain a pagination token value.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 10000.
Pattern: [a-zA-Z0-9=/+_.-]{4,10000}
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 69).
InvalidPaginationToken
The specified pagination token (nextToken) is not valid.
HTTP Status Code: 400UnsupportedLocale
The specified locale is not supported.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2016-08-0430
AWS Health API ReferenceDescribeEventTypes
DescribeEventTypesReturns the event types that meet the specified filter criteria. If no filter criteria are specified, all eventtypes are returned, in no particular order.
Request Syntax{ "filter": { "eventTypeCategories": [ "string" ], "eventTypeCodes": [ "string" ], "services": [ "string" ] }, "locale": "string", "maxResults": number, "nextToken": "string"}
Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 67).
The request accepts the following data in JSON format.
filter (p. 31)
Values to narrow the results returned.
Type: EventTypeFilter (p. 56) object
Required: Nolocale (p. 31)
The locale (language) to return information in. English (en) is the default and the only supportedvalue at this time.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 256.
Pattern: .{2,256}
Required: NomaxResults (p. 31)
The maximum number of items to return in one batch, between 10 and 100, inclusive.
Type: Integer
Valid Range: Minimum value of 10. Maximum value of 100.
Required: NonextToken (p. 31)
If the results of a search are large, only a portion of the results are returned, and a nextTokenpagination token is returned in the response. To retrieve the next batch of results, reissue the searchrequest and include the returned token. When all results have been returned, the response does notcontain a pagination token value.
API Version 2016-08-0431
AWS Health API ReferenceResponse Syntax
Type: String
Length Constraints: Minimum length of 4. Maximum length of 10000.
Pattern: [a-zA-Z0-9=/+_.-]{4,10000}
Required: No
Response Syntax{ "eventTypes": [ { "category": "string", "code": "string", "service": "string" } ], "nextToken": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
eventTypes (p. 32)
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).
Type: Array of EventType (p. 55) objectsnextToken (p. 32)
If the results of a search are large, only a portion of the results are returned, and a nextTokenpagination token is returned in the response. To retrieve the next batch of results, reissue the searchrequest and include the returned token. When all results have been returned, the response does notcontain a pagination token value.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 10000.
Pattern: [a-zA-Z0-9=/+_.-]{4,10000}
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 69).
InvalidPaginationToken
The specified pagination token (nextToken) is not valid.
HTTP Status Code: 400
API Version 2016-08-0432
AWS Health API ReferenceSee Also
UnsupportedLocale
The specified locale is not supported.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2016-08-0433
AWS Health API ReferenceDescribeHealthServiceStatusForOrganization
DescribeHealthServiceStatusForOrganizationThis operation provides status information on enabling or disabling AWS Health to work with yourorganization. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as theroot user (not recommended) in the organization's master account.
Response Syntax{ "healthServiceAccessStatusForOrganization": "string"}
Response ElementsIf the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
healthServiceAccessStatusForOrganization (p. 34)
Information about the status of enabling or disabling AWS Health Organizational View in yourorganization.
Valid values are ENABLED | DISABLED | PENDING.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 69).
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2016-08-0434
AWS Health API ReferenceDisableHealthServiceAccessForOrganization
DisableHealthServiceAccessForOrganizationCalling this operation disables AWS Health from working with AWS Organizations. This does not removethe Service Linked Role (SLR) from the the master account in your organization. Use the IAM console, API,or AWS CLI to remove the SLR if desired. To call this operation, you must sign in as an IAM user, assumean IAM role, or sign in as the root user (not recommended) in the organization's master account.
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 69).
ConcurrentModificationException
EnableHealthServiceAccessForOrganization (p. 36) is already in progress. Waitfor the action to complete before trying again. To get the current status, use theDescribeHealthServiceStatusForOrganization (p. 34) operation.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2016-08-0435
AWS Health API ReferenceEnableHealthServiceAccessForOrganization
EnableHealthServiceAccessForOrganizationCalling this operation enables AWS Health to work with AWS Organizations. This applies a Service LinkedRole (SLR) to the master account in the organization. To learn more about the steps in this process, visitenabling service access for AWS Health in AWS Organizations. To call this operation, you must sign inas an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization'smaster account.
Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 69).
ConcurrentModificationException
EnableHealthServiceAccessForOrganization (p. 36) is already in progress. Waitfor the action to complete before trying again. To get the current status, use theDescribeHealthServiceStatusForOrganization (p. 34) operation.
HTTP Status Code: 400
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3
API Version 2016-08-0436
AWS Health API Reference
Data TypesThe AWS Health APIs and Notifications API contains several data types that various actions use. Thissection describes each data type in detail.
NoteThe order of each element in a data type structure is not guaranteed. Applications should notassume a particular order.
The following data types are supported:
• AffectedEntity (p. 38)• DateTimeRange (p. 40)• EntityAggregate (p. 41)• EntityFilter (p. 42)• Event (p. 44)• EventAccountFilter (p. 47)• EventAggregate (p. 48)• EventDescription (p. 49)• EventDetails (p. 50)• EventDetailsErrorItem (p. 51)• EventFilter (p. 52)• EventType (p. 55)• EventTypeFilter (p. 56)• OrganizationAffectedEntitiesErrorItem (p. 57)• OrganizationEvent (p. 59)• OrganizationEventDetails (p. 61)• OrganizationEventDetailsErrorItem (p. 62)• OrganizationEventFilter (p. 64)
API Version 2016-08-0437
AWS Health API ReferenceAffectedEntity
AffectedEntityInformation about an entity that is affected by a Health event.
ContentsawsAccountId
The 12-digit AWS account number that contains the affected entity.
Type: String
Length Constraints: Maximum length of 12.
Pattern: ^\S+$
Required: NoentityArn
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
Type: String
Length Constraints: Maximum length of 1600.
Pattern: .{0,1600}
Required: NoentityUrl
The URL of the affected entity.
Type: String
Required: NoentityValue
The ID of the affected entity.
Type: String
Length Constraints: Maximum length of 256.
Pattern: .{0,256}
Required: NoeventArn
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
Type: String
Length Constraints: Maximum length of 1600.
API Version 2016-08-0438
AWS Health API ReferenceSee Also
Pattern: arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]*:[^:]*:event(?:/[\w-]+){3}
Required: NolastUpdatedTime
The most recent time that the entity was updated.
Type: Timestamp
Required: NostatusCode
The most recent status of the entity affected by the event. The possible values are IMPAIRED,UNIMPAIRED, and UNKNOWN.
Type: String
Valid Values: IMPAIRED | UNIMPAIRED | UNKNOWN
Required: Notags
A map of entity tags attached to the affected entity.
Type: String to string map
Key Length Constraints: Maximum length of 127.
Key Pattern: .{0,127}
Value Length Constraints: Maximum length of 255.
Value Pattern: .{0,255}
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2016-08-0439
AWS Health API ReferenceDateTimeRange
DateTimeRangeA range of dates and times that is used by the EventFilter (p. 52) and EntityFilter (p. 42)objects. If from is set and to is set: match items where the timestamp (startTime, endTime, orlastUpdatedTime) is between from and to inclusive. If from is set and to is not set: match itemswhere the timestamp value is equal to or after from. If from is not set and to is set: match items wherethe timestamp value is equal to or before to.
Contentsfrom
The starting date and time of a time range.
Type: Timestamp
Required: Noto
The ending date and time of a time range.
Type: Timestamp
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2016-08-0440
AWS Health API ReferenceEntityAggregate
EntityAggregateThe number of entities that are affected by one or more events. Returned by theDescribeEntityAggregates (p. 13) operation.
Contentscount
The number entities that match the criteria for the specified events.
Type: Integer
Required: NoeventArn
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
Type: String
Length Constraints: Maximum length of 1600.
Pattern: arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]*:[^:]*:event(?:/[\w-]+){3}
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2016-08-0441
AWS Health API ReferenceEntityFilter
EntityFilterThe values to use to filter results from the DescribeAffectedEntities (p. 7) operation.
ContentsentityArns
A list of entity ARNs (unique identifiers).
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Maximum length of 1600.
Pattern: .{0,1600}
Required: No
entityValues
A list of IDs for affected entities.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Maximum length of 256.
Pattern: .{0,256}
Required: No
eventArns
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"
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Maximum length of 1600.
Pattern: arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]*:[^:]*:event(?:/[\w-]+){3}
Required: Yes
lastUpdatedTimes
A list of the most recent dates and times that the entity was updated.
Type: Array of DateTimeRange (p. 40) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
API Version 2016-08-0442
AWS Health API ReferenceSee Also
statusCodes
A list of entity status codes (IMPAIRED, UNIMPAIRED, or UNKNOWN).
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 3 items.
Valid Values: IMPAIRED | UNIMPAIRED | UNKNOWN
Required: Notags
A map of entity tags attached to the affected entity.
Type: Array of string to string maps
Array Members: Maximum number of 50 items.
Key Length Constraints: Maximum length of 127.
Key Pattern: .{0,127}
Value Length Constraints: Maximum length of 255.
Value Pattern: .{0,255}
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2016-08-0443
AWS Health API ReferenceEvent
EventSummary information about an AWS Health event.
Contentsarn
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
Type: String
Length Constraints: Maximum length of 1600.
Pattern: arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]*:[^:]*:event(?:/[\w-]+){3}
Required: NoavailabilityZone
The AWS Availability Zone of the event. For example, us-east-1a.
Type: String
Length Constraints: Minimum length of 6. Maximum length of 18.
Pattern: [a-z]{2}\-[0-9a-z\-]{4,16}
Required: NoendTime
The date and time that the event ended.
Type: Timestamp
Required: NoeventTypeCategory
The category of the event. Possible values are issue, scheduledChange, andaccountNotification.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Valid Values: issue | accountNotification | scheduledChange | investigation
Required: NoeventTypeCode
The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example,AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 100.
API Version 2016-08-0444
AWS Health API ReferenceSee Also
Pattern: [a-zA-Z0-9\_\-]{3,100}
Required: NolastUpdatedTime
The most recent date and time that the event was updated.
Type: Timestamp
Required: Noregion
The AWS region name of the event.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 25.
Pattern: [^:/]{2,25}
Required: Noservice
The AWS service that is affected by the event. For example, EC2, RDS.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 30.
Pattern: [^:/]{2,30}
Required: NostartTime
The date and time that the event began.
Type: Timestamp
Required: NostatusCode
The most recent status of the event. Possible values are open, closed, and upcoming.
Type: String
Valid Values: open | closed | upcoming
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2016-08-0445
AWS Health API ReferenceEventAccountFilter
EventAccountFilterThe values used to filter results from the DescribeEventDetailsForOrganization (p. 21) andDescribeAffectedEntitiesForOrganization (p. 10) operations.
ContentsawsAccountId
The 12-digit AWS account numbers that contains the affected entities.
Type: String
Length Constraints: Maximum length of 12.
Pattern: ^\S+$
Required: YeseventArn
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
Type: String
Length Constraints: Maximum length of 1600.
Pattern: arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]*:[^:]*:event(?:/[\w-]+){3}
Required: Yes
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2016-08-0447
AWS Health API ReferenceEventAggregate
EventAggregateThe number of events of each issue type. Returned by the DescribeEventAggregates (p. 15) operation.
ContentsaggregateValue
The issue type for the associated count.
Type: String
Required: Nocount
The number of events of the associated issue type.
Type: Integer
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2016-08-0448
AWS Health API ReferenceEventDescription
EventDescriptionThe detailed description of the event. Included in the information returned by theDescribeEventDetails (p. 18) operation.
ContentslatestDescription
The most recent description of the event.
Type: String
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2016-08-0449
AWS Health API ReferenceEventDetails
EventDetailsDetailed information about an event. A combination of an Event (p. 44) object, anEventDescription (p. 49) object, and additional metadata about the event. Returned by theDescribeEventDetails (p. 18) operation.
Contentsevent
Summary information about the event.
Type: Event (p. 44) object
Required: NoeventDescription
The most recent description of the event.
Type: EventDescription (p. 49) object
Required: NoeventMetadata
Additional metadata about the event.
Type: String to string map
Value Length Constraints: Maximum length of 10240.
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2016-08-0450
AWS Health API ReferenceEventDetailsErrorItem
EventDetailsErrorItemError information returned when a DescribeEventDetails (p. 18) operation cannot find a specified event.
ContentserrorMessage
A message that describes the error.
Type: String
Required: NoerrorName
The name of the error.
Type: String
Required: NoeventArn
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
Type: String
Length Constraints: Maximum length of 1600.
Pattern: arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]*:[^:]*:event(?:/[\w-]+){3}
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2016-08-0451
AWS Health API ReferenceEventFilter
EventFilterThe values to use to filter results from the DescribeEvents (p. 24) and DescribeEventAggregates (p. 15)operations.
ContentsavailabilityZones
A list of AWS availability zones.
Type: Array of strings
Length Constraints: Minimum length of 6. Maximum length of 18.
Pattern: [a-z]{2}\-[0-9a-z\-]{4,16}
Required: NoendTimes
A list of dates and times that the event ended.
Type: Array of DateTimeRange (p. 40) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: NoentityArns
A list of entity ARNs (unique identifiers).
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Maximum length of 1600.
Pattern: .{0,1600}
Required: NoentityValues
A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Maximum length of 256.
Pattern: .{0,256}
Required: NoeventArns
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"
API Version 2016-08-0452
AWS Health API ReferenceContents
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Maximum length of 1600.
Pattern: arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]*:[^:]*:event(?:/[\w-]+){3}
Required: NoeventStatusCodes
A list of event status codes.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 6 items.
Valid Values: open | closed | upcoming
Required: NoeventTypeCategories
A list of event type category codes (issue, scheduledChange, or accountNotification).
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 3. Maximum length of 255.
Valid Values: issue | accountNotification | scheduledChange | investigation
Required: NoeventTypeCodes
A list of unique identifiers for event types. For example,"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 3. Maximum length of 100.
Pattern: [^:/]{3,100}
Required: NolastUpdatedTimes
A list of dates and times that the event was last updated.
Type: Array of DateTimeRange (p. 40) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Noregions
A list of AWS regions.
Type: Array of strings
API Version 2016-08-0453
AWS Health API ReferenceSee Also
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 2. Maximum length of 25.
Pattern: [^:/]{2,25}
Required: Noservices
The AWS services associated with the event. For example, EC2, RDS.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 2. Maximum length of 30.
Pattern: [^:/]{2,30}
Required: NostartTimes
A list of dates and times that the event began.
Type: Array of DateTimeRange (p. 40) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Notags
A map of entity tags attached to the affected entity.
Type: Array of string to string maps
Array Members: Maximum number of 50 items.
Key Length Constraints: Maximum length of 127.
Key Pattern: .{0,127}
Value Length Constraints: Maximum length of 255.
Value Pattern: .{0,255}
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2016-08-0454
AWS Health API ReferenceEventType
EventTypeMetadata 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).
Contentscategory
A list of event type category codes (issue, scheduledChange, or accountNotification).
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Valid Values: issue | accountNotification | scheduledChange | investigation
Required: Nocode
The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example,AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 100.
Pattern: [a-zA-Z0-9\_\-]{3,100}
Required: Noservice
The AWS service that is affected by the event. For example, EC2, RDS.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 30.
Pattern: [^:/]{2,30}
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2016-08-0455
AWS Health API ReferenceEventTypeFilter
EventTypeFilterThe values to use to filter results from the DescribeEventTypes (p. 31) operation.
ContentseventTypeCategories
A list of event type category codes (issue, scheduledChange, or accountNotification).
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 3. Maximum length of 255.
Valid Values: issue | accountNotification | scheduledChange | investigation
Required: NoeventTypeCodes
A list of event type codes.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 3. Maximum length of 100.
Pattern: [a-zA-Z0-9\_\-]{3,100}
Required: Noservices
The AWS services associated with the event. For example, EC2, RDS.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 2. Maximum length of 30.
Pattern: [^:/]{2,30}
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2016-08-0456
AWS Health API ReferenceOrganizationAffectedEntitiesErrorItem
OrganizationAffectedEntitiesErrorItemError information returned when a DescribeAffectedEntitiesForOrganization (p. 10) operation cannotfind or process a specific entity.
ContentsawsAccountId
The 12-digit AWS account numbers that contains the affected entities.
Type: String
Length Constraints: Maximum length of 12.
Pattern: ^\S+$
Required: NoerrorMessage
The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION. For example,AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
Type: String
Required: NoerrorName
The name of the error.
Type: String
Required: NoeventArn
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
Type: String
Length Constraints: Maximum length of 1600.
Pattern: arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]*:[^:]*:event(?:/[\w-]+){3}
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2016-08-0457
AWS Health API ReferenceOrganizationEvent
OrganizationEventSummary information about an event, returned by the DescribeEventsForOrganization (p. 28) operation.
Contentsarn
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
Type: String
Length Constraints: Maximum length of 1600.
Pattern: arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]*:[^:]*:event(?:/[\w-]+){3}
Required: NoendTime
The date and time that the event ended.
Type: Timestamp
Required: NoeventTypeCategory
The category of the event type.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Valid Values: issue | accountNotification | scheduledChange | investigation
Required: NoeventTypeCode
The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION. For example,AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 100.
Pattern: [a-zA-Z0-9\_\-]{3,100}
Required: NolastUpdatedTime
The most recent date and time that the event was updated.
Type: Timestamp
Required: No
API Version 2016-08-0459
AWS Health API ReferenceSee Also
region
The AWS Region name of the event.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 25.
Pattern: [^:/]{2,25}
Required: Noservice
The AWS service that is affected by the event. For example, EC2, RDS.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 30.
Pattern: [^:/]{2,30}
Required: NostartTime
The date and time that the event began.
Type: Timestamp
Required: NostatusCode
The most recent status of the event. Possible values are open, closed, and upcoming.
Type: String
Valid Values: open | closed | upcoming
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2016-08-0460
AWS Health API ReferenceOrganizationEventDetails
OrganizationEventDetailsDetailed information about an event. A combination of an Event (p. 44) object, anEventDescription (p. 49) object, and additional metadata about the event. Returned by theDescribeEventDetailsForOrganization (p. 21) operation.
ContentsawsAccountId
The 12-digit AWS account numbers that contains the affected entities.
Type: String
Length Constraints: Maximum length of 12.
Pattern: ^\S+$
Required: Noevent
Summary information about an AWS Health event.
Type: Event (p. 44) object
Required: NoeventDescription
The detailed description of the event. Included in the information returned by theDescribeEventDetails (p. 18) operation.
Type: EventDescription (p. 49) object
Required: NoeventMetadata
Additional metadata about the event.
Type: String to string map
Value Length Constraints: Maximum length of 10240.
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2016-08-0461
AWS Health API ReferenceOrganizationEventDetailsErrorItem
OrganizationEventDetailsErrorItemError information returned when a DescribeEventDetailsForOrganization (p. 21) operation cannot find aspecified event.
ContentsawsAccountId
Error information returned when a DescribeEventDetailsForOrganization (p. 21) operation cannotfind a specified event.
Type: String
Length Constraints: Maximum length of 12.
Pattern: ^\S+$
Required: NoerrorMessage
A message that describes the error.
Type: String
Required: NoerrorName
The name of the error.
Type: String
Required: NoeventArn
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
Type: String
Length Constraints: Maximum length of 1600.
Pattern: arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]*:[^:]*:event(?:/[\w-]+){3}
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2016-08-0462
AWS Health API ReferenceOrganizationEventFilter
OrganizationEventFilterThe values to filter results from the DescribeEventsForOrganization (p. 28) operation.
ContentsawsAccountIds
A list of 12-digit AWS account numbers that contains the affected entities.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Length Constraints: Maximum length of 12.
Pattern: ^\S+$
Required: NoendTime
A range of dates and times that is used by the EventFilter (p. 52) and EntityFilter (p. 42) objects.If from is set and to is set: match items where the timestamp (startTime, endTime, orlastUpdatedTime) is between from and to inclusive. If from is set and to is not set: match itemswhere the timestamp value is equal to or after from. If from is not set and to is set: match itemswhere the timestamp value is equal to or before to.
Type: DateTimeRange (p. 40) object
Required: NoentityArns
A list of entity ARNs (unique identifiers).
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Maximum length of 1600.
Pattern: .{0,1600}
Required: NoentityValues
A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Maximum length of 256.
Pattern: .{0,256}
Required: NoeventStatusCodes
A list of event status codes.
API Version 2016-08-0464
AWS Health API ReferenceContents
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 6 items.
Valid Values: open | closed | upcoming
Required: NoeventTypeCategories
A list of event type category codes (issue, scheduledChange, or accountNotification).
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 3. Maximum length of 255.
Valid Values: issue | accountNotification | scheduledChange | investigation
Required: NoeventTypeCodes
A list of unique identifiers for event types. For example,"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 3. Maximum length of 100.
Pattern: [^:/]{3,100}
Required: NolastUpdatedTime
A range of dates and times that is used by the EventFilter (p. 52) and EntityFilter (p. 42) objects.If from is set and to is set: match items where the timestamp (startTime, endTime, orlastUpdatedTime) is between from and to inclusive. If from is set and to is not set: match itemswhere the timestamp value is equal to or after from. If from is not set and to is set: match itemswhere the timestamp value is equal to or before to.
Type: DateTimeRange (p. 40) object
Required: Noregions
A list of AWS Regions.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 2. Maximum length of 25.
Pattern: [^:/]{2,25}
Required: Noservices
The AWS services associated with the event. For example, EC2, RDS.
API Version 2016-08-0465
AWS Health API ReferenceSee Also
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 2. Maximum length of 30.
Pattern: [^:/]{2,30}
Required: NostartTime
A range of dates and times that is used by the EventFilter (p. 52) and EntityFilter (p. 42) objects.If from is set and to is set: match items where the timestamp (startTime, endTime, orlastUpdatedTime) is between from and to inclusive. If from is set and to is not set: match itemswhere the timestamp value is equal to or after from. If from is not set and to is set: match itemswhere the timestamp value is equal to or before to.
Type: DateTimeRange (p. 40) object
Required: No
See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3
API Version 2016-08-0466
AWS Health API Reference
Common ParametersThe following list contains the parameters that all actions use for signing Signature Version 4 requestswith a query string. Any action-specific parameters are listed in the topic for that action. For moreinformation about Signature Version 4, see Signature Version 4 Signing Process in the Amazon WebServices General Reference.
Action
The action to be performed.
Type: string
Required: YesVersion
The API version that the request is written for, expressed in the format YYYY-MM-DD.
Type: string
Required: YesX-Amz-Algorithm
The hash algorithm that you used to create the request signature.
Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.
Type: string
Valid Values: AWS4-HMAC-SHA256
Required: ConditionalX-Amz-Credential
The credential scope value, which is a string that includes your access key, the date, the region youare targeting, the service you are requesting, and a termination string ("aws4_request"). The value isexpressed in the following format: access_key/YYYYMMDD/region/service/aws4_request.
For more information, see Task 2: Create a String to Sign for Signature Version 4 in the Amazon WebServices General Reference.
Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.
Type: string
Required: ConditionalX-Amz-Date
The date that is used to create the signature. The format must be ISO 8601 basic format(YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value:20120325T120000Z.
Condition: X-Amz-Date is optional for all requests; it can be used to override the date used forsigning requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is
API Version 2016-08-0467
AWS Health API Reference
not required. When X-Amz-Date is used, it always overrides the value of the Date header. Formore information, see Handling Dates in Signature Version 4 in the Amazon Web Services GeneralReference.
Type: string
Required: ConditionalX-Amz-Security-Token
The temporary security token that was obtained through a call to AWS Security Token Service (AWSSTS). For a list of services that support temporary security credentials from AWS Security TokenService, go to AWS Services That Work with IAM in the IAM User Guide.
Condition: If you're using temporary security credentials from the AWS Security Token Service, youmust include the security token.
Type: string
Required: ConditionalX-Amz-Signature
Specifies the hex-encoded signature that was calculated from the string to sign and the derivedsigning key.
Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.
Type: string
Required: ConditionalX-Amz-SignedHeaders
Specifies all the HTTP headers that were included as part of the canonical request. For moreinformation about specifying signed headers, see Task 1: Create a Canonical Request For SignatureVersion 4 in the Amazon Web Services General Reference.
Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.
Type: string
Required: Conditional
API Version 2016-08-0468
AWS Health API Reference
Common ErrorsThis section lists the errors common to the API actions of all AWS services. For errors specific to an APIaction for this service, see the topic for that API action.
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 400IncompleteSignature
The request signature does not conform to AWS standards.
HTTP Status Code: 400InternalFailure
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500InvalidAction
The action or operation requested is invalid. Verify that the action is typed correctly.
HTTP Status Code: 400InvalidClientTokenId
The X.509 certificate or AWS access key ID provided does not exist in our records.
HTTP Status Code: 403InvalidParameterCombination
Parameters that must not be used together were used together.
HTTP Status Code: 400InvalidParameterValue
An invalid or out-of-range value was supplied for the input parameter.
HTTP Status Code: 400InvalidQueryParameter
The AWS query string is malformed or does not adhere to AWS standards.
HTTP Status Code: 400MalformedQueryString
The query string contains a syntax error.
HTTP Status Code: 404MissingAction
The request is missing an action or a required parameter.
HTTP Status Code: 400
API Version 2016-08-0469
AWS Health API Reference
MissingAuthenticationToken
The request must contain either a valid (registered) AWS access key ID or X.509 certificate.
HTTP Status Code: 403MissingParameter
A required parameter for the specified action is not supplied.
HTTP Status Code: 400OptInRequired
The AWS access key ID needs a subscription for the service.
HTTP Status Code: 403RequestExpired
The request reached the service more than 15 minutes after the date stamp on the request or morethan 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stampon the request is more than 15 minutes in the future.
HTTP Status Code: 400ServiceUnavailable
The request has failed due to a temporary failure of the server.
HTTP Status Code: 503ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400ValidationError
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
API Version 2016-08-0470