|
210 | 210 | "ExportResponse$body": "<p>The binary blob response to <a>GetExport</a>, which contains the export.</p>", |
211 | 211 | "ImportApiKeysRequest$body": "<p>The payload of the POST request to import API keys. For the payload format, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-key-file-format.html\">API Key File Format</a>.</p>", |
212 | 212 | "ImportDocumentationPartsRequest$body": "<p>[Required] Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.</p>", |
213 | | - "ImportRestApiRequest$body": "<p>[Required] The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 2MB.</p>", |
214 | | - "PutRestApiRequest$body": "<p>[Required] The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 2MB.</p>", |
| 213 | + "ImportRestApiRequest$body": "<p>[Required] The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.</p>", |
| 214 | + "PutRestApiRequest$body": "<p>[Required] The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.</p>", |
215 | 215 | "SdkResponse$body": "<p>The binary blob response to <a>GetSdk</a>, which contains the generated SDK.</p>" |
216 | 216 | } |
217 | 217 | }, |
|
245 | 245 | "SdkConfigurationProperty$required": "<p>A boolean flag of an <a>SdkType</a> configuration property to indicate if the associated SDK configuration property is required (<code>true</code>) or not (<code>false</code>).</p>", |
246 | 246 | "Stage$cacheClusterEnabled": "<p>Specifies whether a cache cluster is enabled for the stage.</p>", |
247 | 247 | "Stage$tracingEnabled": "<p>Specifies whether active tracing with X-ray is enabled for the <a>Stage</a>.</p>", |
248 | | - "TlsConfig$insecureSkipVerification": "<p>Specifies whether API Gateway skips trust chain validation of the server certificate during the TLS handshake. Supported only for <code>HTTP</code> and <code>HTTP_PROXY</code> integrations. By default, API Gateway validates that certificates for integration endpoints are issued by a <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-supported-certificate-authorities-for-http-endpoints.html\">supported Certificate Authority</a>. If enabled, API Gateway skips trust chain validation of the server certificate. This is not recommended, but it enables you to use certificates that are signed by private Certificate Authorities, or certificates that are self-signed.</p>" |
| 248 | + "TlsConfig$insecureSkipVerification": "<p>Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is issued by a <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-supported-certificate-authorities-for-http-endpoints.html\">supported certificate authority</a>. This isn’t recommended, but it enables you to use certificates that are signed by private certificate authorities, or certificates that are self-signed. If enabled, API Gateway still performs basic certificate validation, which includes checking the certificate's expiration date, hostname, and presence of a root certificate authority. Supported only for <code>HTTP</code> and <code>HTTP_PROXY</code> integrations.</p>" |
249 | 249 | } |
250 | 250 | }, |
251 | 251 | "CacheClusterSize": { |
|
1083 | 1083 | "Integration$cacheKeyParameters": "<p>A list of request parameters whose values API Gateway caches. To be valid values for <code>cacheKeyParameters</code>, these parameters must also be specified for <a>Method</a> <code>requestParameters</code>.</p>", |
1084 | 1084 | "MapOfStringToList$value": null, |
1085 | 1085 | "Method$authorizationScopes": "<p>A list of authorization scopes configured on the method. The scopes are used with a <code>COGNITO_USER_POOLS</code> authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.</p>", |
1086 | | - "PutIntegrationRequest$cacheKeyParameters": "<p>An API-specific tag group of related cached parameters.</p>", |
| 1086 | + "PutIntegrationRequest$cacheKeyParameters": "<p>A list of request parameters whose values API Gateway caches. To be valid values for <code>cacheKeyParameters</code>, these parameters must also be specified for <a>Method</a> <code>requestParameters</code>.</p>", |
1087 | 1087 | "PutMethodRequest$authorizationScopes": "<p>A list of authorization scopes configured on the method. The scopes are used with a <code>COGNITO_USER_POOLS</code> authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.</p>", |
1088 | 1088 | "RestApi$warnings": "<p>The warning messages reported when <code>failonwarnings</code> is turned on during API import.</p>", |
1089 | 1089 | "RestApi$binaryMediaTypes": "<p>The list of binary media types supported by the <a>RestApi</a>. By default, the <a>RestApi</a> supports only UTF-8-encoded text payloads.</p>", |
|
1758 | 1758 | "Integration$connectionId": "<p>The (<a href=\"https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id\"><code>id</code></a>) of the <a>VpcLink</a> used for the integration when <code>connectionType=VPC_LINK</code> and undefined, otherwise.</p>", |
1759 | 1759 | "Integration$credentials": "<p>Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string <code>arn:aws:iam::\\*:user/\\*</code>. To use resource-based permissions on supported AWS services, specify null.</p>", |
1760 | 1760 | "Integration$passthroughBehavior": "<div> <p> Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in <code>requestTemplates</code>. The valid value is one of the following: </p> <ul> <li> <code>WHEN_NO_MATCH</code>: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. </li> <li> <code>WHEN_NO_TEMPLATES</code>: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP <code>415 Unsupported Media Type</code> response. </li> <li> <code>NEVER</code>: rejects the method request with an HTTP <code>415 Unsupported Media Type</code> response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request. </li> </ul> </div>", |
1761 | | - "Integration$cacheNamespace": "<p>An API-specific tag group of related cached parameters. To be valid values for <code>cacheKeyParameters</code>, these parameters must also be specified for <a>Method</a> <code>requestParameters</code>.</p>", |
| 1761 | + "Integration$cacheNamespace": "<p>Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the <code>cacheNamespace</code>. You can specify the same <code>cacheNamespace</code> across resources to return the same cached data for requests to different resources.</p>", |
1762 | 1762 | "IntegrationResponse$selectionPattern": "<p>Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the <code>.+</code> regex to match error response. However, make sure that the error response does not contain any newline (<code>\\n</code>) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.</p>", |
1763 | 1763 | "LimitExceededException$retryAfterSeconds": null, |
1764 | 1764 | "LimitExceededException$message": null, |
|
1801 | 1801 | "PutIntegrationRequest$connectionId": "<p>The (<a href=\"https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id\"><code>id</code></a>) of the <a>VpcLink</a> used for the integration when <code>connectionType=VPC_LINK</code> and undefined, otherwise.</p>", |
1802 | 1802 | "PutIntegrationRequest$credentials": "<p>Specifies whether credentials are required for a put integration.</p>", |
1803 | 1803 | "PutIntegrationRequest$passthroughBehavior": "<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the <code>requestTemplates</code> property on the Integration resource. There are three valid values: <code>WHEN_NO_MATCH</code>, <code>WHEN_NO_TEMPLATES</code>, and <code>NEVER</code>. </p> <ul> <li><p><code>WHEN_NO_MATCH</code> passes the request body for unmapped content types through to the integration back end without transformation.</p></li> <li><p><code>NEVER</code> rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.</p></li> <li><p><code>WHEN_NO_TEMPLATES</code> allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.</p></li> </ul>", |
1804 | | - "PutIntegrationRequest$cacheNamespace": "<p>A list of request parameters whose values are to be cached.</p>", |
| 1804 | + "PutIntegrationRequest$cacheNamespace": "<p>Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the <code>cacheNamespace</code>. You can specify the same <code>cacheNamespace</code> across resources to return the same cached data for requests to different resources.</p>", |
1805 | 1805 | "PutIntegrationResponseRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>", |
1806 | 1806 | "PutIntegrationResponseRequest$resourceId": "<p>[Required] Specifies a put integration response request's resource identifier.</p>", |
1807 | 1807 | "PutIntegrationResponseRequest$httpMethod": "<p>[Required] Specifies a put integration response request's HTTP method.</p>", |
|
0 commit comments