Skip to content

Commit ee32c57

Browse files
author
AWS
committed
Amazon API Gateway Update: Documentation updates for Amazon API Gateway
1 parent 38c7bda commit ee32c57

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed
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 API Gateway",
4+
"contributor": "",
5+
"description": "Documentation updates for Amazon API Gateway"
6+
}

services/apigateway/src/main/resources/codegen-resources/service-2.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5936,7 +5936,7 @@
59365936
"members":{
59375937
"limit":{
59385938
"shape":"Integer",
5939-
"documentation":"<p>The maximum number of requests that can be made in a given time period.</p>"
5939+
"documentation":"<p>The target maximum number of requests that can be made in a given time period.</p>"
59405940
},
59415941
"offset":{
59425942
"shape":"Integer",
@@ -6505,11 +6505,11 @@
65056505
"members":{
65066506
"burstLimit":{
65076507
"shape":"Integer",
6508-
"documentation":"<p>The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.</p>"
6508+
"documentation":"<p>The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.</p>"
65096509
},
65106510
"rateLimit":{
65116511
"shape":"Double",
6512-
"documentation":"<p>The API request steady-state rate limit.</p>"
6512+
"documentation":"<p>The API target request rate limit.</p>"
65136513
}
65146514
},
65156515
"documentation":"<p> The API request rate limits.</p>"
@@ -7166,11 +7166,11 @@
71667166
},
71677167
"throttle":{
71687168
"shape":"ThrottleSettings",
7169-
"documentation":"<p>The request throttle limits of a usage plan.</p>"
7169+
"documentation":"<p>Map containing method level throttling information for API stage in a usage plan.</p>"
71707170
},
71717171
"quota":{
71727172
"shape":"QuotaSettings",
7173-
"documentation":"<p>The maximum number of permitted requests per a given unit time interval.</p>"
7173+
"documentation":"<p>The target maximum number of permitted requests per a given unit time interval.</p>"
71747174
},
71757175
"productCode":{
71767176
"shape":"String",
@@ -7181,7 +7181,7 @@
71817181
"documentation":"<p>The collection of tags. Each tag element is associated with a given resource.</p>"
71827182
}
71837183
},
7184-
"documentation":"<p>Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.</p> <div class=\"remarks\"> <p>In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan. </p> </div> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html\">Create and Use Usage Plans</a> </div>"
7184+
"documentation":"<p>Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using <a href=\"https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html\">AWS Budgets</a> to monitor costs and <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF</a> to manage API requests.</p> <div class=\"remarks\"> <p>In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan. </p> </div> <div class=\"seeAlso\"> <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html\">Create and Use Usage Plans</a> </div>"
71857185
},
71867186
"UsagePlanKey":{
71877187
"type":"structure",

0 commit comments

Comments
 (0)