Skip to content

Commit 3916643

Browse files
author
AWS
committed
Amazon DocumentDB Elastic Clusters Update: Amazon DocumentDB Elastic Clusters adds support for pending maintenance actions feature with APIs GetPendingMaintenanceAction, ListPendingMaintenanceActions and ApplyPendingMaintenanceAction
1 parent 88abec2 commit 3916643

File tree

3 files changed

+237
-3
lines changed

3 files changed

+237
-3
lines changed

‎.changes/next-release/feature-AmazonDocumentDBElasticClusters-ad88d95.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": "Amazon DocumentDB Elastic Clusters",
4+
"contributor": "",
5+
"description": "Amazon DocumentDB Elastic Clusters adds support for pending maintenance actions feature with APIs GetPendingMaintenanceAction, ListPendingMaintenanceActions and ApplyPendingMaintenanceAction"
6+
}

‎services/docdbelastic/src/main/resources/codegen-resources/paginators-1.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@
1111
"output_token": "nextToken",
1212
"limit_key": "maxResults",
1313
"result_key": "clusters"
14+
},
15+
"ListPendingMaintenanceActions": {
16+
"input_token": "nextToken",
17+
"output_token": "nextToken",
18+
"limit_key": "maxResults",
19+
"result_key": "resourcePendingMaintenanceActions"
1420
}
1521
}
1622
}

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

Lines changed: 225 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,36 @@
55
"endpointPrefix":"docdb-elastic",
66
"jsonVersion":"1.1",
77
"protocol":"rest-json",
8+
"protocols":["rest-json"],
89
"serviceAbbreviation":"DocDB Elastic",
910
"serviceFullName":"Amazon DocumentDB Elastic Clusters",
1011
"serviceId":"DocDB Elastic",
1112
"signatureVersion":"v4",
1213
"signingName":"docdb-elastic",
13-
"uid":"docdb-elastic-2022-11-28"
14+
"uid":"docdb-elastic-2022-11-28",
15+
"auth":["aws.auth#sigv4"]
1416
},
1517
"operations":{
18+
"ApplyPendingMaintenanceAction":{
19+
"name":"ApplyPendingMaintenanceAction",
20+
"http":{
21+
"method":"POST",
22+
"requestUri":"/pending-action",
23+
"responseCode":200
24+
},
25+
"input":{"shape":"ApplyPendingMaintenanceActionInput"},
26+
"output":{"shape":"ApplyPendingMaintenanceActionOutput"},
27+
"errors":[
28+
{"shape":"ThrottlingException"},
29+
{"shape":"ValidationException"},
30+
{"shape":"ConflictException"},
31+
{"shape":"InternalServerException"},
32+
{"shape":"ResourceNotFoundException"},
33+
{"shape":"AccessDeniedException"}
34+
],
35+
"documentation":"<p>The type of pending maintenance action to be applied to the resource.</p>",
36+
"idempotent":true
37+
},
1638
"CopyClusterSnapshot":{
1739
"name":"CopyClusterSnapshot",
1840
"http":{
@@ -151,6 +173,25 @@
151173
],
152174
"documentation":"<p>Returns information about a specific elastic cluster snapshot</p>"
153175
},
176+
"GetPendingMaintenanceAction":{
177+
"name":"GetPendingMaintenanceAction",
178+
"http":{
179+
"method":"GET",
180+
"requestUri":"/pending-action/{resourceArn}",
181+
"responseCode":200
182+
},
183+
"input":{"shape":"GetPendingMaintenanceActionInput"},
184+
"output":{"shape":"GetPendingMaintenanceActionOutput"},
185+
"errors":[
186+
{"shape":"ThrottlingException"},
187+
{"shape":"ValidationException"},
188+
{"shape":"ConflictException"},
189+
{"shape":"InternalServerException"},
190+
{"shape":"ResourceNotFoundException"},
191+
{"shape":"AccessDeniedException"}
192+
],
193+
"documentation":"<p>Retrieves all maintenance actions that are pending.</p>"
194+
},
154195
"ListClusterSnapshots":{
155196
"name":"ListClusterSnapshots",
156197
"http":{
@@ -185,6 +226,23 @@
185226
],
186227
"documentation":"<p>Returns information about provisioned Amazon DocumentDB elastic clusters.</p>"
187228
},
229+
"ListPendingMaintenanceActions":{
230+
"name":"ListPendingMaintenanceActions",
231+
"http":{
232+
"method":"GET",
233+
"requestUri":"/pending-actions",
234+
"responseCode":200
235+
},
236+
"input":{"shape":"ListPendingMaintenanceActionsInput"},
237+
"output":{"shape":"ListPendingMaintenanceActionsOutput"},
238+
"errors":[
239+
{"shape":"ThrottlingException"},
240+
{"shape":"ValidationException"},
241+
{"shape":"InternalServerException"},
242+
{"shape":"AccessDeniedException"}
243+
],
244+
"documentation":"<p>Retrieves a list of all maintenance actions that are pending.</p>"
245+
},
188246
"ListTagsForResource":{
189247
"name":"ListTagsForResource",
190248
"http":{
@@ -334,6 +392,42 @@
334392
},
335393
"exception":true
336394
},
395+
"ApplyPendingMaintenanceActionInput":{
396+
"type":"structure",
397+
"required":[
398+
"applyAction",
399+
"optInType",
400+
"resourceArn"
401+
],
402+
"members":{
403+
"applyAction":{
404+
"shape":"InputString",
405+
"documentation":"<p>The pending maintenance action to apply to the resource.</p> <p>Valid actions are:</p> <ul> <li> <p> <code>ENGINE_UPDATE<i/> </code> </p> </li> <li> <p> <code>ENGINE_UPGRADE</code> </p> </li> <li> <p> <code>SECURITY_UPDATE</code> </p> </li> <li> <p> <code>OS_UPDATE</code> </p> </li> <li> <p> <code>MASTER_USER_PASSWORD_UPDATE</code> </p> </li> </ul>"
406+
},
407+
"applyOn":{
408+
"shape":"InputString",
409+
"documentation":"<p>A specific date to apply the pending maintenance action. Required if opt-in-type is <code>APPLY_ON</code>. Format: <code>yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm</code> </p>"
410+
},
411+
"optInType":{
412+
"shape":"OptInType",
413+
"documentation":"<p>A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type <code>IMMEDIATE</code> can't be undone.</p>"
414+
},
415+
"resourceArn":{
416+
"shape":"InputString",
417+
"documentation":"<p>The Amazon DocumentDB Amazon Resource Name (ARN) of the resource to which the pending maintenance action applies.</p>"
418+
}
419+
}
420+
},
421+
"ApplyPendingMaintenanceActionOutput":{
422+
"type":"structure",
423+
"required":["resourcePendingMaintenanceAction"],
424+
"members":{
425+
"resourcePendingMaintenanceAction":{
426+
"shape":"ResourcePendingMaintenanceAction",
427+
"documentation":"<p>The output of the pending maintenance action being applied.</p>"
428+
}
429+
}
430+
},
337431
"Arn":{
338432
"type":"string",
339433
"max":1011,
@@ -841,6 +935,33 @@
841935
}
842936
}
843937
},
938+
"GetPendingMaintenanceActionInput":{
939+
"type":"structure",
940+
"required":["resourceArn"],
941+
"members":{
942+
"resourceArn":{
943+
"shape":"InputString",
944+
"documentation":"<p>Retrieves pending maintenance actions for a specific Amazon Resource Name (ARN).</p>",
945+
"location":"uri",
946+
"locationName":"resourceArn"
947+
}
948+
}
949+
},
950+
"GetPendingMaintenanceActionOutput":{
951+
"type":"structure",
952+
"required":["resourcePendingMaintenanceAction"],
953+
"members":{
954+
"resourcePendingMaintenanceAction":{
955+
"shape":"ResourcePendingMaintenanceAction",
956+
"documentation":"<p>Provides information about a pending maintenance action for a resource.</p>"
957+
}
958+
}
959+
},
960+
"InputString":{
961+
"type":"string",
962+
"max":256,
963+
"min":1
964+
},
844965
"Integer":{
845966
"type":"integer",
846967
"box":true
@@ -941,6 +1062,43 @@
9411062
}
9421063
}
9431064
},
1065+
"ListPendingMaintenanceActionsInput":{
1066+
"type":"structure",
1067+
"members":{
1068+
"maxResults":{
1069+
"shape":"ListPendingMaintenanceActionsInputMaxResultsInteger",
1070+
"documentation":"<p>The maximum number of results to include in the response. If more records exist than the specified <code>maxResults</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p>",
1071+
"location":"querystring",
1072+
"locationName":"maxResults"
1073+
},
1074+
"nextToken":{
1075+
"shape":"PaginationToken",
1076+
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>maxResults</code>.</p>",
1077+
"location":"querystring",
1078+
"locationName":"nextToken"
1079+
}
1080+
}
1081+
},
1082+
"ListPendingMaintenanceActionsInputMaxResultsInteger":{
1083+
"type":"integer",
1084+
"box":true,
1085+
"max":100,
1086+
"min":1
1087+
},
1088+
"ListPendingMaintenanceActionsOutput":{
1089+
"type":"structure",
1090+
"required":["resourcePendingMaintenanceActions"],
1091+
"members":{
1092+
"nextToken":{
1093+
"shape":"PaginationToken",
1094+
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is displayed, the responses will include only records beyond the marker, up to the value specified by <code>maxResults</code>.</p>"
1095+
},
1096+
"resourcePendingMaintenanceActions":{
1097+
"shape":"ResourcePendingMaintenanceActionList",
1098+
"documentation":"<p>Provides information about a pending maintenance action for a resource.</p>"
1099+
}
1100+
}
1101+
},
9441102
"ListTagsForResourceRequest":{
9451103
"type":"structure",
9461104
"required":["resourceArn"],
@@ -962,14 +1120,58 @@
9621120
}
9631121
}
9641122
},
1123+
"OptInType":{
1124+
"type":"string",
1125+
"enum":[
1126+
"IMMEDIATE",
1127+
"NEXT_MAINTENANCE",
1128+
"APPLY_ON",
1129+
"UNDO_OPT_IN"
1130+
]
1131+
},
9651132
"PaginationToken":{
9661133
"type":"string",
967-
"documentation":"<p>Token or cursor used in paginated operations.</p> <p>When this value is provided as operation input, the service returns results from where the previous response left off. When this value is present in operation output, it indicates that there are more results to retrieve.</p> <p>This should be opaque to not expose implementation details and potentially versioned to allow evolution of pagination strategy.</p>"
1134+
"documentation":"<pre><code>Token or cursor used in paginated operations. When this value is provided as operation input, the service returns results from where the previous response left off. When this value is present in operation output, it indicates that there are more results to retrieve. This should be opaque to not expose implementation details and potentially versioned to allow evolution of pagination strategy. </code></pre>"
9681135
},
9691136
"Password":{
9701137
"type":"string",
9711138
"sensitive":true
9721139
},
1140+
"PendingMaintenanceActionDetails":{
1141+
"type":"structure",
1142+
"required":["action"],
1143+
"members":{
1144+
"action":{
1145+
"shape":"String",
1146+
"documentation":"<p>Displays the specific action of a pending maintenance action.</p>"
1147+
},
1148+
"autoAppliedAfterDate":{
1149+
"shape":"String",
1150+
"documentation":"<p>Displays the date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any <code>NEXT_MAINTENANCE</code> <code>optInType</code> requests are ignored.</p>"
1151+
},
1152+
"currentApplyDate":{
1153+
"shape":"String",
1154+
"documentation":"<p>Displays the effective date when the pending maintenance action is applied to the resource.</p>"
1155+
},
1156+
"description":{
1157+
"shape":"String",
1158+
"documentation":"<p>Displays a description providing more detail about the maintenance action.</p>"
1159+
},
1160+
"forcedApplyDate":{
1161+
"shape":"String",
1162+
"documentation":"<p>Displays the date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any <code>IMMEDIATE</code> <code>optInType</code> requests are ignored.</p>"
1163+
},
1164+
"optInStatus":{
1165+
"shape":"String",
1166+
"documentation":"<p>Displays the type of <code>optInType</code> request that has been received for the resource.</p>"
1167+
}
1168+
},
1169+
"documentation":"<p>Retrieves the details of maintenance actions that are pending.</p>"
1170+
},
1171+
"PendingMaintenanceActionDetailsList":{
1172+
"type":"list",
1173+
"member":{"shape":"PendingMaintenanceActionDetails"}
1174+
},
9731175
"ResourceNotFoundException":{
9741176
"type":"structure",
9751177
"required":[
@@ -998,6 +1200,24 @@
9981200
},
9991201
"exception":true
10001202
},
1203+
"ResourcePendingMaintenanceAction":{
1204+
"type":"structure",
1205+
"members":{
1206+
"pendingMaintenanceActionDetails":{
1207+
"shape":"PendingMaintenanceActionDetailsList",
1208+
"documentation":"<p>Provides information about a pending maintenance action for a resource.</p>"
1209+
},
1210+
"resourceArn":{
1211+
"shape":"String",
1212+
"documentation":"<p>The Amazon DocumentDB Amazon Resource Name (ARN) of the resource to which the pending maintenance action applies.</p>"
1213+
}
1214+
},
1215+
"documentation":"<p>Provides information about a pending maintenance action for a resource.</p>"
1216+
},
1217+
"ResourcePendingMaintenanceActionList":{
1218+
"type":"list",
1219+
"member":{"shape":"ResourcePendingMaintenanceAction"}
1220+
},
10011221
"RestoreClusterFromSnapshotInput":{
10021222
"type":"structure",
10031223
"required":[
@@ -1138,7 +1358,9 @@
11381358
"COPYING",
11391359
"STARTING",
11401360
"STOPPING",
1141-
"STOPPED"
1361+
"STOPPED",
1362+
"MAINTENANCE",
1363+
"INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE"
11421364
]
11431365
},
11441366
"StopClusterInput":{

0 commit comments

Comments
 (0)