Skip to content

Commit 90102ec

Browse files
author
AWS
committed
AWS Health APIs and Notifications Update: Adds actionability and personas properties to Health events exposed through DescribeEvents, DescribeEventsForOrganization, DescribeEventDetails, and DescribeEventTypes APIs. Adds filtering by actionabilities and personas in EventFilter, OrganizationEventFilter, EventTypeFilter.
1 parent 9815aa8 commit 90102ec

File tree

2 files changed

+111
-1
lines changed

2 files changed

+111
-1
lines changed

‎.changes/next-release/feature-AWSHealthAPIsandNotifications-e34e271.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS Health APIs and Notifications",
4+
"contributor": "",
5+
"description": "Adds actionability and personas properties to Health events exposed through DescribeEvents, DescribeEventsForOrganization, DescribeEventDetails, and DescribeEventTypes APIs. Adds filtering by actionabilities and personas in EventFilter, OrganizationEventFilter, EventTypeFilter."
6+
}

‎services/health/src/main/resources/codegen-resources/service-2.json‎

Lines changed: 105 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@
255255
},
256256
"statusCode":{
257257
"shape":"entityStatusCode",
258-
"documentation":"<p>The most recent status of the entity affected by the event. The possible values are <code>IMPAIRED</code>, <code>UNIMPAIRED</code>, and <code>UNKNOWN</code>.</p>"
258+
"documentation":"<p>The most recent status of the entity affected by the event. The possible values are <code>IMPAIRED</code>, <code>UNIMPAIRED</code>, <code>UNKNOWN</code>, <code>PENDING</code>, and <code>RESOLVED</code>.</p>"
259259
},
260260
"tags":{
261261
"shape":"tagSet",
@@ -787,6 +787,14 @@
787787
"eventScopeCode":{
788788
"shape":"eventScopeCode",
789789
"documentation":"<p>This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.</p> <ul> <li> <p>If the <code>eventScopeCode</code> value is <code>PUBLIC</code>, then the <code>affectedAccounts</code> value is always empty.</p> </li> <li> <p>If the <code>eventScopeCode</code> value is <code>ACCOUNT_SPECIFIC</code>, then the <code>affectedAccounts</code> value lists the affected Amazon Web Services accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have Amazon Web Services accounts that use that service, those account IDs appear in the response.</p> </li> <li> <p>If the <code>eventScopeCode</code> value is <code>NONE</code>, then the <code>eventArn</code> that you specified in the request is invalid or doesn't exist.</p> </li> </ul>"
790+
},
791+
"actionability":{
792+
"shape":"EventActionability",
793+
"documentation":"<p>The actionability classification of the event. Possible values are <code>ACTION_REQUIRED</code>, <code>ACTION_MAY_BE_REQUIRED</code> and <code>INFORMATIONAL</code>. Events with <code>ACTION_REQUIRED</code> actionability require customer action to resolve or mitigate the event. Events with <code>ACTION_MAY_BE_REQUIRED</code> actionability indicates that the current status is unknown or conditional and inspection is needed to determine if action is required. Events with <code>INFORMATIONAL</code> actionability are provided for awareness and do not require immediate action.</p>"
794+
},
795+
"personas":{
796+
"shape":"EventPersonaList",
797+
"documentation":"<p>A list of persona classifications that indicate the target audience for the event. Possible values are <code>OPERATIONS</code>, <code>SECURITY</code>, and <code>BILLING</code>. Events can be associated with multiple personas to indicate relevance to different teams or roles within an organization.</p>"
790798
}
791799
},
792800
"documentation":"<p>Summary information about an Health event.</p> <p>Health events can be public or account-specific:</p> <ul> <li> <p> <i>Public events</i> might be service events that are not specific to an Amazon Web Services account. For example, if there is an issue with an Amazon Web Services Region, Health provides information about the event, even if you don't use services or resources in that Region.</p> </li> <li> <p> <i>Account-specific</i> events are specific to either your Amazon Web Services account or an account in your organization. For example, if there's an issue with Amazon Elastic Compute Cloud in a Region that you use, Health provides information about the event and the affected resources in the account.</p> </li> </ul> <p>You can determine if an event is public or account-specific by using the <code>eventScopeCode</code> parameter. For more information, see <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode\">eventScopeCode</a>.</p>"
@@ -806,6 +814,20 @@
806814
},
807815
"documentation":"<p>The values used to filter results from the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html\">DescribeEventDetailsForOrganization</a> and <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html\">DescribeAffectedEntitiesForOrganization</a> operations.</p>"
808816
},
817+
"EventActionability":{
818+
"type":"string",
819+
"enum":[
820+
"ACTION_REQUIRED",
821+
"ACTION_MAY_BE_REQUIRED",
822+
"INFORMATIONAL"
823+
]
824+
},
825+
"EventActionabilityList":{
826+
"type":"list",
827+
"member":{"shape":"EventActionability"},
828+
"max":3,
829+
"min":1
830+
},
809831
"EventAggregate":{
810832
"type":"structure",
811833
"members":{
@@ -879,6 +901,10 @@
879901
"EventFilter":{
880902
"type":"structure",
881903
"members":{
904+
"actionabilities":{
905+
"shape":"EventActionabilityList",
906+
"documentation":"<p>A list of actionability values to filter events. Use this to filter events based on whether they require action (<code>ACTION_REQUIRED</code>), may require action (<code>ACTION_MAY_BE_REQUIRED</code>) or are informational (<code>INFORMATIONAL</code>).</p>"
907+
},
882908
"eventArns":{
883909
"shape":"eventArnList",
884910
"documentation":"<p>A list of event ARNs (unique identifiers). For example: <code>\"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\"</code> </p>"
@@ -930,6 +956,10 @@
930956
"eventStatusCodes":{
931957
"shape":"eventStatusCodeList",
932958
"documentation":"<p>A list of event status codes.</p>"
959+
},
960+
"personas":{
961+
"shape":"EventPersonaList",
962+
"documentation":"<p>A list of persona values to filter events. Use this to filter events based on their target audience: <code>OPERATIONS</code>, <code>SECURITY</code>, or <code>BILLING</code>.</p>"
933963
}
934964
},
935965
"documentation":"<p>The values to use to filter results from the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html\">DescribeEvents</a> and <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventAggregates.html\">DescribeEventAggregates</a> operations.</p>"
@@ -938,6 +968,20 @@
938968
"type":"list",
939969
"member":{"shape":"Event"}
940970
},
971+
"EventPersona":{
972+
"type":"string",
973+
"enum":[
974+
"OPERATIONS",
975+
"SECURITY",
976+
"BILLING"
977+
]
978+
},
979+
"EventPersonaList":{
980+
"type":"list",
981+
"member":{"shape":"EventPersona"},
982+
"max":3,
983+
"min":1
984+
},
941985
"EventType":{
942986
"type":"structure",
943987
"members":{
@@ -952,10 +996,32 @@
952996
"category":{
953997
"shape":"eventTypeCategory",
954998
"documentation":"<p>A list of event type category codes. Possible values are <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently, the <code>investigation</code> value isn't supported at this time.</p>"
999+
},
1000+
"actionability":{
1001+
"shape":"EventTypeActionability",
1002+
"documentation":"<p>The actionability classification of the event. Possible values are <code>ACTION_REQUIRED</code>, <code>ACTION_MAY_BE_REQUIRED</code> and <code>INFORMATIONAL</code>. Events with <code>ACTION_REQUIRED</code> actionability require customer action to resolve or mitigate the event. Events with <code>ACTION_MAY_BE_REQUIRED</code> actionability indicates that the current status is unknown or conditional and inspection is needed to determine if action is required. Events with <code>INFORMATIONAL</code> actionability are provided for awareness and do not require immediate action.</p>"
1003+
},
1004+
"personas":{
1005+
"shape":"EventTypePersonaList",
1006+
"documentation":"<p>A list of persona classifications that indicate the target audience for the event. Possible values are <code>OPERATIONS</code>, <code>SECURITY</code>, and <code>BILLING</code>. Events can be associated with multiple personas to indicate relevance to different teams or roles within an organization.</p>"
9551007
}
9561008
},
9571009
"documentation":"<p>Contains the metadata about a type of event that is reported by Health. The <code>EventType</code> shows the category, service, and the event type code of the event. For example, an <code>issue</code> might be the category, <code>EC2</code> the service, and <code>AWS_EC2_SYSTEM_MAINTENANCE_EVENT</code> the event type code.</p> <p>You can use the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventTypes.html\">DescribeEventTypes</a> API operation to return this information about an event.</p> <p>You can also use the Amazon CloudWatch Events console to create a rule so that you can get notified or take action when Health delivers a specific event to your Amazon Web Services account. For more information, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/cloudwatch-events-health.html\">Monitor for Health events with Amazon CloudWatch Events</a> in the <i>Health User Guide</i>.</p>"
9581010
},
1011+
"EventTypeActionability":{
1012+
"type":"string",
1013+
"enum":[
1014+
"ACTION_REQUIRED",
1015+
"ACTION_MAY_BE_REQUIRED",
1016+
"INFORMATIONAL"
1017+
]
1018+
},
1019+
"EventTypeActionabilityList":{
1020+
"type":"list",
1021+
"member":{"shape":"EventTypeActionability"},
1022+
"max":3,
1023+
"min":1
1024+
},
9591025
"EventTypeCategoryList":{
9601026
"type":"list",
9611027
"member":{"shape":"eventTypeCategory"},
@@ -982,6 +1048,14 @@
9821048
"eventTypeCategories":{
9831049
"shape":"EventTypeCategoryList",
9841050
"documentation":"<p>A list of event type category codes. Possible values are <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently, the <code>investigation</code> value isn't supported at this time.</p>"
1051+
},
1052+
"actionabilities":{
1053+
"shape":"EventTypeActionabilityList",
1054+
"documentation":"<p>A list of actionability values to filter event types. Possible values are <code>ACTION_REQUIRED</code>, <code>ACTION_MAY_BE_REQUIRED</code> and <code>INFORMATIONAL</code>.</p>"
1055+
},
1056+
"personas":{
1057+
"shape":"EventTypePersonaList",
1058+
"documentation":"<p>A list of persona classifications to filter event types. Possible values are <code>OPERATIONS</code>, <code>SECURITY</code>, and <code>BILLING</code>.</p>"
9851059
}
9861060
},
9871061
"documentation":"<p>The values to use to filter results from the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventTypes.html\">DescribeEventTypes</a> operation.</p>"
@@ -990,6 +1064,20 @@
9901064
"type":"list",
9911065
"member":{"shape":"EventType"}
9921066
},
1067+
"EventTypePersona":{
1068+
"type":"string",
1069+
"enum":[
1070+
"OPERATIONS",
1071+
"SECURITY",
1072+
"BILLING"
1073+
]
1074+
},
1075+
"EventTypePersonaList":{
1076+
"type":"list",
1077+
"member":{"shape":"EventTypePersona"},
1078+
"max":3,
1079+
"min":1
1080+
},
9931081
"InvalidPaginationToken":{
9941082
"type":"structure",
9951083
"members":{
@@ -1106,6 +1194,14 @@
11061194
"statusCode":{
11071195
"shape":"eventStatusCode",
11081196
"documentation":"<p>The most recent status of the event. Possible values are <code>open</code>, <code>closed</code>, and <code>upcoming</code>.</p>"
1197+
},
1198+
"actionability":{
1199+
"shape":"EventActionability",
1200+
"documentation":"<p>The actionability classification of the event. Possible values are <code>ACTION_REQUIRED</code>, <code>ACTION_MAY_BE_REQUIRED</code> and <code>INFORMATIONAL</code>. Events with <code>ACTION_REQUIRED</code> actionability require customer action to resolve or mitigate the event. Events with <code>ACTION_MAY_BE_REQUIRED</code> actionability indicates that the current status is unknown or conditional and inspection is needed to determine if action is required. Events with <code>INFORMATIONAL</code> actionability are provided for awareness and do not require immediate action.</p>"
1201+
},
1202+
"personas":{
1203+
"shape":"EventPersonaList",
1204+
"documentation":"<p>A list of persona classifications that indicate the target audience for the event. Possible values are <code>OPERATIONS</code>, <code>SECURITY</code>, and <code>BILLING</code>. Events can be associated with multiple personas to indicate relevance to different teams or roles within an organization.</p>"
11091205
}
11101206
},
11111207
"documentation":"<p>Summary information about an event, returned by the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html\">DescribeEventsForOrganization</a> operation.</p>"
@@ -1163,6 +1259,10 @@
11631259
"OrganizationEventFilter":{
11641260
"type":"structure",
11651261
"members":{
1262+
"actionabilities":{
1263+
"shape":"EventActionabilityList",
1264+
"documentation":"<p>A list of actionability values to filter events. Use this to filter events based on whether they require action (<code>ACTION_REQUIRED</code>), may require action (<code>ACTION_MAY_BE_REQUIRED</code>) or are informational (<code>INFORMATIONAL</code>).</p>"
1265+
},
11661266
"eventTypeCodes":{
11671267
"shape":"eventTypeList",
11681268
"documentation":"<p>A list of unique identifiers for event types. For example, <code>\"AWS_EC2_SYSTEM_MAINTENANCE_EVENT\",\"AWS_RDS_MAINTENANCE_SCHEDULED\".</code> </p>"
@@ -1197,6 +1297,10 @@
11971297
"eventStatusCodes":{
11981298
"shape":"eventStatusCodeList",
11991299
"documentation":"<p>A list of event status codes.</p>"
1300+
},
1301+
"personas":{
1302+
"shape":"EventPersonaList",
1303+
"documentation":"<p>A list of persona values to filter events. Use this to filter events based on their target audience: <code>OPERATIONS</code>, <code>SECURITY</code>, or <code>BILLING</code>.</p>"
12001304
}
12011305
},
12021306
"documentation":"<p>The values to filter results from the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html\">DescribeEventsForOrganization</a> operation.</p>"

0 commit comments

Comments
 (0)