Skip to content

Commit dc524ae

Browse files
Documentation updates for Amazon API Gateway
1 parent ca92b4b commit dc524ae

11 files changed

+20
-15
lines changed

generator/ServiceModels/apigateway/apigateway-2015-07-09.docs.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -807,7 +807,7 @@
807807
"Integer": {
808808
"base": null,
809809
"refs": {
810-
"Integration$timeoutInMillis": "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.</p>",
810+
"Integration$timeoutInMillis": "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. You can increase the default value to longer than 29 seconds for Regional or private APIs only.</p>",
811811
"MethodSetting$throttlingBurstLimit": "<p>Specifies the throttling burst limit.</p>",
812812
"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.</p>",
813813
"QuotaSettings$limit": "<p>The target maximum number of requests that can be made in a given time period.</p>",
@@ -1275,7 +1275,7 @@
12751275
"GetUsagePlansRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
12761276
"GetUsageRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
12771277
"GetVpcLinksRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
1278-
"PutIntegrationRequest$timeoutInMillis": "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.</p>",
1278+
"PutIntegrationRequest$timeoutInMillis": "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. You can increase the default value to longer than 29 seconds for Regional or private APIs only.</p>",
12791279
"RestApi$minimumCompressionSize": "<p>A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.</p>"
12801280
}
12811281
},
@@ -1614,7 +1614,7 @@
16141614
"DocumentationVersions$position": null,
16151615
"DomainName$domainName": "<p>The custom domain name as an API host name, for example, <code>my-api.example.com</code>.</p>",
16161616
"DomainName$domainNameId": "<p>The identifier for the domain name resource. Supported only for private custom domain names.</p>",
1617-
"DomainName$domainNameArn": "<p>The ARN of the domain name. Supported only for private custom domain names. </p>",
1617+
"DomainName$domainNameArn": "<p>The ARN of the domain name. </p>",
16181618
"DomainName$certificateName": "<p>The name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.</p>",
16191619
"DomainName$certificateArn": "<p>The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. Certificate Manager is the only supported source.</p>",
16201620
"DomainName$regionalDomainName": "<p>The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.</p>",

generator/ServiceModels/apigateway/apigateway-2015-07-09.normal.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3769,7 +3769,7 @@
37693769
},
37703770
"domainNameArn":{
37713771
"shape":"String",
3772-
"documentation":"<p>The ARN of the domain name. Supported only for private custom domain names. </p>"
3772+
"documentation":"<p>The ARN of the domain name. </p>"
37733773
},
37743774
"certificateName":{
37753775
"shape":"String",
@@ -5373,7 +5373,7 @@
53735373
},
53745374
"timeoutInMillis":{
53755375
"shape":"Integer",
5376-
"documentation":"<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.</p>"
5376+
"documentation":"<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. You can increase the default value to longer than 29 seconds for Regional or private APIs only.</p>"
53775377
},
53785378
"cacheNamespace":{
53795379
"shape":"String",
@@ -5983,7 +5983,7 @@
59835983
},
59845984
"timeoutInMillis":{
59855985
"shape":"NullableInteger",
5986-
"documentation":"<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.</p>"
5986+
"documentation":"<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. You can increase the default value to longer than 29 seconds for Regional or private APIs only.</p>"
59875987
},
59885988
"tlsConfig":{"shape":"TlsConfig"}
59895989
},

sdk/src/Services/APIGateway/Generated/Model/CreateDomainNameResponse.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ internal bool IsSetDistributionHostedZoneId()
160160
/// <summary>
161161
/// Gets and sets the property DomainNameArn.
162162
/// <para>
163-
/// The ARN of the domain name. Supported only for private custom domain names.
163+
/// The ARN of the domain name.
164164
/// </para>
165165
/// </summary>
166166
public string DomainNameArn

sdk/src/Services/APIGateway/Generated/Model/DomainName.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ internal bool IsSetDistributionHostedZoneId()
160160
/// <summary>
161161
/// Gets and sets the property DomainNameArn.
162162
/// <para>
163-
/// The ARN of the domain name. Supported only for private custom domain names.
163+
/// The ARN of the domain name.
164164
/// </para>
165165
/// </summary>
166166
public string DomainNameArn

sdk/src/Services/APIGateway/Generated/Model/GetDomainNameResponse.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ internal bool IsSetDistributionHostedZoneId()
160160
/// <summary>
161161
/// Gets and sets the property DomainNameArn.
162162
/// <para>
163-
/// The ARN of the domain name. Supported only for private custom domain names.
163+
/// The ARN of the domain name.
164164
/// </para>
165165
/// </summary>
166166
public string DomainNameArn

sdk/src/Services/APIGateway/Generated/Model/GetIntegrationResponse.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,8 @@ internal bool IsSetRequestTemplates()
316316
/// Gets and sets the property TimeoutInMillis.
317317
/// <para>
318318
/// Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds
319-
/// or 29 seconds.
319+
/// or 29 seconds. You can increase the default value to longer than 29 seconds for Regional
320+
/// or private APIs only.
320321
/// </para>
321322
/// </summary>
322323
public int? TimeoutInMillis

sdk/src/Services/APIGateway/Generated/Model/Integration.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,8 @@ internal bool IsSetRequestTemplates()
316316
/// Gets and sets the property TimeoutInMillis.
317317
/// <para>
318318
/// Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds
319-
/// or 29 seconds.
319+
/// or 29 seconds. You can increase the default value to longer than 29 seconds for Regional
320+
/// or private APIs only.
320321
/// </para>
321322
/// </summary>
322323
public int? TimeoutInMillis

sdk/src/Services/APIGateway/Generated/Model/PutIntegrationRequest.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,8 @@ internal bool IsSetRestApiId()
334334
/// Gets and sets the property TimeoutInMillis.
335335
/// <para>
336336
/// Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds
337-
/// or 29 seconds.
337+
/// or 29 seconds. You can increase the default value to longer than 29 seconds for Regional
338+
/// or private APIs only.
338339
/// </para>
339340
/// </summary>
340341
public int? TimeoutInMillis

sdk/src/Services/APIGateway/Generated/Model/PutIntegrationResponse.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,8 @@ internal bool IsSetRequestTemplates()
316316
/// Gets and sets the property TimeoutInMillis.
317317
/// <para>
318318
/// Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds
319-
/// or 29 seconds.
319+
/// or 29 seconds. You can increase the default value to longer than 29 seconds for Regional
320+
/// or private APIs only.
320321
/// </para>
321322
/// </summary>
322323
public int? TimeoutInMillis

sdk/src/Services/APIGateway/Generated/Model/UpdateDomainNameResponse.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ internal bool IsSetDistributionHostedZoneId()
160160
/// <summary>
161161
/// Gets and sets the property DomainNameArn.
162162
/// <para>
163-
/// The ARN of the domain name. Supported only for private custom domain names.
163+
/// The ARN of the domain name.
164164
/// </para>
165165
/// </summary>
166166
public string DomainNameArn

0 commit comments

Comments
 (0)