Skip to content

Commit 6d129f9

Browse files
author
AWS
committed
Service Quotas Update: Add support for SQ Dashboard Api
1 parent f77d0ab commit 6d129f9

File tree

2 files changed

+227
-1
lines changed

2 files changed

+227
-1
lines changed

‎.changes/next-release/feature-ServiceQuotas-e7608c4.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": "Service Quotas",
4+
"contributor": "",
5+
"description": "Add support for SQ Dashboard Api"
6+
}

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

Lines changed: 221 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,23 @@
149149
],
150150
"documentation":"<p>Retrieves information about your <a href=\"https://docs.aws.amazon.com/servicequotas/latest/userguide/automatic-management.html\">Service Quotas Automatic Management</a> configuration. Automatic Management monitors your Service Quotas utilization and notifies you before you run out of your allocated quotas.</p>"
151151
},
152+
"GetQuotaUtilizationReport":{
153+
"name":"GetQuotaUtilizationReport",
154+
"http":{
155+
"method":"POST",
156+
"requestUri":"/"
157+
},
158+
"input":{"shape":"GetQuotaUtilizationReportRequest"},
159+
"output":{"shape":"GetQuotaUtilizationReportResponse"},
160+
"errors":[
161+
{"shape":"TooManyRequestsException"},
162+
{"shape":"NoSuchResourceException"},
163+
{"shape":"IllegalArgumentException"},
164+
{"shape":"AccessDeniedException"},
165+
{"shape":"ServiceException"}
166+
],
167+
"documentation":"<p>Retrieves the quota utilization report for your Amazon Web Services account. This operation returns paginated results showing your quota usage across all Amazon Web Services services, sorted by utilization percentage in descending order (highest utilization first).</p> <p>You must first initiate a report using the <code>StartQuotaUtilizationReport</code> operation. The report generation process is asynchronous and may take several seconds to complete. Poll this operation periodically to check the status and retrieve results when the report is ready.</p> <p>Each report contains up to 1,000 quota records per page. Use the <code>NextToken</code> parameter to retrieve additional pages of results. Reports are automatically deleted after 15 minutes.</p>"
168+
},
152169
"GetRequestedServiceQuotaChange":{
153170
"name":"GetRequestedServiceQuotaChange",
154171
"http":{
@@ -390,6 +407,24 @@
390407
],
391408
"documentation":"<p>Starts <a href=\"https://docs.aws.amazon.com/servicequotas/latest/userguide/automatic-management.html\">Service Quotas Automatic Management</a> for an Amazon Web Services account, including notification preferences and excluded quotas configurations. Automatic Management monitors your Service Quotas utilization and notifies you before you run out of your allocated quotas.</p>"
392409
},
410+
"StartQuotaUtilizationReport":{
411+
"name":"StartQuotaUtilizationReport",
412+
"http":{
413+
"method":"POST",
414+
"requestUri":"/"
415+
},
416+
"input":{"shape":"StartQuotaUtilizationReportRequest"},
417+
"output":{"shape":"StartQuotaUtilizationReportResponse"},
418+
"errors":[
419+
{"shape":"TooManyRequestsException"},
420+
{"shape":"NoSuchResourceException"},
421+
{"shape":"IllegalArgumentException"},
422+
{"shape":"AccessDeniedException"},
423+
{"shape":"ServiceException"},
424+
{"shape":"InvalidPaginationTokenException"}
425+
],
426+
"documentation":"<p>Initiates the generation of a quota utilization report for your Amazon Web Services account. This asynchronous operation analyzes your quota usage across all Amazon Web Services services and returns a unique report identifier that you can use to retrieve the results.</p> <p>The report generation process may take several seconds to complete, depending on the number of quotas in your account. Use the <code>GetQuotaUtilizationReport</code> operation to check the status and retrieve the results when the report is ready.</p>"
427+
},
393428
"StopAutoManagement":{
394429
"name":"StopAutoManagement",
395430
"http":{
@@ -492,6 +527,11 @@
492527
"ALL"
493528
]
494529
},
530+
"AppliedValue":{
531+
"type":"double",
532+
"max":10000000000,
533+
"min":0
534+
},
495535
"AssociateServiceQuotaTemplateRequest":{
496536
"type":"structure",
497537
"members":{}
@@ -522,6 +562,11 @@
522562
},
523563
"CustomerServiceEngagementId":{"type":"string"},
524564
"DateTime":{"type":"timestamp"},
565+
"DefaultValue":{
566+
"type":"double",
567+
"max":10000000000,
568+
"min":0
569+
},
525570
"DeleteServiceQuotaIncreaseRequestFromTemplateRequest":{
526571
"type":"structure",
527572
"required":[
@@ -683,6 +728,61 @@
683728
}
684729
}
685730
},
731+
"GetQuotaUtilizationReportRequest":{
732+
"type":"structure",
733+
"required":["ReportId"],
734+
"members":{
735+
"ReportId":{
736+
"shape":"ReportId",
737+
"documentation":"<p>The unique identifier for the quota utilization report. This identifier is returned by the <code>StartQuotaUtilizationReport</code> operation.</p>"
738+
},
739+
"NextToken":{
740+
"shape":"NextToken",
741+
"documentation":"<p>A token that indicates the next page of results to retrieve. This token is returned in the response when there are more results available. Omit this parameter for the first request.</p>"
742+
},
743+
"MaxResults":{
744+
"shape":"MaxResultsUtilization",
745+
"documentation":"<p>The maximum number of results to return per page. The default value is 1,000 and the maximum allowed value is 1,000.</p>"
746+
}
747+
}
748+
},
749+
"GetQuotaUtilizationReportResponse":{
750+
"type":"structure",
751+
"members":{
752+
"ReportId":{
753+
"shape":"ReportId",
754+
"documentation":"<p>The unique identifier for the quota utilization report.</p>"
755+
},
756+
"Status":{
757+
"shape":"ReportStatus",
758+
"documentation":"<p>The current status of the report generation. Possible values are:</p> <ul> <li> <p> <code>PENDING</code> - The report generation is in progress. Retry this operation after a few seconds.</p> </li> <li> <p> <code>IN_PROGRESS</code> - The report is being processed. Continue polling until the status changes to <code>COMPLETED</code>.</p> </li> <li> <p> <code>COMPLETED</code> - The report is ready and quota utilization data is available in the response.</p> </li> <li> <p> <code>FAILED</code> - The report generation failed. Check the <code>ErrorCode</code> and <code>ErrorMessage</code> fields for details.</p> </li> </ul>"
759+
},
760+
"GeneratedAt":{
761+
"shape":"DateTime",
762+
"documentation":"<p>The timestamp when the report was generated, in ISO 8601 format.</p>"
763+
},
764+
"TotalCount":{
765+
"shape":"TotalCount",
766+
"documentation":"<p>The total number of quotas included in the report across all pages.</p>"
767+
},
768+
"Quotas":{
769+
"shape":"QuotaUtilizationInfoList",
770+
"documentation":"<p>A list of quota utilization records, sorted by utilization percentage in descending order. Each record includes the quota code, service code, service name, quota name, namespace, utilization percentage, default value, applied value, and whether the quota is adjustable. Up to 1,000 records are returned per page.</p>"
771+
},
772+
"NextToken":{
773+
"shape":"NextToken",
774+
"documentation":"<p>A token that indicates more results are available. Include this token in the next request to retrieve the next page of results. If this field is not present, you have retrieved all available results.</p>"
775+
},
776+
"ErrorCode":{
777+
"shape":"ReportErrorCode",
778+
"documentation":"<p>An error code indicating the reason for failure when the report status is <code>FAILED</code>. This field is only present when the status is <code>FAILED</code>.</p>"
779+
},
780+
"ErrorMessage":{
781+
"shape":"ReportErrorMessage",
782+
"documentation":"<p>A detailed error message describing the failure when the report status is <code>FAILED</code>. This field is only present when the status is <code>FAILED</code>.</p>"
783+
}
784+
}
785+
},
686786
"GetRequestedServiceQuotaChangeRequest":{
687787
"type":"structure",
688788
"required":["RequestId"],
@@ -1035,6 +1135,11 @@
10351135
"max":100,
10361136
"min":1
10371137
},
1138+
"MaxResultsUtilization":{
1139+
"type":"integer",
1140+
"max":1000,
1141+
"min":1
1142+
},
10381143
"MetricDimensionName":{"type":"string"},
10391144
"MetricDimensionValue":{"type":"string"},
10401145
"MetricDimensionsMapDefinition":{
@@ -1251,11 +1356,91 @@
12511356
"documentation":"<p>Information about the quota period.</p>"
12521357
},
12531358
"QuotaUnit":{"type":"string"},
1359+
"QuotaUtilizationInfo":{
1360+
"type":"structure",
1361+
"members":{
1362+
"QuotaCode":{
1363+
"shape":"QuotaCode",
1364+
"documentation":"<p>The quota identifier.</p>"
1365+
},
1366+
"ServiceCode":{
1367+
"shape":"ServiceCode",
1368+
"documentation":"<p>The service identifier.</p>"
1369+
},
1370+
"QuotaName":{
1371+
"shape":"QuotaName",
1372+
"documentation":"<p>The quota name.</p>"
1373+
},
1374+
"Namespace":{
1375+
"shape":"QuotaMetricNamespace",
1376+
"documentation":"<p>The namespace of the metric used to track quota usage.</p>"
1377+
},
1378+
"Utilization":{
1379+
"shape":"UtilizationPct",
1380+
"documentation":"<p>The utilization percentage of the quota, calculated as (current usage / applied value) × 100. Values range from 0.0 to 100.0 or higher if usage exceeds the quota limit.</p>"
1381+
},
1382+
"DefaultValue":{
1383+
"shape":"DefaultValue",
1384+
"documentation":"<p>The default value of the quota.</p>"
1385+
},
1386+
"AppliedValue":{
1387+
"shape":"AppliedValue",
1388+
"documentation":"<p>The applied value of the quota, which may be higher than the default value if a quota increase has been requested and approved.</p>"
1389+
},
1390+
"ServiceName":{
1391+
"shape":"ServiceName",
1392+
"documentation":"<p>The service name.</p>"
1393+
},
1394+
"Adjustable":{
1395+
"shape":"QuotaAdjustable",
1396+
"documentation":"<p>Indicates whether the quota value can be increased.</p>"
1397+
}
1398+
},
1399+
"documentation":"<p>Information about a quota's utilization, including the quota code, service information, current usage, and applied limits.</p>"
1400+
},
1401+
"QuotaUtilizationInfoList":{
1402+
"type":"list",
1403+
"member":{"shape":"QuotaUtilizationInfo"},
1404+
"max":1000
1405+
},
12541406
"QuotaValue":{
12551407
"type":"double",
12561408
"max":10000000000,
12571409
"min":0
12581410
},
1411+
"ReportErrorCode":{
1412+
"type":"string",
1413+
"max":128,
1414+
"min":1,
1415+
"pattern":"[a-zA-Z][a-zA-Z0-9]*"
1416+
},
1417+
"ReportErrorMessage":{
1418+
"type":"string",
1419+
"max":1024,
1420+
"min":0,
1421+
"pattern":"^.*$"
1422+
},
1423+
"ReportId":{
1424+
"type":"string",
1425+
"max":128,
1426+
"min":1,
1427+
"pattern":"[0-9a-zA-Z][a-zA-Z0-9-]{1,128}"
1428+
},
1429+
"ReportMessage":{
1430+
"type":"string",
1431+
"max":350,
1432+
"min":0,
1433+
"pattern":"^.{0,350}$"
1434+
},
1435+
"ReportStatus":{
1436+
"type":"string",
1437+
"enum":[
1438+
"PENDING",
1439+
"IN_PROGRESS",
1440+
"COMPLETED",
1441+
"FAILED"
1442+
]
1443+
},
12591444
"RequestId":{
12601445
"type":"string",
12611446
"max":128,
@@ -1313,13 +1498,21 @@
13131498
"INVALID_REQUEST"
13141499
]
13151500
},
1501+
"RequestType":{
1502+
"type":"string",
1503+
"enum":["AutomaticManagement"]
1504+
},
13161505
"RequestedServiceQuotaChange":{
13171506
"type":"structure",
13181507
"members":{
13191508
"Id":{
13201509
"shape":"RequestId",
13211510
"documentation":"<p>The unique identifier.</p>"
13221511
},
1512+
"RequestType":{
1513+
"shape":"RequestType",
1514+
"documentation":"<p>The type of quota increase request. Possible values include:</p> <ul> <li> <p> <code>AutomaticManagement</code> - The request was automatically created by Service Quotas Automatic Management when quota utilization approached the limit.</p> </li> </ul> <p>If this field is not present, the request was manually created by a user.</p>"
1515+
},
13231516
"CaseId":{
13241517
"shape":"CustomerServiceEngagementId",
13251518
"documentation":"<p>The case ID.</p>"
@@ -1586,6 +1779,27 @@
15861779
"type":"structure",
15871780
"members":{}
15881781
},
1782+
"StartQuotaUtilizationReportRequest":{
1783+
"type":"structure",
1784+
"members":{}
1785+
},
1786+
"StartQuotaUtilizationReportResponse":{
1787+
"type":"structure",
1788+
"members":{
1789+
"ReportId":{
1790+
"shape":"ReportId",
1791+
"documentation":"<p>A unique identifier for the quota utilization report. Use this identifier with the <code>GetQuotaUtilizationReport</code> operation to retrieve the report results.</p>"
1792+
},
1793+
"Status":{
1794+
"shape":"ReportStatus",
1795+
"documentation":"<p>The current status of the report generation. The status will be <code>PENDING</code> when the report is first initiated.</p>"
1796+
},
1797+
"Message":{
1798+
"shape":"ReportMessage",
1799+
"documentation":"<p>An optional message providing additional information about the report generation status. This field may contain details about the report initiation or indicate if an existing recent report is being reused.</p>"
1800+
}
1801+
}
1802+
},
15891803
"Statistic":{
15901804
"type":"string",
15911805
"max":256,
@@ -1684,6 +1898,11 @@
16841898
"documentation":"<p>You've exceeded the number of tags allowed for a resource. For more information, see <a href=\"https://docs.aws.amazon.com/servicequotas/latest/userguide/sq-tagging.html#sq-tagging-restrictions\">Tag restrictions</a> in the <i>Service Quotas User Guide</i>.</p>",
16851899
"exception":true
16861900
},
1901+
"TotalCount":{
1902+
"type":"integer",
1903+
"max":2147483647,
1904+
"min":0
1905+
},
16871906
"UntagResourceRequest":{
16881907
"type":"structure",
16891908
"required":[
@@ -1725,7 +1944,8 @@
17251944
"UpdateAutoManagementResponse":{
17261945
"type":"structure",
17271946
"members":{}
1728-
}
1947+
},
1948+
"UtilizationPct":{"type":"double"}
17291949
},
17301950
"documentation":"<p>With Service Quotas, you can view and manage your quotas easily as your Amazon Web Services workloads grow. Quotas, also referred to as limits, are the maximum number of resources that you can create in your Amazon Web Services account. For more information, see the <a href=\"https://docs.aws.amazon.com/servicequotas/latest/userguide/\">Service Quotas User Guide</a>.</p> <p>You need Amazon Web Services CLI version 2.13.20 or higher to view and manage resource-level quotas such as <code>Instances per domain</code> for Amazon OpenSearch Service.</p>"
17311951
}

0 commit comments

Comments
 (0)