Amazon API Gateway Update: Documentation updates for Amazon API Gateway.

Author: AWS

.changes/next-release/feature-AmazonAPIGateway-99b25fd.json

@@ -0,0 +1,5 @@
+{
+    "type": "feature",
+    "category": "Amazon API Gateway",
+    "description": "Documentation updates for Amazon API Gateway."
+}

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

@@ -1995,7 +1995,7 @@
         },
         "destinationArn":{
           "shape":"String",
-          "documentation":"<p>The ARN of the CloudWatch Logs log group to receive access logs.</p>"
+          "documentation":"<p>The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with <code>amazon-apigateway-</code>.</p>"
         }
       },
       "documentation":"<p>Access log settings, including the access log format and access log destination ARN.</p>"
@@ -2364,7 +2364,7 @@
         },
         "generateDistinctId":{
           "shape":"Boolean",
-          "documentation":"<p>Specifies whether (<code>true</code>) or not (<code>false</code>) the key identifier is distinct from the created API key value.</p>"
+          "documentation":"<p>Specifies whether (<code>true</code>) or not (<code>false</code>) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.</p>"
         },
         "value":{
           "shape":"String",
@@ -2461,7 +2461,7 @@
         },
         "stage":{
           "shape":"String",
-          "documentation":"<p>The name of the API's stage that you want to use for this mapping. Specify '(none)' if you do not want callers to explicitly specify the stage name after any base path name.</p>"
+          "documentation":"<p>The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name.</p>"
         }
       },
       "documentation":"<p>Requests API Gateway to create a new <a>BasePathMapping</a> resource.</p>"
@@ -2877,7 +2877,7 @@
         },
         "targetArns":{
           "shape":"ListOfString",
-          "documentation":"<p>[Required] The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.</p>"
+          "documentation":"<p>[Required] The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.</p>"
         },
         "tags":{
           "shape":"MapOfStringToString",
@@ -4693,7 +4693,7 @@
       "members":{
         "resourceArn":{
           "shape":"String",
-          "documentation":"<p>[Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.</p>",
+          "documentation":"<p>[Required] The ARN of a resource that can be tagged.</p>",
           "location":"uri",
           "locationName":"resource_arn"
         },
@@ -5321,7 +5321,7 @@
         },
         "loggingLevel":{
           "shape":"String",
-          "documentation":"<p>Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is <code>/{method_setting_key}/logging/loglevel</code>, and the available levels are <code>OFF</code>, <code>ERROR</code>, and <code>INFO</code>.</p>"
+          "documentation":"<p>Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is <code>/{method_setting_key}/logging/loglevel</code>, and the available levels are <code>OFF</code>, <code>ERROR</code>, and <code>INFO</code>. Choose <code>ERROR</code> to write only error-level entries to CloudWatch Logs, or choose <code>INFO</code> to include all <code>ERROR</code> events as well as extra informational events.</p>"
         },
         "dataTraceEnabled":{
           "shape":"Boolean",
@@ -6162,7 +6162,7 @@
       "members":{
         "resourceArn":{
           "shape":"String",
-          "documentation":"<p>[Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.</p>",
+          "documentation":"<p>[Required] The ARN of a resource that can be tagged.</p>",
           "location":"uri",
           "locationName":"resource_arn"
         },
@@ -6408,7 +6408,7 @@
       "members":{
         "resourceArn":{
           "shape":"String",
-          "documentation":"<p>[Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.</p>",
+          "documentation":"<p>[Required] The ARN of a resource that can be tagged.</p>",
           "location":"uri",
           "locationName":"resource_arn"
         },
@@ -7090,7 +7090,7 @@
         },
         "targetArns":{
           "shape":"ListOfString",
-          "documentation":"<p>The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.</p>"
+          "documentation":"<p>The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.</p>"
         },
         "status":{
           "shape":"VpcLinkStatus",
@@ -7105,7 +7105,7 @@
           "documentation":"<p>The collection of tags. Each tag element is associated with a given resource.</p>"
         }
       },
-      "documentation":"<p>A API Gateway VPC link for a <a>RestApi</a> to access resources in an Amazon Virtual Private Cloud (VPC).</p> <div class=\"remarks\"> <p><p>To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a <a>VpcLink</a> resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the <a>VpcLink</a>. The private integration has an integration type of <code>HTTP</code> or <code>HTTP_PROXY</code> and has a connection type of <code>VPC_LINK</code>. The integration uses the <code>connectionId</code> property to identify the <a>VpcLink</a> used.</p> </p> </div>"
+      "documentation":"<p>An API Gateway VPC link for a <a>RestApi</a> to access resources in an Amazon Virtual Private Cloud (VPC).</p> <div class=\"remarks\"> <p><p>To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a <a>VpcLink</a> resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the <a>VpcLink</a>. The private integration has an integration type of <code>HTTP</code> or <code>HTTP_PROXY</code> and has a connection type of <code>VPC_LINK</code>. The integration uses the <code>connectionId</code> property to identify the <a>VpcLink</a> used.</p> </p> </div>"
     },
     "VpcLinkStatus":{
       "type":"string",