|
570 | 570 | "CanarySettings$percentTraffic": "<p>The percent (0-100) of traffic diverted to a canary deployment.</p>", |
571 | 571 | "DeploymentCanarySettings$percentTraffic": "<p>The percentage (0.0-100.0) of traffic routed to the canary deployment.</p>", |
572 | 572 | "MethodSetting$throttlingRateLimit": "<p>Specifies the throttling rate limit. The PATCH path for this setting is <code>/{method_setting_key}/throttling/rateLimit</code>, and the value is a double.</p>", |
573 | | - "ThrottleSettings$rateLimit": "<p>The API request steady-state rate limit.</p>" |
| 573 | + "ThrottleSettings$rateLimit": "<p>The API target request rate limit.</p>" |
574 | 574 | } |
575 | 575 | }, |
576 | 576 | "EndpointConfiguration": { |
|
880 | 880 | "Integration$timeoutInMillis": "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.</p>", |
881 | 881 | "MethodSetting$throttlingBurstLimit": "<p>Specifies the throttling burst limit. The PATCH path for this setting is <code>/{method_setting_key}/throttling/burstLimit</code>, and the value is an integer.</p>", |
882 | 882 | "MethodSetting$cacheTtlInSeconds": "<p>Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is <code>/{method_setting_key}/caching/ttlInSeconds</code>, and the value is an integer.</p>", |
883 | | - "QuotaSettings$limit": "<p>The maximum number of requests that can be made in a given time period.</p>", |
| 883 | + "QuotaSettings$limit": "<p>The target maximum number of requests that can be made in a given time period.</p>", |
884 | 884 | "QuotaSettings$offset": "<p>The day that a time period starts. For example, with a time period of <code>WEEK</code>, an offset of <code>0</code> starts on Sunday, and an offset of <code>1</code> starts on Monday.</p>", |
885 | 885 | "TestInvokeAuthorizerResponse$clientStatus": "<p>The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.</p>", |
886 | 886 | "TestInvokeMethodResponse$status": "<p>The HTTP status code.</p>", |
887 | | - "ThrottleSettings$burstLimit": "<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>" |
| 887 | + "ThrottleSettings$burstLimit": "<p>The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.</p>" |
888 | 888 | } |
889 | 889 | }, |
890 | 890 | "Integration": { |
|
1408 | 1408 | "base": "<p>Quotas configured for a usage plan.</p>", |
1409 | 1409 | "refs": { |
1410 | 1410 | "CreateUsagePlanRequest$quota": "<p>The quota of the usage plan.</p>", |
1411 | | - "UsagePlan$quota": "<p>The maximum number of permitted requests per a given unit time interval.</p>" |
| 1411 | + "UsagePlan$quota": "<p>The target maximum number of permitted requests per a given unit time interval.</p>" |
1412 | 1412 | } |
1413 | 1413 | }, |
1414 | 1414 | "RequestValidator": { |
|
1994 | 1994 | "Account$throttleSettings": "<p>Specifies the API request limits configured for the current <a>Account</a>.</p>", |
1995 | 1995 | "CreateUsagePlanRequest$throttle": "<p>The throttling limits of the usage plan.</p>", |
1996 | 1996 | "MapOfApiStageThrottleSettings$value": null, |
1997 | | - "UsagePlan$throttle": "<p>The request throttle limits of a usage plan.</p>" |
| 1997 | + "UsagePlan$throttle": "<p>Map containing method level throttling information for API stage in a usage plan.</p>" |
1998 | 1998 | } |
1999 | 1999 | }, |
2000 | 2000 | "Timestamp": { |
|
2156 | 2156 | } |
2157 | 2157 | }, |
2158 | 2158 | "UsagePlan": { |
2159 | | - "base": "<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>", |
| 2159 | + "base": "<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>", |
2160 | 2160 | "refs": { |
2161 | 2161 | "ListOfUsagePlan$member": null |
2162 | 2162 | } |
|
0 commit comments