vendor: update all dependencies
* Update all dependencies * Remove all `[[constraint]]` from Gopkg.toml * Add in the minimum number of `[[override]]` to build * Remove go get of github.com/inconshreveable/mousetrap as it is vendored * Update docs with new policy on constraints
This commit is contained in:
Nick Craig-Wood
parent
21383877df
commit
6427029c4e
4902 changed files with 1443417 additions and 227283 deletions
6
vendor/github.com/aws/aws-sdk-go/models/apis/apigateway/2015-07-09/api-2.json
generated
vendored
6
vendor/github.com/aws/aws-sdk-go/models/apis/apigateway/2015-07-09/api-2.json
generated
vendored
|
|
@ -2264,7 +2264,8 @@
|
|||
"binaryMediaTypes":{"shape":"ListOfString"},
|
||||
"minimumCompressionSize":{"shape":"NullableInteger"},
|
||||
"apiKeySource":{"shape":"ApiKeySourceType"},
|
||||
"endpointConfiguration":{"shape":"EndpointConfiguration"}
|
||||
"endpointConfiguration":{"shape":"EndpointConfiguration"},
|
||||
"policy":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"CreateStageRequest":{
|
||||
|
|
@ -4568,7 +4569,8 @@
|
|||
"binaryMediaTypes":{"shape":"ListOfString"},
|
||||
"minimumCompressionSize":{"shape":"NullableInteger"},
|
||||
"apiKeySource":{"shape":"ApiKeySourceType"},
|
||||
"endpointConfiguration":{"shape":"EndpointConfiguration"}
|
||||
"endpointConfiguration":{"shape":"EndpointConfiguration"},
|
||||
"policy":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"RestApis":{
|
||||
|
|
|
|||
452
vendor/github.com/aws/aws-sdk-go/models/apis/apigateway/2015-07-09/docs-2.json
generated
vendored
452
vendor/github.com/aws/aws-sdk-go/models/apis/apigateway/2015-07-09/docs-2.json
generated
vendored
|
|
@ -79,7 +79,7 @@
|
|||
"GetSdkTypes": null,
|
||||
"GetStage": "<p>Gets information about a <a>Stage</a> resource.</p>",
|
||||
"GetStages": "<p>Gets information about one or more <a>Stage</a> resources.</p>",
|
||||
"GetTags": "<p>Gets the Tags collection for a given resource.</p>",
|
||||
"GetTags": "<p>Gets the <a>Tags</a> collection for a given resource.</p>",
|
||||
"GetUsage": "<p>Gets the usage data of a usage plan in a specified time interval.</p>",
|
||||
"GetUsagePlan": "<p>Gets a usage plan of a given plan identifier.</p>",
|
||||
"GetUsagePlanKey": "<p>Gets a usage plan key of a given key identifier.</p>",
|
||||
|
|
@ -96,10 +96,10 @@
|
|||
"PutMethod": "<p>Add a method to an existing <a>Resource</a> resource.</p>",
|
||||
"PutMethodResponse": "<p>Adds a <a>MethodResponse</a> to an existing <a>Method</a> resource.</p>",
|
||||
"PutRestApi": "<p>A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.</p>",
|
||||
"TagResource": "<p>Adds or updates Tags on a gievn resource.</p>",
|
||||
"TagResource": "<p>Adds or updates a tag on a given resource.</p>",
|
||||
"TestInvokeAuthorizer": "<p>Simulate the execution of an <a>Authorizer</a> in your <a>RestApi</a> with headers, parameters, and an incoming request body.</p> <div class=\"seeAlso\"> <a href=\"http://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html\">Enable custom authorizers</a> </div>",
|
||||
"TestInvokeMethod": "<p>Simulate the execution of a <a>Method</a> in your <a>RestApi</a> with headers, parameters, and an incoming request body.</p>",
|
||||
"UntagResource": "<p>Removes Tags from a given resource.</p>",
|
||||
"UntagResource": "<p>Removes a tag from a given resource.</p>",
|
||||
"UpdateAccount": "<p>Changes information about the current <a>Account</a> resource.</p>",
|
||||
"UpdateApiKey": "<p>Changes information about an <a>ApiKey</a> resource.</p>",
|
||||
"UpdateAuthorizer": "<p>Updates an existing <a>Authorizer</a> resource.</p> <div class=\"seeAlso\"><a href=\"http://docs.aws.amazon.com/cli/latest/reference/apigateway/update-authorizer.html\">AWS CLI</a></div>",
|
||||
|
|
@ -149,8 +149,8 @@
|
|||
"ApiKeySourceType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateRestApiRequest$apiKeySource": "<p>The source of the API key for metring requests according to a usage plan. Valid values are <ul><li><code>HEADER</code> to read the API key from the <code>X-API-Key</code> header of a request. </li><li><code>AUTHORIZER</code> to read the API key from the <code>UsageIdentifierKey</code> from a custom authorizer.</li></ul> </p>",
|
||||
"RestApi$apiKeySource": "<p>The source of the API key for metring requests according to a usage plan. Valid values are <ul><li><code>HEADER</code> to read the API key from the <code>X-API-Key</code> header of a request. </li><li><code>AUTHORIZER</code> to read the API key from the <code>UsageIdentifierKey</code> from a custom authorizer.</li></ul> </p>"
|
||||
"CreateRestApiRequest$apiKeySource": "<p>The source of the API key for metering requests according to a usage plan. Valid values are: <ul><li><code>HEADER</code> to read the API key from the <code>X-API-Key</code> header of a request. </li><li><code>AUTHORIZER</code> to read the API key from the <code>UsageIdentifierKey</code> from a custom authorizer.</li></ul> </p>",
|
||||
"RestApi$apiKeySource": "<p>The source of the API key for metering requests according to a usage plan. Valid values are: <ul><li><code>HEADER</code> to read the API key from the <code>X-API-Key</code> header of a request. </li><li><code>AUTHORIZER</code> to read the API key from the <code>UsageIdentifierKey</code> from a custom authorizer.</li></ul> </p>"
|
||||
}
|
||||
},
|
||||
"ApiKeys": {
|
||||
|
|
@ -177,9 +177,9 @@
|
|||
}
|
||||
},
|
||||
"AuthorizerType": {
|
||||
"base": "<p>[Required] The authorizer type. Valid values are <code>TOKEN</code> for a Lambda function using a single authorization token submitted in a custom header, <code>REQUEST</code> for a Lambda function using incoming request parameters, and <code>COGNITO_USER_POOLS</code> for using an Amazon Cognito user pool.</p>",
|
||||
"base": "<p>The authorizer type. Valid values are <code>TOKEN</code> for a Lambda function using a single authorization token submitted in a custom header, <code>REQUEST</code> for a Lambda function using incoming request parameters, and <code>COGNITO_USER_POOLS</code> for using an Amazon Cognito user pool.</p>",
|
||||
"refs": {
|
||||
"Authorizer$type": "<p>[Required] The authorizer type. Valid values are <code>TOKEN</code> for a Lambda function using a single authorization token submitted in a custom header, <code>REQUEST</code> for a Lambda function using incoming request parameters, and <code>COGNITO_USER_POOLS</code> for using an Amazon Cognito user pool.</p>",
|
||||
"Authorizer$type": "<p>The authorizer type. Valid values are <code>TOKEN</code> for a Lambda function using a single authorization token submitted in a custom header, <code>REQUEST</code> for a Lambda function using incoming request parameters, and <code>COGNITO_USER_POOLS</code> for using an Amazon Cognito user pool.</p>",
|
||||
"CreateAuthorizerRequest$type": "<p>[Required] The authorizer type. Valid values are <code>TOKEN</code> for a Lambda function using a single authorization token submitted in a custom header, <code>REQUEST</code> for a Lambda function using incoming request parameters, and <code>COGNITO_USER_POOLS</code> for using an Amazon Cognito user pool.</p>"
|
||||
}
|
||||
},
|
||||
|
|
@ -210,8 +210,8 @@
|
|||
"ExportResponse$body": "<p>The binary blob response to <a>GetExport</a>, which contains the export.</p>",
|
||||
"ImportApiKeysRequest$body": "<p>The payload of the POST request to import API keys. For the payload format, see <a href=\"http://docs.aws.amazon.com/apigateway/latest/developerguide/api-key-file-format.html\">API Key File Format</a>.</p>",
|
||||
"ImportDocumentationPartsRequest$body": "<p>[Required] Raw byte array representing the to-be-imported documentation parts. To import from a Swagger file, this is a JSON object.</p>",
|
||||
"ImportRestApiRequest$body": "<p>The POST request body containing external API definitions. Currently, only Swagger definition JSON files are supported. The maximum size of the API definition file is 2MB.</p>",
|
||||
"PutRestApiRequest$body": "<p>The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported. The maximum size of the API definition file is 2MB.</p>",
|
||||
"ImportRestApiRequest$body": "<p>[Required] The POST request body containing external API definitions. Currently, only Swagger definition JSON files are supported. The maximum size of the API definition file is 2MB.</p>",
|
||||
"PutRestApiRequest$body": "<p>[Required] The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported. The maximum size of the API definition file is 2MB.</p>",
|
||||
"SdkResponse$body": "<p>The binary blob response to <a>GetSdk</a>, which contains the generated SDK.</p>"
|
||||
}
|
||||
},
|
||||
|
|
@ -522,7 +522,7 @@
|
|||
"DocumentationPartType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DocumentationPartLocation$type": "<p>The type of API entity to which the documentation content applies. It is a valid and required field for API entity types of <code>API</code>, <code>AUTHORIZER</code>, <code>MODEL</code>, <code>RESOURCE</code>, <code>METHOD</code>, <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>, <code>REQUEST_BODY</code>, <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and <code>RESPONSE_BODY</code>. Content inheritance does not apply to any entity of the <code>API</code>, <code>AUTHORIZER</code>, <code>METHOD</code>, <code>MODEL</code>, <code>REQUEST_BODY</code>, or <code>RESOURCE</code> type.</p>",
|
||||
"DocumentationPartLocation$type": "<p>[Required] The type of API entity to which the documentation content applies. Valid values are <code>API</code>, <code>AUTHORIZER</code>, <code>MODEL</code>, <code>RESOURCE</code>, <code>METHOD</code>, <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>, <code>REQUEST_BODY</code>, <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and <code>RESPONSE_BODY</code>. Content inheritance does not apply to any entity of the <code>API</code>, <code>AUTHORIZER</code>, <code>METHOD</code>, <code>MODEL</code>, <code>REQUEST_BODY</code>, or <code>RESOURCE</code> type.</p>",
|
||||
"GetDocumentationPartsRequest$type": "<p>The type of API entities of the to-be-retrieved documentation parts. </p>"
|
||||
}
|
||||
},
|
||||
|
|
@ -601,11 +601,11 @@
|
|||
"GatewayResponseType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DeleteGatewayResponseRequest$responseType": "<p><p>The response type of the associated <a>GatewayResponse</a>. Valid values are <ul><li>ACCESS_DENIED</li><li>API_CONFIGURATION_ERROR</li><li>AUTHORIZER_FAILURE</li><li> AUTHORIZER_CONFIGURATION_ERROR</li><li>BAD_REQUEST_PARAMETERS</li><li>BAD_REQUEST_BODY</li><li>DEFAULT_4XX</li><li>DEFAULT_5XX</li><li>EXPIRED_TOKEN</li><li>INVALID_SIGNATURE</li><li>INTEGRATION_FAILURE</li><li>INTEGRATION_TIMEOUT</li><li>INVALID_API_KEY</li><li>MISSING_AUTHENTICATION_TOKEN</li><li> QUOTA_EXCEEDED</li><li>REQUEST_TOO_LARGE</li><li>RESOURCE_NOT_FOUND</li><li>THROTTLED</li><li>UNAUTHORIZED</li><li>UNSUPPORTED_MEDIA_TYPES</li></ul> </p></p>",
|
||||
"GatewayResponse$responseType": "<p>The response type of the associated <a>GatewayResponse</a>. Valid values are <ul><li>ACCESS_DENIED</li><li>API_CONFIGURATION_ERROR</li><li>AUTHORIZER_FAILURE</li><li> AUTHORIZER_CONFIGURATION_ERROR</li><li>BAD_REQUEST_PARAMETERS</li><li>BAD_REQUEST_BODY</li><li>DEFAULT_4XX</li><li>DEFAULT_5XX</li><li>EXPIRED_TOKEN</li><li>INVALID_SIGNATURE</li><li>INTEGRATION_FAILURE</li><li>INTEGRATION_TIMEOUT</li><li>INVALID_API_KEY</li><li>MISSING_AUTHENTICATION_TOKEN</li><li> QUOTA_EXCEEDED</li><li>REQUEST_TOO_LARGE</li><li>RESOURCE_NOT_FOUND</li><li>THROTTLED</li><li>UNAUTHORIZED</li><li>UNSUPPORTED_MEDIA_TYPES</li></ul> </p>",
|
||||
"GetGatewayResponseRequest$responseType": "<p><p>The response type of the associated <a>GatewayResponse</a>. Valid values are <ul><li>ACCESS_DENIED</li><li>API_CONFIGURATION_ERROR</li><li>AUTHORIZER_FAILURE</li><li> AUTHORIZER_CONFIGURATION_ERROR</li><li>BAD_REQUEST_PARAMETERS</li><li>BAD_REQUEST_BODY</li><li>DEFAULT_4XX</li><li>DEFAULT_5XX</li><li>EXPIRED_TOKEN</li><li>INVALID_SIGNATURE</li><li>INTEGRATION_FAILURE</li><li>INTEGRATION_TIMEOUT</li><li>INVALID_API_KEY</li><li>MISSING_AUTHENTICATION_TOKEN</li><li> QUOTA_EXCEEDED</li><li>REQUEST_TOO_LARGE</li><li>RESOURCE_NOT_FOUND</li><li>THROTTLED</li><li>UNAUTHORIZED</li><li>UNSUPPORTED_MEDIA_TYPES</li></ul> </p></p>",
|
||||
"PutGatewayResponseRequest$responseType": "<p><p>The response type of the associated <a>GatewayResponse</a>. Valid values are <ul><li>ACCESS_DENIED</li><li>API_CONFIGURATION_ERROR</li><li>AUTHORIZER_FAILURE</li><li> AUTHORIZER_CONFIGURATION_ERROR</li><li>BAD_REQUEST_PARAMETERS</li><li>BAD_REQUEST_BODY</li><li>DEFAULT_4XX</li><li>DEFAULT_5XX</li><li>EXPIRED_TOKEN</li><li>INVALID_SIGNATURE</li><li>INTEGRATION_FAILURE</li><li>INTEGRATION_TIMEOUT</li><li>INVALID_API_KEY</li><li>MISSING_AUTHENTICATION_TOKEN</li><li> QUOTA_EXCEEDED</li><li>REQUEST_TOO_LARGE</li><li>RESOURCE_NOT_FOUND</li><li>THROTTLED</li><li>UNAUTHORIZED</li><li>UNSUPPORTED_MEDIA_TYPES</li></ul> </p></p>",
|
||||
"UpdateGatewayResponseRequest$responseType": "<p><p>The response type of the associated <a>GatewayResponse</a>. Valid values are <ul><li>ACCESS_DENIED</li><li>API_CONFIGURATION_ERROR</li><li>AUTHORIZER_FAILURE</li><li> AUTHORIZER_CONFIGURATION_ERROR</li><li>BAD_REQUEST_PARAMETERS</li><li>BAD_REQUEST_BODY</li><li>DEFAULT_4XX</li><li>DEFAULT_5XX</li><li>EXPIRED_TOKEN</li><li>INVALID_SIGNATURE</li><li>INTEGRATION_FAILURE</li><li>INTEGRATION_TIMEOUT</li><li>INVALID_API_KEY</li><li>MISSING_AUTHENTICATION_TOKEN</li><li> QUOTA_EXCEEDED</li><li>REQUEST_TOO_LARGE</li><li>RESOURCE_NOT_FOUND</li><li>THROTTLED</li><li>UNAUTHORIZED</li><li>UNSUPPORTED_MEDIA_TYPES</li></ul> </p></p>"
|
||||
"DeleteGatewayResponseRequest$responseType": "<p>[Required] <p>The response type of the associated <a>GatewayResponse</a>. Valid values are <ul><li>ACCESS_DENIED</li><li>API_CONFIGURATION_ERROR</li><li>AUTHORIZER_FAILURE</li><li> AUTHORIZER_CONFIGURATION_ERROR</li><li>BAD_REQUEST_PARAMETERS</li><li>BAD_REQUEST_BODY</li><li>DEFAULT_4XX</li><li>DEFAULT_5XX</li><li>EXPIRED_TOKEN</li><li>INVALID_SIGNATURE</li><li>INTEGRATION_FAILURE</li><li>INTEGRATION_TIMEOUT</li><li>INVALID_API_KEY</li><li>MISSING_AUTHENTICATION_TOKEN</li><li> QUOTA_EXCEEDED</li><li>REQUEST_TOO_LARGE</li><li>RESOURCE_NOT_FOUND</li><li>THROTTLED</li><li>UNAUTHORIZED</li><li>UNSUPPORTED_MEDIA_TYPE</li></ul> </p></p>",
|
||||
"GatewayResponse$responseType": "<p>The response type of the associated <a>GatewayResponse</a>. Valid values are <ul><li>ACCESS_DENIED</li><li>API_CONFIGURATION_ERROR</li><li>AUTHORIZER_FAILURE</li><li> AUTHORIZER_CONFIGURATION_ERROR</li><li>BAD_REQUEST_PARAMETERS</li><li>BAD_REQUEST_BODY</li><li>DEFAULT_4XX</li><li>DEFAULT_5XX</li><li>EXPIRED_TOKEN</li><li>INVALID_SIGNATURE</li><li>INTEGRATION_FAILURE</li><li>INTEGRATION_TIMEOUT</li><li>INVALID_API_KEY</li><li>MISSING_AUTHENTICATION_TOKEN</li><li> QUOTA_EXCEEDED</li><li>REQUEST_TOO_LARGE</li><li>RESOURCE_NOT_FOUND</li><li>THROTTLED</li><li>UNAUTHORIZED</li><li>UNSUPPORTED_MEDIA_TYPE</li></ul> </p>",
|
||||
"GetGatewayResponseRequest$responseType": "<p>[Required] <p>The response type of the associated <a>GatewayResponse</a>. Valid values are <ul><li>ACCESS_DENIED</li><li>API_CONFIGURATION_ERROR</li><li>AUTHORIZER_FAILURE</li><li> AUTHORIZER_CONFIGURATION_ERROR</li><li>BAD_REQUEST_PARAMETERS</li><li>BAD_REQUEST_BODY</li><li>DEFAULT_4XX</li><li>DEFAULT_5XX</li><li>EXPIRED_TOKEN</li><li>INVALID_SIGNATURE</li><li>INTEGRATION_FAILURE</li><li>INTEGRATION_TIMEOUT</li><li>INVALID_API_KEY</li><li>MISSING_AUTHENTICATION_TOKEN</li><li> QUOTA_EXCEEDED</li><li>REQUEST_TOO_LARGE</li><li>RESOURCE_NOT_FOUND</li><li>THROTTLED</li><li>UNAUTHORIZED</li><li>UNSUPPORTED_MEDIA_TYPE</li></ul> </p></p>",
|
||||
"PutGatewayResponseRequest$responseType": "<p>[Required] <p>The response type of the associated <a>GatewayResponse</a>. Valid values are <ul><li>ACCESS_DENIED</li><li>API_CONFIGURATION_ERROR</li><li>AUTHORIZER_FAILURE</li><li> AUTHORIZER_CONFIGURATION_ERROR</li><li>BAD_REQUEST_PARAMETERS</li><li>BAD_REQUEST_BODY</li><li>DEFAULT_4XX</li><li>DEFAULT_5XX</li><li>EXPIRED_TOKEN</li><li>INVALID_SIGNATURE</li><li>INTEGRATION_FAILURE</li><li>INTEGRATION_TIMEOUT</li><li>INVALID_API_KEY</li><li>MISSING_AUTHENTICATION_TOKEN</li><li> QUOTA_EXCEEDED</li><li>REQUEST_TOO_LARGE</li><li>RESOURCE_NOT_FOUND</li><li>THROTTLED</li><li>UNAUTHORIZED</li><li>UNSUPPORTED_MEDIA_TYPE</li></ul> </p></p>",
|
||||
"UpdateGatewayResponseRequest$responseType": "<p>[Required] <p>The response type of the associated <a>GatewayResponse</a>. Valid values are <ul><li>ACCESS_DENIED</li><li>API_CONFIGURATION_ERROR</li><li>AUTHORIZER_FAILURE</li><li> AUTHORIZER_CONFIGURATION_ERROR</li><li>BAD_REQUEST_PARAMETERS</li><li>BAD_REQUEST_BODY</li><li>DEFAULT_4XX</li><li>DEFAULT_5XX</li><li>EXPIRED_TOKEN</li><li>INVALID_SIGNATURE</li><li>INTEGRATION_FAILURE</li><li>INTEGRATION_TIMEOUT</li><li>INVALID_API_KEY</li><li>MISSING_AUTHENTICATION_TOKEN</li><li> QUOTA_EXCEEDED</li><li>REQUEST_TOO_LARGE</li><li>RESOURCE_NOT_FOUND</li><li>THROTTLED</li><li>UNAUTHORIZED</li><li>UNSUPPORTED_MEDIA_TYPE</li></ul> </p></p>"
|
||||
}
|
||||
},
|
||||
"GatewayResponses": {
|
||||
|
|
@ -809,7 +809,7 @@
|
|||
}
|
||||
},
|
||||
"GetTagsRequest": {
|
||||
"base": "<p>Gets the Tags collection for a given resource.</p>",
|
||||
"base": "<p>Gets the <a>Tags</a> collection for a given resource.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
|
|
@ -892,7 +892,7 @@
|
|||
"base": "<p>The integration type. The valid value is <code>HTTP</code> for integrating an API method with an HTTP backend; <code>AWS</code> with any AWS service endpoints; <code>MOCK</code> for testing without actually invoking the backend; <code>HTTP_PROXY</code> for integrating with the HTTP proxy integration; <code>AWS_PROXY</code> for integrating with the Lambda proxy integration. </p>",
|
||||
"refs": {
|
||||
"Integration$type": "<p>Specifies an API method integration type. The valid value is one of the following:</p> <ul> <li><code>AWS</code>: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.</li> <li><code>AWS_PROXY</code>: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.</li> <li><code>HTTP</code>: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.</li> <li><code>HTTP_PROXY</code>: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.</li> <li><code>MOCK</code>: for integrating the API method request with API Gateway as a \"loop-back\" endpoint without invoking any backend.</li> </ul> <p>For the HTTP and HTTP proxy integrations, each integration can specify a protocol (<code>http/https</code>), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a <code>connectionType</code> of <code>VPC_LINK</code> is referred to as a private integration and uses a <a>VpcLink</a> to connect API Gateway to a network load balancer of a VPC.</p>",
|
||||
"PutIntegrationRequest$type": "<p>Specifies a put integration input's type.</p>"
|
||||
"PutIntegrationRequest$type": "<p>[Required] Specifies a put integration input's type.</p>"
|
||||
}
|
||||
},
|
||||
"LimitExceededException": {
|
||||
|
|
@ -1072,12 +1072,12 @@
|
|||
"GetResourcesRequest$embed": "<p>A query parameter used to retrieve the specified resources embedded in the returned <a>Resources</a> resource in the response. This <code>embed</code> parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded <a>Method</a> resources this way. The query parameter value must be a single-valued list and contain the <code>\"methods\"</code> string. For example, <code>GET /restapis/{restapi_id}/resources?embed=methods</code>.</p>",
|
||||
"Integration$cacheKeyParameters": "<p>Specifies the integration's cache key parameters.</p>",
|
||||
"MapOfStringToList$value": null,
|
||||
"Method$authorizationScopes": "<p>A list of authorization scopes configured on the method. The scopes are used with a <code>COGNITO_USER_POOL</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>",
|
||||
"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>",
|
||||
"PutIntegrationRequest$cacheKeyParameters": "<p>Specifies a put integration input's cache key parameters.</p>",
|
||||
"PutMethodRequest$authorizationScopes": "<p>A list of authorization scopes configured on the method. The scopes are used with a <code>COGNITO_USER_POOL</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>",
|
||||
"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>",
|
||||
"RestApi$warnings": "<p>The warning messages reported when <code>failonwarnings</code> is turned on during API import.</p>",
|
||||
"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>",
|
||||
"UntagResourceRequest$tagKeys": "<p>The Tag keys to delete.</p>",
|
||||
"UntagResourceRequest$tagKeys": "<p>[Required] The Tag keys to delete.</p>",
|
||||
"VpcLink$targetArns": "<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>"
|
||||
}
|
||||
},
|
||||
|
|
@ -1184,7 +1184,7 @@
|
|||
"CanarySettings$stageVariableOverrides": "<p>Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.</p>",
|
||||
"CreateDeploymentRequest$variables": "<p>A map that defines the stage variables for the <a>Stage</a> resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match <code>[A-Za-z0-9-._~:/?#&=,]+</code>.</p>",
|
||||
"CreateStageRequest$variables": "<p>A map that defines the stage variables for the new <a>Stage</a> resource. Variable names can have alphanumeric and underscore characters, and the values must match <code>[A-Za-z0-9-._~:/?#&=,]+</code>.</p>",
|
||||
"CreateStageRequest$tags": "<p>Key/Value map of strings. Valid character set is [a-zA-Z+-=._:/]. Tag key can be up to 128 characters and must not start with \"aws:\". Tag value can be up to 256 characters.</p>",
|
||||
"CreateStageRequest$tags": "<p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.</p>",
|
||||
"DeploymentCanarySettings$stageVariableOverrides": "<p>A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.</p>",
|
||||
"GatewayResponse$responseParameters": "<p>Response parameters (paths, query strings and headers) of the <a>GatewayResponse</a> as a string-to-string map of key-value pairs.</p>",
|
||||
"GatewayResponse$responseTemplates": "<p>Response templates of the <a>GatewayResponse</a> as a string-to-string map of key-value pairs.</p>",
|
||||
|
|
@ -1207,9 +1207,9 @@
|
|||
"PutMethodResponseRequest$responseModels": "<p>Specifies the <a>Model</a> resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a <a>Model</a> name as the value.</p>",
|
||||
"PutRestApiRequest$parameters": "<p>Custom header parameters as part of the request. For example, to exclude <a>DocumentationParts</a> from an imported API, set <code>ignore=documentation</code> as a <code>parameters</code> value, as in the AWS CLI command of <code>aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json</code>.</p>",
|
||||
"Stage$variables": "<p>A map that defines the stage variables for a <a>Stage</a> resource. Variable names can have alphanumeric and underscore characters, and the values must match <code>[A-Za-z0-9-._~:/?#&=,]+</code>.</p>",
|
||||
"Stage$tags": "<p>A collection of Tags associated with a given resource.</p>",
|
||||
"TagResourceRequest$tags": "<p>[Required] Key/Value map of strings. Valid character set is [a-zA-Z+-=._:/]. Tag key can be up to 128 characters and must not start with \"aws:\". Tag value can be up to 256 characters.</p>",
|
||||
"Tags$tags": "<p>A collection of Tags associated with a given resource.</p>",
|
||||
"Stage$tags": "<p>The collection of tags. Each tag element is associated with a given resource.</p>",
|
||||
"TagResourceRequest$tags": "<p>[Required] The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.</p>",
|
||||
"Tags$tags": "<p>The collection of tags. Each tag element is associated with a given resource.</p>",
|
||||
"TestInvokeAuthorizerRequest$stageVariables": "<p>A key-value map of stage variables to simulate an invocation on a deployed <a>Stage</a>.</p>",
|
||||
"TestInvokeAuthorizerRequest$additionalContext": "<p>[Optional] A key-value map of additional context variables.</p>",
|
||||
"TestInvokeAuthorizerResponse$claims": "<p>The <a href=\"http://openid.net/specs/openid-connect-core-1_0.html#StandardClaims\">open identity claims</a>, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.</p>",
|
||||
|
|
@ -1271,28 +1271,28 @@
|
|||
"refs": {
|
||||
"Authorizer$authorizerResultTtlInSeconds": "<p>The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.</p>",
|
||||
"CreateAuthorizerRequest$authorizerResultTtlInSeconds": "<p>The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.</p>",
|
||||
"CreateRestApiRequest$minimumCompressionSize": "<p>A nullable integer used to enable (non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable (null) compression on an API. When compression is enabled, compression or decompression are 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>",
|
||||
"GetApiKeysRequest$limit": "<p>The maximum number of returned results per page.</p>",
|
||||
"GetAuthorizersRequest$limit": "<p>The maximum number of returned results per page.</p>",
|
||||
"GetBasePathMappingsRequest$limit": "<p>The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.</p>",
|
||||
"GetClientCertificatesRequest$limit": "<p>The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.</p>",
|
||||
"GetDeploymentsRequest$limit": "<p>The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.</p>",
|
||||
"GetDocumentationPartsRequest$limit": "<p>The maximum number of returned results per page.</p>",
|
||||
"GetDocumentationVersionsRequest$limit": "<p>The maximum number of returned results per page.</p>",
|
||||
"GetDomainNamesRequest$limit": "<p>The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.</p>",
|
||||
"GetGatewayResponsesRequest$limit": "<p>The maximum number of returned results per page. The <a>GatewayResponses</a> collection does not support pagination and the limit does not apply here.</p>",
|
||||
"GetModelsRequest$limit": "<p>The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.</p>",
|
||||
"GetRequestValidatorsRequest$limit": "<p>The maximum number of returned results per page.</p>",
|
||||
"GetResourcesRequest$limit": "<p>The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.</p>",
|
||||
"GetRestApisRequest$limit": "<p>The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.</p>",
|
||||
"GetSdkTypesRequest$limit": "<p>The maximum number of returned results per page.</p>",
|
||||
"GetTagsRequest$limit": "<p>(Not currently supported) The maximum number of returned results per page.</p>",
|
||||
"GetUsagePlanKeysRequest$limit": "<p>The maximum number of returned results per page.</p>",
|
||||
"GetUsagePlansRequest$limit": "<p>The maximum number of returned results per page.</p>",
|
||||
"GetUsageRequest$limit": "<p>The maximum number of returned results per page.</p>",
|
||||
"GetVpcLinksRequest$limit": "<p>The maximum number of returned results per page.</p>",
|
||||
"CreateRestApiRequest$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>",
|
||||
"GetApiKeysRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
|
||||
"GetAuthorizersRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
|
||||
"GetBasePathMappingsRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
|
||||
"GetClientCertificatesRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
|
||||
"GetDeploymentsRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
|
||||
"GetDocumentationPartsRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
|
||||
"GetDocumentationVersionsRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
|
||||
"GetDomainNamesRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
|
||||
"GetGatewayResponsesRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The <a>GatewayResponses</a> collection does not support pagination and the limit does not apply here.</p>",
|
||||
"GetModelsRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
|
||||
"GetRequestValidatorsRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
|
||||
"GetResourcesRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
|
||||
"GetRestApisRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
|
||||
"GetSdkTypesRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
|
||||
"GetTagsRequest$limit": "<p>(Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
|
||||
"GetUsagePlanKeysRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
|
||||
"GetUsagePlansRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
|
||||
"GetUsageRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
|
||||
"GetVpcLinksRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
|
||||
"PutIntegrationRequest$timeoutInMillis": "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.</p>",
|
||||
"RestApi$minimumCompressionSize": "<p>A nullable integer used to enable (non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable (null) compression on an API. When compression is enabled, compression or decompression are 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>"
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"Op": {
|
||||
|
|
@ -1449,18 +1449,18 @@
|
|||
"StatusCode": {
|
||||
"base": "<p>The status code.</p>",
|
||||
"refs": {
|
||||
"DeleteIntegrationResponseRequest$statusCode": "<p>Specifies a delete integration response request's status code.</p>",
|
||||
"DeleteMethodResponseRequest$statusCode": "<p>The status code identifier for the <a>MethodResponse</a> resource.</p>",
|
||||
"DeleteIntegrationResponseRequest$statusCode": "<p>[Required] Specifies a delete integration response request's status code.</p>",
|
||||
"DeleteMethodResponseRequest$statusCode": "<p>[Required] The status code identifier for the <a>MethodResponse</a> resource.</p>",
|
||||
"GatewayResponse$statusCode": "<p>The HTTP status code for this <a>GatewayResponse</a>.</p>",
|
||||
"GetIntegrationResponseRequest$statusCode": "<p>Specifies a get integration response request's status code.</p>",
|
||||
"GetMethodResponseRequest$statusCode": "<p>The status code for the <a>MethodResponse</a> resource.</p>",
|
||||
"GetIntegrationResponseRequest$statusCode": "<p>[Required] Specifies a get integration response request's status code.</p>",
|
||||
"GetMethodResponseRequest$statusCode": "<p>[Required] The status code for the <a>MethodResponse</a> resource.</p>",
|
||||
"IntegrationResponse$statusCode": "<p>Specifies the status code that is used to map the integration response to an existing <a>MethodResponse</a>.</p>",
|
||||
"MethodResponse$statusCode": "<p>The method response's status code.</p>",
|
||||
"PutGatewayResponseRequest$statusCode": "The HTTP status code of the <a>GatewayResponse</a>.",
|
||||
"PutIntegrationResponseRequest$statusCode": "<p>Specifies the status code that is used to map the integration response to an existing <a>MethodResponse</a>.</p>",
|
||||
"PutMethodResponseRequest$statusCode": "<p>The method response's status code.</p>",
|
||||
"UpdateIntegrationResponseRequest$statusCode": "<p>Specifies an update integration response request's status code.</p>",
|
||||
"UpdateMethodResponseRequest$statusCode": "<p>The status code for the <a>MethodResponse</a> resource.</p>"
|
||||
"PutIntegrationResponseRequest$statusCode": "<p>[Required] Specifies the status code that is used to map the integration response to an existing <a>MethodResponse</a>.</p>",
|
||||
"PutMethodResponseRequest$statusCode": "<p>[Required] The method response's status code.</p>",
|
||||
"UpdateIntegrationResponseRequest$statusCode": "<p>[Required] Specifies an update integration response request's status code.</p>",
|
||||
"UpdateMethodResponseRequest$statusCode": "<p>[Required] The status code for the <a>MethodResponse</a> resource.</p>"
|
||||
}
|
||||
},
|
||||
"String": {
|
||||
|
|
@ -1483,8 +1483,8 @@
|
|||
"Authorizer$authType": "<p>Optional customer-defined field, used in Swagger imports and exports without functional impact.</p>",
|
||||
"Authorizer$authorizerUri": "<p>Specifies the authorizer's Uniform Resource Identifier (URI). For <code>TOKEN</code> or <code>REQUEST</code> authorizers, this must be a well-formed Lambda function URI, for example, <code>arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations</code>. In general, the URI has this form <code>arn:aws:apigateway:{region}:lambda:path/{service_api}</code>, where <code>{region}</code> is the same as the region hosting the Lambda function, <code>path</code> indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial <code>/</code>. For Lambda functions, this is usually of the form <code>/2015-03-31/functions/[FunctionARN]/invocations</code>.</p>",
|
||||
"Authorizer$authorizerCredentials": "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.</p>",
|
||||
"Authorizer$identitySource": "<p>The identity source for which authorization is requested. <ul><li>For a <code>TOKEN</code> authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is <code>Auth</code>, the header mapping expression is <code>method.request.header.Auth</code>.</li><li>For the <code>REQUEST</code> authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an <code>Auth</code> header, a <code>Name</code> query string parameter are defined as identity sources, this value is <code>method.request.header.Auth, method.request.querystring.Name</code>. These parameters will be used to derive the authorization caching key and to perform runtime validation of the <code>REQUEST</code> authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.</li><li>For a <code>COGNITO_USER_POOLS</code> authorizer, this property is not used.</li></ul></p>",
|
||||
"Authorizer$identityValidationExpression": "<p>A validation expression for the incoming identity token. For <code>TOKEN</code> authorizers, this value is a regular expression. API Gateway will match the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the <code>REQUEST</code> authorizer.</p>",
|
||||
"Authorizer$identitySource": "<p>The identity source for which authorization is requested. <ul><li>For a <code>TOKEN</code> or <code>COGNITO_USER_POOLS</code> authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is <code>Auth</code>, the header mapping expression is <code>method.request.header.Auth</code>.</li><li>For the <code>REQUEST</code> authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an <code>Auth</code> header, a <code>Name</code> query string parameter are defined as identity sources, this value is <code>method.request.header.Auth, method.request.querystring.Name</code>. These parameters will be used to derive the authorization caching key and to perform runtime validation of the <code>REQUEST</code> authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.</li></ul></p>",
|
||||
"Authorizer$identityValidationExpression": "<p>A validation expression for the incoming identity token. For <code>TOKEN</code> authorizers, this value is a regular expression. API Gateway will match the <code>aud</code> field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the <code>REQUEST</code> authorizer.</p>",
|
||||
"Authorizers$position": null,
|
||||
"BadRequestException$message": null,
|
||||
"BasePathMapping$basePath": "<p>The base path name that callers of the API must provide as part of the URL after the domain name.</p>",
|
||||
|
|
@ -1501,18 +1501,18 @@
|
|||
"CreateApiKeyRequest$description": "<p>The description of the <a>ApiKey</a>.</p>",
|
||||
"CreateApiKeyRequest$value": "<p>Specifies a value of the API key.</p>",
|
||||
"CreateApiKeyRequest$customerId": "<p>An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.</p>",
|
||||
"CreateAuthorizerRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"CreateAuthorizerRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"CreateAuthorizerRequest$name": "<p>[Required] The name of the authorizer.</p>",
|
||||
"CreateAuthorizerRequest$authType": "<p>Optional customer-defined field, used in Swagger imports and exports without functional impact.</p>",
|
||||
"CreateAuthorizerRequest$authorizerUri": "<p>Specifies the authorizer's Uniform Resource Identifier (URI). For <code>TOKEN</code> or <code>REQUEST</code> authorizers, this must be a well-formed Lambda function URI, for example, <code>arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations</code>. In general, the URI has this form <code>arn:aws:apigateway:{region}:lambda:path/{service_api}</code>, where <code>{region}</code> is the same as the region hosting the Lambda function, <code>path</code> indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial <code>/</code>. For Lambda functions, this is usually of the form <code>/2015-03-31/functions/[FunctionARN]/invocations</code>.</p>",
|
||||
"CreateAuthorizerRequest$authorizerCredentials": "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.</p>",
|
||||
"CreateAuthorizerRequest$identitySource": "<p>The identity source for which authorization is requested. <ul><li>For a <code>TOKEN</code> authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is <code>Auth</code>, the header mapping expression is <code>method.request.header.Auth</code>.</li><li>For the <code>REQUEST</code> authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an <code>Auth</code> header, a <code>Name</code> query string parameter are defined as identity sources, this value is <code>method.request.header.Auth, method.request.querystring.Name</code>. These parameters will be used to derive the authorization caching key and to perform runtime validation of the <code>REQUEST</code> authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.</li><li>For a <code>COGNITO_USER_POOLS</code> authorizer, this property is not used.</li></ul></p>",
|
||||
"CreateAuthorizerRequest$identityValidationExpression": "<p>A validation expression for the incoming identity token. For <code>TOKEN</code> authorizers, this value is a regular expression. API Gateway will match the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the <code>REQUEST</code> authorizer.</p>",
|
||||
"CreateBasePathMappingRequest$domainName": "<p>The domain name of the <a>BasePathMapping</a> resource to create.</p>",
|
||||
"CreateAuthorizerRequest$identitySource": "<p>The identity source for which authorization is requested. <ul><li>For a <code>TOKEN</code> or <code>COGNITO_USER_POOLS</code> authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is <code>Auth</code>, the header mapping expression is <code>method.request.header.Auth</code>.</li><li>For the <code>REQUEST</code> authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an <code>Auth</code> header, a <code>Name</code> query string parameter are defined as identity sources, this value is <code>method.request.header.Auth, method.request.querystring.Name</code>. These parameters will be used to derive the authorization caching key and to perform runtime validation of the <code>REQUEST</code> authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.</li></ul></p>",
|
||||
"CreateAuthorizerRequest$identityValidationExpression": "<p>A validation expression for the incoming identity token. For <code>TOKEN</code> authorizers, this value is a regular expression. API Gateway will match the <code>aud</code> field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the <code>REQUEST</code> authorizer.</p>",
|
||||
"CreateBasePathMappingRequest$domainName": "<p>[Required] The domain name of the <a>BasePathMapping</a> resource to create.</p>",
|
||||
"CreateBasePathMappingRequest$basePath": "<p>The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify a base path name after the domain name.</p>",
|
||||
"CreateBasePathMappingRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"CreateBasePathMappingRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"CreateBasePathMappingRequest$stage": "<p>The name of the API's stage that you want to use for this mapping. Leave this blank if you do not want callers to explicitly specify the stage name after any base path name.</p>",
|
||||
"CreateDeploymentRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"CreateDeploymentRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"CreateDeploymentRequest$stageName": "<p>The name of the <a>Stage</a> resource for the <a>Deployment</a> resource to create.</p>",
|
||||
"CreateDeploymentRequest$stageDescription": "<p>The description of the <a>Stage</a> resource for the <a>Deployment</a> resource to create.</p>",
|
||||
"CreateDeploymentRequest$description": "<p>The description for the <a>Deployment</a> resource to create.</p>",
|
||||
|
|
@ -1522,7 +1522,7 @@
|
|||
"CreateDocumentationVersionRequest$documentationVersion": "<p>[Required] The version identifier of the new snapshot.</p>",
|
||||
"CreateDocumentationVersionRequest$stageName": "<p>The stage name to be associated with the new documentation snapshot.</p>",
|
||||
"CreateDocumentationVersionRequest$description": "<p>A description about the new documentation snapshot.</p>",
|
||||
"CreateDomainNameRequest$domainName": "<p>(Required) The name of the <a>DomainName</a> resource.</p>",
|
||||
"CreateDomainNameRequest$domainName": "<p>[Required] The name of the <a>DomainName</a> resource.</p>",
|
||||
"CreateDomainNameRequest$certificateName": "<p>The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.</p>",
|
||||
"CreateDomainNameRequest$certificateBody": "<p>[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.</p>",
|
||||
"CreateDomainNameRequest$certificatePrivateKey": "<p>[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.</p>",
|
||||
|
|
@ -1530,70 +1530,71 @@
|
|||
"CreateDomainNameRequest$certificateArn": "<p>The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.</p>",
|
||||
"CreateDomainNameRequest$regionalCertificateName": "<p>The user-friendly name of the certificate that will be used by regional endpoint for this domain name.</p>",
|
||||
"CreateDomainNameRequest$regionalCertificateArn": "<p>The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source.</p>",
|
||||
"CreateModelRequest$restApiId": "<p>The <a>RestApi</a> identifier under which the <a>Model</a> will be created.</p>",
|
||||
"CreateModelRequest$name": "<p>The name of the model. Must be alphanumeric.</p>",
|
||||
"CreateModelRequest$restApiId": "<p>[Required] The <a>RestApi</a> identifier under which the <a>Model</a> will be created.</p>",
|
||||
"CreateModelRequest$name": "<p>[Required] The name of the model. Must be alphanumeric.</p>",
|
||||
"CreateModelRequest$description": "<p>The description of the model.</p>",
|
||||
"CreateModelRequest$schema": "<p>The schema for the model. For <code>application/json</code> models, this should be <a href=\"http://json-schema.org/documentation.html\" target=\"_blank\">JSON-schema draft v4</a> model.</p>",
|
||||
"CreateModelRequest$contentType": "<p>The content-type for the model.</p>",
|
||||
"CreateRequestValidatorRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"CreateModelRequest$schema": "<p>The schema for the model. For <code>application/json</code> models, this should be <a href=\"https://tools.ietf.org/html/draft-zyp-json-schema-04\" target=\"_blank\">JSON schema draft 4</a> model.</p>",
|
||||
"CreateModelRequest$contentType": "<p>[Required] The content-type for the model.</p>",
|
||||
"CreateRequestValidatorRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"CreateRequestValidatorRequest$name": "<p>The name of the to-be-created <a>RequestValidator</a>.</p>",
|
||||
"CreateResourceRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"CreateResourceRequest$parentId": "<p>The parent resource's identifier.</p>",
|
||||
"CreateResourceRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"CreateResourceRequest$parentId": "<p>[Required] The parent resource's identifier.</p>",
|
||||
"CreateResourceRequest$pathPart": "<p>The last path segment for this resource.</p>",
|
||||
"CreateRestApiRequest$name": "<p>The name of the <a>RestApi</a>.</p>",
|
||||
"CreateRestApiRequest$name": "<p>[Required] The name of the <a>RestApi</a>.</p>",
|
||||
"CreateRestApiRequest$description": "<p>The description of the <a>RestApi</a>.</p>",
|
||||
"CreateRestApiRequest$version": "<p>A version identifier for the API.</p>",
|
||||
"CreateRestApiRequest$cloneFrom": "<p>The ID of the <a>RestApi</a> that you want to clone from.</p>",
|
||||
"CreateStageRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"CreateRestApiRequest$policy": "A stringified JSON policy document that applies to this RestApi regardless of the caller and <a>Method</a> configuration.",
|
||||
"CreateStageRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"CreateStageRequest$stageName": "<p>[Required] The name for the <a>Stage</a> resource.</p>",
|
||||
"CreateStageRequest$deploymentId": "<p>[Required] The identifier of the <a>Deployment</a> resource for the <a>Stage</a> resource.</p>",
|
||||
"CreateStageRequest$description": "<p>The description of the <a>Stage</a> resource.</p>",
|
||||
"CreateStageRequest$documentationVersion": "<p>The version of the associated API documentation.</p>",
|
||||
"CreateUsagePlanKeyRequest$usagePlanId": "<p>The Id of the <a>UsagePlan</a> resource representing the usage plan containing the to-be-created <a>UsagePlanKey</a> resource representing a plan customer.</p>",
|
||||
"CreateUsagePlanKeyRequest$keyId": "<p>The identifier of a <a>UsagePlanKey</a> resource for a plan customer.</p>",
|
||||
"CreateUsagePlanKeyRequest$keyType": "<p>The type of a <a>UsagePlanKey</a> resource for a plan customer.</p>",
|
||||
"CreateUsagePlanRequest$name": "<p>The name of the usage plan.</p>",
|
||||
"CreateUsagePlanKeyRequest$usagePlanId": "<p>[Required] The Id of the <a>UsagePlan</a> resource representing the usage plan containing the to-be-created <a>UsagePlanKey</a> resource representing a plan customer.</p>",
|
||||
"CreateUsagePlanKeyRequest$keyId": "<p>[Required] The identifier of a <a>UsagePlanKey</a> resource for a plan customer.</p>",
|
||||
"CreateUsagePlanKeyRequest$keyType": "<p>[Required] The type of a <a>UsagePlanKey</a> resource for a plan customer.</p>",
|
||||
"CreateUsagePlanRequest$name": "<p>[Required] The name of the usage plan.</p>",
|
||||
"CreateUsagePlanRequest$description": "<p>The description of the usage plan.</p>",
|
||||
"CreateVpcLinkRequest$name": "<p>[Required] The name used to label and identify the VPC link.</p>",
|
||||
"CreateVpcLinkRequest$description": "<p>The description of the VPC link.</p>",
|
||||
"DeleteApiKeyRequest$apiKey": "<p>The identifier of the <a>ApiKey</a> resource to be deleted.</p>",
|
||||
"DeleteAuthorizerRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteAuthorizerRequest$authorizerId": "<p>The identifier of the <a>Authorizer</a> resource.</p>",
|
||||
"DeleteBasePathMappingRequest$domainName": "<p>The domain name of the <a>BasePathMapping</a> resource to delete.</p>",
|
||||
"DeleteBasePathMappingRequest$basePath": "<p>The base path name of the <a>BasePathMapping</a> resource to delete.</p>",
|
||||
"DeleteClientCertificateRequest$clientCertificateId": "<p>The identifier of the <a>ClientCertificate</a> resource to be deleted.</p>",
|
||||
"DeleteDeploymentRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteDeploymentRequest$deploymentId": "<p>The identifier of the <a>Deployment</a> resource to delete.</p>",
|
||||
"DeleteApiKeyRequest$apiKey": "<p>[Required] The identifier of the <a>ApiKey</a> resource to be deleted.</p>",
|
||||
"DeleteAuthorizerRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteAuthorizerRequest$authorizerId": "<p>[Required] The identifier of the <a>Authorizer</a> resource.</p>",
|
||||
"DeleteBasePathMappingRequest$domainName": "<p>[Required] The domain name of the <a>BasePathMapping</a> resource to delete.</p>",
|
||||
"DeleteBasePathMappingRequest$basePath": "<p>[Required] The base path name of the <a>BasePathMapping</a> resource to delete.</p>",
|
||||
"DeleteClientCertificateRequest$clientCertificateId": "<p>[Required] The identifier of the <a>ClientCertificate</a> resource to be deleted.</p>",
|
||||
"DeleteDeploymentRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteDeploymentRequest$deploymentId": "<p>[Required] The identifier of the <a>Deployment</a> resource to delete.</p>",
|
||||
"DeleteDocumentationPartRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteDocumentationPartRequest$documentationPartId": "<p>[Required] The identifier of the to-be-deleted documentation part.</p>",
|
||||
"DeleteDocumentationVersionRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteDocumentationVersionRequest$documentationVersion": "<p>[Required] The version identifier of a to-be-deleted documentation snapshot.</p>",
|
||||
"DeleteDomainNameRequest$domainName": "<p>The name of the <a>DomainName</a> resource to be deleted.</p>",
|
||||
"DeleteGatewayResponseRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteIntegrationRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteIntegrationRequest$resourceId": "<p>Specifies a delete integration request's resource identifier.</p>",
|
||||
"DeleteIntegrationRequest$httpMethod": "<p>Specifies a delete integration request's HTTP method.</p>",
|
||||
"DeleteIntegrationResponseRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteIntegrationResponseRequest$resourceId": "<p>Specifies a delete integration response request's resource identifier.</p>",
|
||||
"DeleteIntegrationResponseRequest$httpMethod": "<p>Specifies a delete integration response request's HTTP method.</p>",
|
||||
"DeleteMethodRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteMethodRequest$resourceId": "<p>The <a>Resource</a> identifier for the <a>Method</a> resource.</p>",
|
||||
"DeleteMethodRequest$httpMethod": "<p>The HTTP verb of the <a>Method</a> resource.</p>",
|
||||
"DeleteMethodResponseRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteMethodResponseRequest$resourceId": "<p>The <a>Resource</a> identifier for the <a>MethodResponse</a> resource.</p>",
|
||||
"DeleteMethodResponseRequest$httpMethod": "<p>The HTTP verb of the <a>Method</a> resource.</p>",
|
||||
"DeleteModelRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteModelRequest$modelName": "<p>The name of the model to delete.</p>",
|
||||
"DeleteRequestValidatorRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteDomainNameRequest$domainName": "<p>[Required] The name of the <a>DomainName</a> resource to be deleted.</p>",
|
||||
"DeleteGatewayResponseRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteIntegrationRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteIntegrationRequest$resourceId": "<p>[Required] Specifies a delete integration request's resource identifier.</p>",
|
||||
"DeleteIntegrationRequest$httpMethod": "<p>[Required] Specifies a delete integration request's HTTP method.</p>",
|
||||
"DeleteIntegrationResponseRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteIntegrationResponseRequest$resourceId": "<p>[Required] Specifies a delete integration response request's resource identifier.</p>",
|
||||
"DeleteIntegrationResponseRequest$httpMethod": "<p>[Required] Specifies a delete integration response request's HTTP method.</p>",
|
||||
"DeleteMethodRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteMethodRequest$resourceId": "<p>[Required] The <a>Resource</a> identifier for the <a>Method</a> resource.</p>",
|
||||
"DeleteMethodRequest$httpMethod": "<p>[Required] The HTTP verb of the <a>Method</a> resource.</p>",
|
||||
"DeleteMethodResponseRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteMethodResponseRequest$resourceId": "<p>[Required] The <a>Resource</a> identifier for the <a>MethodResponse</a> resource.</p>",
|
||||
"DeleteMethodResponseRequest$httpMethod": "<p>[Required] The HTTP verb of the <a>Method</a> resource.</p>",
|
||||
"DeleteModelRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteModelRequest$modelName": "<p>[Required] The name of the model to delete.</p>",
|
||||
"DeleteRequestValidatorRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteRequestValidatorRequest$requestValidatorId": "<p>[Required] The identifier of the <a>RequestValidator</a> to be deleted.</p>",
|
||||
"DeleteResourceRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteResourceRequest$resourceId": "<p>The identifier of the <a>Resource</a> resource.</p>",
|
||||
"DeleteRestApiRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteStageRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteStageRequest$stageName": "<p>The name of the <a>Stage</a> resource to delete.</p>",
|
||||
"DeleteUsagePlanKeyRequest$usagePlanId": "<p>The Id of the <a>UsagePlan</a> resource representing the usage plan containing the to-be-deleted <a>UsagePlanKey</a> resource representing a plan customer.</p>",
|
||||
"DeleteUsagePlanKeyRequest$keyId": "<p>The Id of the <a>UsagePlanKey</a> resource to be deleted.</p>",
|
||||
"DeleteUsagePlanRequest$usagePlanId": "<p>The Id of the to-be-deleted usage plan.</p>",
|
||||
"DeleteResourceRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteResourceRequest$resourceId": "<p>[Required] The identifier of the <a>Resource</a> resource.</p>",
|
||||
"DeleteRestApiRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteStageRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"DeleteStageRequest$stageName": "<p>[Required] The name of the <a>Stage</a> resource to delete.</p>",
|
||||
"DeleteUsagePlanKeyRequest$usagePlanId": "<p>[Required] The Id of the <a>UsagePlan</a> resource representing the usage plan containing the to-be-deleted <a>UsagePlanKey</a> resource representing a plan customer.</p>",
|
||||
"DeleteUsagePlanKeyRequest$keyId": "<p>[Required] The Id of the <a>UsagePlanKey</a> resource to be deleted.</p>",
|
||||
"DeleteUsagePlanRequest$usagePlanId": "<p>[Required] The Id of the to-be-deleted usage plan.</p>",
|
||||
"DeleteVpcLinkRequest$vpcLinkId": "<p>[Required] The identifier of the <a>VpcLink</a>. It is used in an <a>Integration</a> to reference this <a>VpcLink</a>.</p>",
|
||||
"Deployment$id": "<p>The identifier for the deployment resource.</p>",
|
||||
"Deployment$description": "<p>The description for the deployment resource.</p>",
|
||||
|
|
@ -1607,7 +1608,7 @@
|
|||
"DocumentationVersion$version": "<p>The version identifier of the API documentation snapshot.</p>",
|
||||
"DocumentationVersion$description": "<p>The description of the API documentation snapshot.</p>",
|
||||
"DocumentationVersions$position": null,
|
||||
"DomainName$domainName": "<p>The name of the <a>DomainName</a> resource.</p>",
|
||||
"DomainName$domainName": "<p>The custom domain name as an API host name, for example, <code>my-api.example.com</code>.</p>",
|
||||
"DomainName$certificateName": "<p>The name of the certificate that will be used by edge-optimized endpoint for this domain name.</p>",
|
||||
"DomainName$certificateArn": "<p>The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.</p>",
|
||||
"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>",
|
||||
|
|
@ -1621,27 +1622,27 @@
|
|||
"ExportResponse$contentDisposition": "<p>The content-disposition header value in the HTTP response.</p>",
|
||||
"FlushStageAuthorizersCacheRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"FlushStageAuthorizersCacheRequest$stageName": "<p>The name of the stage to flush.</p>",
|
||||
"FlushStageCacheRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"FlushStageCacheRequest$stageName": "<p>The name of the stage to flush its cache.</p>",
|
||||
"FlushStageCacheRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"FlushStageCacheRequest$stageName": "<p>[Required] The name of the stage to flush its cache.</p>",
|
||||
"GatewayResponses$position": null,
|
||||
"GenerateClientCertificateRequest$description": "<p>The description of the <a>ClientCertificate</a>.</p>",
|
||||
"GetApiKeyRequest$apiKey": "<p>The identifier of the <a>ApiKey</a> resource.</p>",
|
||||
"GetApiKeyRequest$apiKey": "<p>[Required] The identifier of the <a>ApiKey</a> resource.</p>",
|
||||
"GetApiKeysRequest$position": "<p>The current pagination position in the paged result set.</p>",
|
||||
"GetApiKeysRequest$nameQuery": "<p>The name of queried API keys.</p>",
|
||||
"GetApiKeysRequest$customerId": "<p>The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.</p>",
|
||||
"GetAuthorizerRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetAuthorizerRequest$authorizerId": "<p>The identifier of the <a>Authorizer</a> resource.</p>",
|
||||
"GetAuthorizersRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetAuthorizerRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetAuthorizerRequest$authorizerId": "<p>[Required] The identifier of the <a>Authorizer</a> resource.</p>",
|
||||
"GetAuthorizersRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetAuthorizersRequest$position": "<p>The current pagination position in the paged result set.</p>",
|
||||
"GetBasePathMappingRequest$domainName": "<p>The domain name of the <a>BasePathMapping</a> resource to be described.</p>",
|
||||
"GetBasePathMappingRequest$basePath": "<p>The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify any base path name after the domain name.</p>",
|
||||
"GetBasePathMappingsRequest$domainName": "<p>The domain name of a <a>BasePathMapping</a> resource.</p>",
|
||||
"GetBasePathMappingRequest$domainName": "<p>[Required] The domain name of the <a>BasePathMapping</a> resource to be described.</p>",
|
||||
"GetBasePathMappingRequest$basePath": "<p>[Required] The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify any base path name after the domain name.</p>",
|
||||
"GetBasePathMappingsRequest$domainName": "<p>[Required] The domain name of a <a>BasePathMapping</a> resource.</p>",
|
||||
"GetBasePathMappingsRequest$position": "<p>The current pagination position in the paged result set.</p>",
|
||||
"GetClientCertificateRequest$clientCertificateId": "<p>The identifier of the <a>ClientCertificate</a> resource to be described.</p>",
|
||||
"GetClientCertificateRequest$clientCertificateId": "<p>[Required] The identifier of the <a>ClientCertificate</a> resource to be described.</p>",
|
||||
"GetClientCertificatesRequest$position": "<p>The current pagination position in the paged result set.</p>",
|
||||
"GetDeploymentRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetDeploymentRequest$deploymentId": "<p>The identifier of the <a>Deployment</a> resource to get information about.</p>",
|
||||
"GetDeploymentsRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetDeploymentRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetDeploymentRequest$deploymentId": "<p>[Required] The identifier of the <a>Deployment</a> resource to get information about.</p>",
|
||||
"GetDeploymentsRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetDeploymentsRequest$position": "<p>The current pagination position in the paged result set.</p>",
|
||||
"GetDocumentationPartRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetDocumentationPartRequest$documentationPartId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
|
|
@ -1653,66 +1654,66 @@
|
|||
"GetDocumentationVersionRequest$documentationVersion": "<p>[Required] The version identifier of the to-be-retrieved documentation snapshot.</p>",
|
||||
"GetDocumentationVersionsRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetDocumentationVersionsRequest$position": "<p>The current pagination position in the paged result set.</p>",
|
||||
"GetDomainNameRequest$domainName": "<p>The name of the <a>DomainName</a> resource.</p>",
|
||||
"GetDomainNameRequest$domainName": "<p>[Required] The name of the <a>DomainName</a> resource.</p>",
|
||||
"GetDomainNamesRequest$position": "<p>The current pagination position in the paged result set.</p>",
|
||||
"GetExportRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetExportRequest$stageName": "<p>The name of the <a>Stage</a> that will be exported.</p>",
|
||||
"GetExportRequest$exportType": "<p>The type of export. Currently only 'swagger' is supported.</p>",
|
||||
"GetExportRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetExportRequest$stageName": "<p>[Required] The name of the <a>Stage</a> that will be exported.</p>",
|
||||
"GetExportRequest$exportType": "<p>[Required] The type of export. Currently only 'swagger' is supported.</p>",
|
||||
"GetExportRequest$accepts": "<p>The content-type of the export, for example <code>application/json</code>. Currently <code>application/json</code> and <code>application/yaml</code> are supported for <code>exportType</code> of <code>swagger</code>. This should be specified in the <code>Accept</code> header for direct API requests.</p>",
|
||||
"GetGatewayResponseRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetGatewayResponsesRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetGatewayResponseRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetGatewayResponsesRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetGatewayResponsesRequest$position": "<p>The current pagination position in the paged result set. The <a>GatewayResponse</a> collection does not support pagination and the position does not apply here.</p>",
|
||||
"GetIntegrationRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetIntegrationRequest$resourceId": "<p>Specifies a get integration request's resource identifier</p>",
|
||||
"GetIntegrationRequest$httpMethod": "<p>Specifies a get integration request's HTTP method.</p>",
|
||||
"GetIntegrationResponseRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetIntegrationResponseRequest$resourceId": "<p>Specifies a get integration response request's resource identifier.</p>",
|
||||
"GetIntegrationResponseRequest$httpMethod": "<p>Specifies a get integration response request's HTTP method.</p>",
|
||||
"GetMethodRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetMethodRequest$resourceId": "<p>The <a>Resource</a> identifier for the <a>Method</a> resource.</p>",
|
||||
"GetMethodRequest$httpMethod": "<p>Specifies the method request's HTTP method type.</p>",
|
||||
"GetMethodResponseRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetMethodResponseRequest$resourceId": "<p>The <a>Resource</a> identifier for the <a>MethodResponse</a> resource.</p>",
|
||||
"GetMethodResponseRequest$httpMethod": "<p>The HTTP verb of the <a>Method</a> resource.</p>",
|
||||
"GetModelRequest$restApiId": "<p>The <a>RestApi</a> identifier under which the <a>Model</a> exists.</p>",
|
||||
"GetModelRequest$modelName": "<p>The name of the model as an identifier.</p>",
|
||||
"GetModelTemplateRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetModelTemplateRequest$modelName": "<p>The name of the model for which to generate a template.</p>",
|
||||
"GetModelsRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetIntegrationRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetIntegrationRequest$resourceId": "<p>[Required] Specifies a get integration request's resource identifier</p>",
|
||||
"GetIntegrationRequest$httpMethod": "<p>[Required] Specifies a get integration request's HTTP method.</p>",
|
||||
"GetIntegrationResponseRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetIntegrationResponseRequest$resourceId": "<p>[Required] Specifies a get integration response request's resource identifier.</p>",
|
||||
"GetIntegrationResponseRequest$httpMethod": "<p>[Required] Specifies a get integration response request's HTTP method.</p>",
|
||||
"GetMethodRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetMethodRequest$resourceId": "<p>[Required] The <a>Resource</a> identifier for the <a>Method</a> resource.</p>",
|
||||
"GetMethodRequest$httpMethod": "<p>[Required] Specifies the method request's HTTP method type.</p>",
|
||||
"GetMethodResponseRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetMethodResponseRequest$resourceId": "<p>[Required] The <a>Resource</a> identifier for the <a>MethodResponse</a> resource.</p>",
|
||||
"GetMethodResponseRequest$httpMethod": "<p>[Required] The HTTP verb of the <a>Method</a> resource.</p>",
|
||||
"GetModelRequest$restApiId": "<p>[Required] The <a>RestApi</a> identifier under which the <a>Model</a> exists.</p>",
|
||||
"GetModelRequest$modelName": "<p>[Required] The name of the model as an identifier.</p>",
|
||||
"GetModelTemplateRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetModelTemplateRequest$modelName": "<p>[Required] The name of the model for which to generate a template.</p>",
|
||||
"GetModelsRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetModelsRequest$position": "<p>The current pagination position in the paged result set.</p>",
|
||||
"GetRequestValidatorRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetRequestValidatorRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetRequestValidatorRequest$requestValidatorId": "<p>[Required] The identifier of the <a>RequestValidator</a> to be retrieved.</p>",
|
||||
"GetRequestValidatorsRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetRequestValidatorsRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetRequestValidatorsRequest$position": "<p>The current pagination position in the paged result set.</p>",
|
||||
"GetResourceRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetResourceRequest$resourceId": "<p>The identifier for the <a>Resource</a> resource.</p>",
|
||||
"GetResourcesRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetResourceRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetResourceRequest$resourceId": "<p>[Required] The identifier for the <a>Resource</a> resource.</p>",
|
||||
"GetResourcesRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetResourcesRequest$position": "<p>The current pagination position in the paged result set.</p>",
|
||||
"GetRestApiRequest$restApiId": "<p>The identifier of the <a>RestApi</a> resource.</p>",
|
||||
"GetRestApiRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetRestApisRequest$position": "<p>The current pagination position in the paged result set.</p>",
|
||||
"GetSdkRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetSdkRequest$stageName": "<p>The name of the <a>Stage</a> that the SDK will use.</p>",
|
||||
"GetSdkRequest$sdkType": "<p>The language for the generated SDK. Currently <code>java</code>, <code>javascript</code>, <code>android</code>, <code>objectivec</code> (for iOS), <code>swift</code> (for iOS), and <code>ruby</code> are supported.</p>",
|
||||
"GetSdkTypeRequest$id": "<p>The identifier of the queried <a>SdkType</a> instance.</p>",
|
||||
"GetSdkRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetSdkRequest$stageName": "<p>[Required] The name of the <a>Stage</a> that the SDK will use.</p>",
|
||||
"GetSdkRequest$sdkType": "<p>[Required] The language for the generated SDK. Currently <code>java</code>, <code>javascript</code>, <code>android</code>, <code>objectivec</code> (for iOS), <code>swift</code> (for iOS), and <code>ruby</code> are supported.</p>",
|
||||
"GetSdkTypeRequest$id": "<p>[Required] The identifier of the queried <a>SdkType</a> instance.</p>",
|
||||
"GetSdkTypesRequest$position": "<p>The current pagination position in the paged result set.</p>",
|
||||
"GetStageRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetStageRequest$stageName": "<p>The name of the <a>Stage</a> resource to get information about.</p>",
|
||||
"GetStagesRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetStageRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetStageRequest$stageName": "<p>[Required] The name of the <a>Stage</a> resource to get information about.</p>",
|
||||
"GetStagesRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"GetStagesRequest$deploymentId": "<p>The stages' deployment identifiers.</p>",
|
||||
"GetTagsRequest$resourceArn": "<p>[Required] The ARN of a resource that can be tagged. At present, <a>Stage</a> is the only taggable resource.</p>",
|
||||
"GetTagsRequest$resourceArn": "<p>[Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded. At present, <a>Stage</a> is the only taggable resource.</p>",
|
||||
"GetTagsRequest$position": "<p>(Not currently supported) The current pagination position in the paged result set.</p>",
|
||||
"GetUsagePlanKeyRequest$usagePlanId": "<p>The Id of the <a>UsagePlan</a> resource representing the usage plan containing the to-be-retrieved <a>UsagePlanKey</a> resource representing a plan customer.</p>",
|
||||
"GetUsagePlanKeyRequest$keyId": "<p>The key Id of the to-be-retrieved <a>UsagePlanKey</a> resource representing a plan customer.</p>",
|
||||
"GetUsagePlanKeysRequest$usagePlanId": "<p>The Id of the <a>UsagePlan</a> resource representing the usage plan containing the to-be-retrieved <a>UsagePlanKey</a> resource representing a plan customer.</p>",
|
||||
"GetUsagePlanKeyRequest$usagePlanId": "<p>[Required] The Id of the <a>UsagePlan</a> resource representing the usage plan containing the to-be-retrieved <a>UsagePlanKey</a> resource representing a plan customer.</p>",
|
||||
"GetUsagePlanKeyRequest$keyId": "<p>[Required] The key Id of the to-be-retrieved <a>UsagePlanKey</a> resource representing a plan customer.</p>",
|
||||
"GetUsagePlanKeysRequest$usagePlanId": "<p>[Required] The Id of the <a>UsagePlan</a> resource representing the usage plan containing the to-be-retrieved <a>UsagePlanKey</a> resource representing a plan customer.</p>",
|
||||
"GetUsagePlanKeysRequest$position": "<p>The current pagination position in the paged result set.</p>",
|
||||
"GetUsagePlanKeysRequest$nameQuery": "<p>A query parameter specifying the name of the to-be-returned usage plan keys.</p>",
|
||||
"GetUsagePlanRequest$usagePlanId": "<p>The identifier of the <a>UsagePlan</a> resource to be retrieved.</p>",
|
||||
"GetUsagePlanRequest$usagePlanId": "<p>[Required] The identifier of the <a>UsagePlan</a> resource to be retrieved.</p>",
|
||||
"GetUsagePlansRequest$position": "<p>The current pagination position in the paged result set.</p>",
|
||||
"GetUsagePlansRequest$keyId": "<p>The identifier of the API key associated with the usage plans.</p>",
|
||||
"GetUsageRequest$usagePlanId": "<p>The Id of the usage plan associated with the usage data.</p>",
|
||||
"GetUsageRequest$usagePlanId": "<p>[Required] The Id of the usage plan associated with the usage data.</p>",
|
||||
"GetUsageRequest$keyId": "<p>The Id of the API key associated with the resultant usage data.</p>",
|
||||
"GetUsageRequest$startDate": "<p>The starting date (e.g., 2016-01-01) of the usage data.</p>",
|
||||
"GetUsageRequest$endDate": "<p>The ending date (e.g., 2016-12-31) of the usage data.</p>",
|
||||
"GetUsageRequest$startDate": "<p>[Required] The starting date (e.g., 2016-01-01) of the usage data.</p>",
|
||||
"GetUsageRequest$endDate": "<p>[Required] The ending date (e.g., 2016-12-31) of the usage data.</p>",
|
||||
"GetUsageRequest$position": "<p>The current pagination position in the paged result set.</p>",
|
||||
"GetVpcLinkRequest$vpcLinkId": "<p>[Required] The identifier of the <a>VpcLink</a>. It is used in an <a>Integration</a> to reference this <a>VpcLink</a>.</p>",
|
||||
"GetVpcLinksRequest$position": "<p>The current pagination position in the paged result set.</p>",
|
||||
|
|
@ -1749,7 +1750,7 @@
|
|||
"Model$id": "<p>The identifier for the model resource.</p>",
|
||||
"Model$name": "<p>The name of the model. Must be an alphanumeric string.</p>",
|
||||
"Model$description": "<p>The description of the model.</p>",
|
||||
"Model$schema": "<p>The schema for the model. For <code>application/json</code> models, this should be <a href=\"http://json-schema.org/documentation.html\" target=\"_blank\">JSON-schema draft v4</a> model. Do not include \"\\*/\" characters in the description of any properties because such \"\\*/\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.</p>",
|
||||
"Model$schema": "<p>The schema for the model. For <code>application/json</code> models, this should be <a href=\"https://tools.ietf.org/html/draft-zyp-json-schema-04\" target=\"_blank\">JSON schema draft 4</a> model. Do not include \"\\*/\" characters in the description of any properties because such \"\\*/\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.</p>",
|
||||
"Model$contentType": "<p>The content-type for the model.</p>",
|
||||
"Models$position": null,
|
||||
"NotFoundException$message": null,
|
||||
|
|
@ -1757,31 +1758,31 @@
|
|||
"PatchOperation$value": "<p>The new target value of the update operation. It is applicable for the <code>add</code> or <code>replace</code> operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., '{\"a\": ...}'. In a Windows shell, see <a href=\"http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json\">Using JSON for Parameters</a>.</p>",
|
||||
"PatchOperation$from": "<p>The <code>copy</code> update operation's source as identified by a <code>JSON-Pointer</code> value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a <a>Stage</a> resource with <code>\"op\":\"copy\"</code>, <code>\"from\":\"/canarySettings/deploymentId\"</code> and <code>\"path\":\"/deploymentId\"</code>.</p>",
|
||||
"PathToMapOfMethodSnapshot$key": null,
|
||||
"PutGatewayResponseRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"PutIntegrationRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"PutIntegrationRequest$resourceId": "<p>Specifies a put integration request's resource ID.</p>",
|
||||
"PutIntegrationRequest$httpMethod": "<p>Specifies a put integration request's HTTP method.</p>",
|
||||
"PutGatewayResponseRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"PutIntegrationRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"PutIntegrationRequest$resourceId": "<p>[Required] Specifies a put integration request's resource ID.</p>",
|
||||
"PutIntegrationRequest$httpMethod": "<p>[Required] Specifies a put integration request's HTTP method.</p>",
|
||||
"PutIntegrationRequest$integrationHttpMethod": "<p>Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.</p>",
|
||||
"PutIntegrationRequest$uri": "<p>Specifies Uniform Resource Identifier (URI) of the integration endpoint.</p> <ul> <li><p> For <code>HTTP</code> or <code>HTTP_PROXY</code> integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the <a target=\"_blank\" href=\"https://en.wikipedia.org/wiki/Uniform_Resource_Identifier\">RFC-3986 specification</a>, for either standard integration, where <code>connectionType</code> is not <code>VPC_LINK</code>, or private integration, where <code>connectionType</code> is <code>VPC_LINK</code>. For a private HTTP integration, the URI is not used for routing. </p> </li> <li><p> For <code>AWS</code> or <code>AWS_PROXY</code> integrations, the URI is of the form <code>arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}</code>. Here, <code>{Region}</code> is the API Gateway region (e.g., <code>us-east-1</code>); <code>{service}</code> is the name of the integrated AWS service (e.g., <code>s3</code>); and <code>{subdomain}</code> is a designated subdomain supported by certain AWS service for fast host-name lookup. <code>action</code> can be used for an AWS service action-based API, using an <code>Action={name}&{p1}={v1}&p2={v2}...</code> query string. The ensuing <code>{service_api}</code> refers to a supported action <code>{name}</code> plus any required input parameters. Alternatively, <code>path</code> can be used for an AWS service path-based API. The ensuing <code>service_api</code> refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of <code><a href=\"http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html\">GetObject</a></code>, the <code>uri</code> can be either <code>arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}</code> or <code>arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}</code></p> </li></ul>",
|
||||
"PutIntegrationRequest$connectionId": "<p>The (<a href=\"http://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>",
|
||||
"PutIntegrationRequest$credentials": "<p>Specifies whether credentials are required for a put integration.</p>",
|
||||
"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>",
|
||||
"PutIntegrationRequest$cacheNamespace": "<p>Specifies a put integration input's cache namespace.</p>",
|
||||
"PutIntegrationResponseRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"PutIntegrationResponseRequest$resourceId": "<p>Specifies a put integration response request's resource identifier.</p>",
|
||||
"PutIntegrationResponseRequest$httpMethod": "<p>Specifies a put integration response request's HTTP method.</p>",
|
||||
"PutIntegrationResponseRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"PutIntegrationResponseRequest$resourceId": "<p>[Required] Specifies a put integration response request's resource identifier.</p>",
|
||||
"PutIntegrationResponseRequest$httpMethod": "<p>[Required] Specifies a put integration response request's HTTP method.</p>",
|
||||
"PutIntegrationResponseRequest$selectionPattern": "<p>Specifies the selection pattern of a put integration response.</p>",
|
||||
"PutMethodRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"PutMethodRequest$resourceId": "<p>The <a>Resource</a> identifier for the new <a>Method</a> resource.</p>",
|
||||
"PutMethodRequest$httpMethod": "<p>Specifies the method request's HTTP method type.</p>",
|
||||
"PutMethodRequest$authorizationType": "<p>The method's authorization type. Valid values are <code>NONE</code> for open access, <code>AWS_IAM</code> for using AWS IAM permissions, <code>CUSTOM</code> for using a custom authorizer, or <code>COGNITO_USER_POOLS</code> for using a Cognito user pool.</p>",
|
||||
"PutMethodRequest$authorizerId": "<p>Specifies the identifier of an <a>Authorizer</a> to use on this Method, if the type is CUSTOM.</p>",
|
||||
"PutMethodRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"PutMethodRequest$resourceId": "<p>[Required] The <a>Resource</a> identifier for the new <a>Method</a> resource.</p>",
|
||||
"PutMethodRequest$httpMethod": "<p>[Required] Specifies the method request's HTTP method type.</p>",
|
||||
"PutMethodRequest$authorizationType": "<p>[Required] The method's authorization type. Valid values are <code>NONE</code> for open access, <code>AWS_IAM</code> for using AWS IAM permissions, <code>CUSTOM</code> for using a custom authorizer, or <code>COGNITO_USER_POOLS</code> for using a Cognito user pool.</p>",
|
||||
"PutMethodRequest$authorizerId": "<p>Specifies the identifier of an <a>Authorizer</a> to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>",
|
||||
"PutMethodRequest$operationName": "<p>A human-friendly operation identifier for the method. For example, you can assign the <code>operationName</code> of <code>ListPets</code> for the <code>GET /pets</code> method in <a href=\"http://petstore-demo-endpoint.execute-api.com/petstore/pets\">PetStore</a> example.</p>",
|
||||
"PutMethodRequest$requestValidatorId": "<p>The identifier of a <a>RequestValidator</a> for validating the method request.</p>",
|
||||
"PutMethodResponseRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"PutMethodResponseRequest$resourceId": "<p>The <a>Resource</a> identifier for the <a>Method</a> resource.</p>",
|
||||
"PutMethodResponseRequest$httpMethod": "<p>The HTTP verb of the <a>Method</a> resource.</p>",
|
||||
"PutRestApiRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"PutMethodResponseRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"PutMethodResponseRequest$resourceId": "<p>[Required] The <a>Resource</a> identifier for the <a>Method</a> resource.</p>",
|
||||
"PutMethodResponseRequest$httpMethod": "<p>[Required] The HTTP verb of the <a>Method</a> resource.</p>",
|
||||
"PutRestApiRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"RequestValidator$id": "<p>The identifier of this <a>RequestValidator</a>.</p>",
|
||||
"RequestValidator$name": "<p>The name of this <a>RequestValidator</a></p>",
|
||||
"RequestValidators$position": null,
|
||||
|
|
@ -1794,6 +1795,7 @@
|
|||
"RestApi$name": "<p>The API's name.</p>",
|
||||
"RestApi$description": "<p>The API's description.</p>",
|
||||
"RestApi$version": "<p>A version identifier for the API.</p>",
|
||||
"RestApi$policy": "A stringified JSON policy document that applies to this RestApi regardless of the caller and <a>Method</a> configuration.",
|
||||
"RestApis$position": null,
|
||||
"SdkConfigurationProperty$name": "<p>The name of a an <a>SdkType</a> configuration property.</p>",
|
||||
"SdkConfigurationProperty$friendlyName": "<p>The user-friendly name of an <a>SdkType</a> configuration property.</p>",
|
||||
|
|
@ -1814,18 +1816,18 @@
|
|||
"Stage$documentationVersion": "<p>The version of the associated API documentation.</p>",
|
||||
"StageKey$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"StageKey$stageName": "<p>The stage name associated with the stage key.</p>",
|
||||
"TagResourceRequest$resourceArn": "<p>[Required] The ARN of a resource that can be tagged. At present, <a>Stage</a> is the only taggable resource.</p>",
|
||||
"TagResourceRequest$resourceArn": "<p>[Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded. At present, <a>Stage</a> is the only taggable resource.</p>",
|
||||
"Template$value": "<p>The Apache <a href=\"http://velocity.apache.org/engine/devel/vtl-reference-guide.html\" target=\"_blank\">Velocity Template Language (VTL)</a> template content used for the template resource.</p>",
|
||||
"TestInvokeAuthorizerRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"TestInvokeAuthorizerRequest$authorizerId": "<p>Specifies a test invoke authorizer request's <a>Authorizer</a> ID.</p>",
|
||||
"TestInvokeAuthorizerRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"TestInvokeAuthorizerRequest$authorizerId": "<p>[Required] Specifies a test invoke authorizer request's <a>Authorizer</a> ID.</p>",
|
||||
"TestInvokeAuthorizerRequest$pathWithQueryString": "<p>[Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.</p>",
|
||||
"TestInvokeAuthorizerRequest$body": "<p>[Optional] The simulated request body of an incoming invocation request.</p>",
|
||||
"TestInvokeAuthorizerResponse$log": "<p>The API Gateway execution log for the test authorizer request.</p>",
|
||||
"TestInvokeAuthorizerResponse$principalId": "<p>The principal identity returned by the <a>Authorizer</a></p>",
|
||||
"TestInvokeAuthorizerResponse$policy": "<p>The JSON policy document returned by the <a>Authorizer</a></p>",
|
||||
"TestInvokeMethodRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"TestInvokeMethodRequest$resourceId": "<p>Specifies a test invoke method request's resource ID.</p>",
|
||||
"TestInvokeMethodRequest$httpMethod": "<p>Specifies a test invoke method request's HTTP method.</p>",
|
||||
"TestInvokeMethodRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"TestInvokeMethodRequest$resourceId": "<p>[Required] Specifies a test invoke method request's resource ID.</p>",
|
||||
"TestInvokeMethodRequest$httpMethod": "<p>[Required] Specifies a test invoke method request's HTTP method.</p>",
|
||||
"TestInvokeMethodRequest$pathWithQueryString": "<p>The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.</p>",
|
||||
"TestInvokeMethodRequest$body": "<p>The simulated request body of an incoming invocation request.</p>",
|
||||
"TestInvokeMethodRequest$clientCertificateId": "<p>A <a>ClientCertificate</a> identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.</p>",
|
||||
|
|
@ -1834,45 +1836,45 @@
|
|||
"TooManyRequestsException$retryAfterSeconds": null,
|
||||
"TooManyRequestsException$message": null,
|
||||
"UnauthorizedException$message": null,
|
||||
"UntagResourceRequest$resourceArn": "<p>[Required] The ARN of a resource that can be tagged. At present, <a>Stage</a> is the only taggable resource.</p>",
|
||||
"UpdateApiKeyRequest$apiKey": "<p>The identifier of the <a>ApiKey</a> resource to be updated.</p>",
|
||||
"UpdateAuthorizerRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"UpdateAuthorizerRequest$authorizerId": "<p>The identifier of the <a>Authorizer</a> resource.</p>",
|
||||
"UpdateBasePathMappingRequest$domainName": "<p>The domain name of the <a>BasePathMapping</a> resource to change.</p>",
|
||||
"UpdateBasePathMappingRequest$basePath": "<p>The base path of the <a>BasePathMapping</a> resource to change.</p>",
|
||||
"UpdateClientCertificateRequest$clientCertificateId": "<p>The identifier of the <a>ClientCertificate</a> resource to be updated.</p>",
|
||||
"UpdateDeploymentRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"UntagResourceRequest$resourceArn": "<p>[Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded. At present, <a>Stage</a> is the only taggable resource.</p>",
|
||||
"UpdateApiKeyRequest$apiKey": "<p>[Required] The identifier of the <a>ApiKey</a> resource to be updated.</p>",
|
||||
"UpdateAuthorizerRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"UpdateAuthorizerRequest$authorizerId": "<p>[Required] The identifier of the <a>Authorizer</a> resource.</p>",
|
||||
"UpdateBasePathMappingRequest$domainName": "<p>[Required] The domain name of the <a>BasePathMapping</a> resource to change.</p>",
|
||||
"UpdateBasePathMappingRequest$basePath": "<p>[Required] The base path of the <a>BasePathMapping</a> resource to change.</p>",
|
||||
"UpdateClientCertificateRequest$clientCertificateId": "<p>[Required] The identifier of the <a>ClientCertificate</a> resource to be updated.</p>",
|
||||
"UpdateDeploymentRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"UpdateDeploymentRequest$deploymentId": "<p>The replacement identifier for the <a>Deployment</a> resource to change information about.</p>",
|
||||
"UpdateDocumentationPartRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"UpdateDocumentationPartRequest$documentationPartId": "<p>[Required] The identifier of the to-be-updated documentation part.</p>",
|
||||
"UpdateDocumentationVersionRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>..</p>",
|
||||
"UpdateDocumentationVersionRequest$documentationVersion": "<p>[Required] The version identifier of the to-be-updated documentation version.</p>",
|
||||
"UpdateDomainNameRequest$domainName": "<p>The name of the <a>DomainName</a> resource to be changed.</p>",
|
||||
"UpdateGatewayResponseRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"UpdateIntegrationRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"UpdateIntegrationRequest$resourceId": "<p>Represents an update integration request's resource identifier.</p>",
|
||||
"UpdateIntegrationRequest$httpMethod": "<p>Represents an update integration request's HTTP method.</p>",
|
||||
"UpdateIntegrationResponseRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"UpdateIntegrationResponseRequest$resourceId": "<p>Specifies an update integration response request's resource identifier.</p>",
|
||||
"UpdateIntegrationResponseRequest$httpMethod": "<p>Specifies an update integration response request's HTTP method.</p>",
|
||||
"UpdateMethodRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"UpdateMethodRequest$resourceId": "<p>The <a>Resource</a> identifier for the <a>Method</a> resource.</p>",
|
||||
"UpdateMethodRequest$httpMethod": "<p>The HTTP verb of the <a>Method</a> resource.</p>",
|
||||
"UpdateMethodResponseRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"UpdateMethodResponseRequest$resourceId": "<p>The <a>Resource</a> identifier for the <a>MethodResponse</a> resource.</p>",
|
||||
"UpdateMethodResponseRequest$httpMethod": "<p>The HTTP verb of the <a>Method</a> resource.</p>",
|
||||
"UpdateModelRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"UpdateModelRequest$modelName": "<p>The name of the model to update.</p>",
|
||||
"UpdateRequestValidatorRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"UpdateDomainNameRequest$domainName": "<p>[Required] The name of the <a>DomainName</a> resource to be changed.</p>",
|
||||
"UpdateGatewayResponseRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"UpdateIntegrationRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"UpdateIntegrationRequest$resourceId": "<p>[Required] Represents an update integration request's resource identifier.</p>",
|
||||
"UpdateIntegrationRequest$httpMethod": "<p>[Required] Represents an update integration request's HTTP method.</p>",
|
||||
"UpdateIntegrationResponseRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"UpdateIntegrationResponseRequest$resourceId": "<p>[Required] Specifies an update integration response request's resource identifier.</p>",
|
||||
"UpdateIntegrationResponseRequest$httpMethod": "<p>[Required] Specifies an update integration response request's HTTP method.</p>",
|
||||
"UpdateMethodRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"UpdateMethodRequest$resourceId": "<p>[Required] The <a>Resource</a> identifier for the <a>Method</a> resource.</p>",
|
||||
"UpdateMethodRequest$httpMethod": "<p>[Required] The HTTP verb of the <a>Method</a> resource.</p>",
|
||||
"UpdateMethodResponseRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"UpdateMethodResponseRequest$resourceId": "<p>[Required] The <a>Resource</a> identifier for the <a>MethodResponse</a> resource.</p>",
|
||||
"UpdateMethodResponseRequest$httpMethod": "<p>[Required] The HTTP verb of the <a>Method</a> resource.</p>",
|
||||
"UpdateModelRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"UpdateModelRequest$modelName": "<p>[Required] The name of the model to update.</p>",
|
||||
"UpdateRequestValidatorRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"UpdateRequestValidatorRequest$requestValidatorId": "<p>[Required] The identifier of <a>RequestValidator</a> to be updated.</p>",
|
||||
"UpdateResourceRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"UpdateResourceRequest$resourceId": "<p>The identifier of the <a>Resource</a> resource.</p>",
|
||||
"UpdateRestApiRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"UpdateStageRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"UpdateStageRequest$stageName": "<p>The name of the <a>Stage</a> resource to change information about.</p>",
|
||||
"UpdateUsagePlanRequest$usagePlanId": "<p>The Id of the to-be-updated usage plan.</p>",
|
||||
"UpdateUsageRequest$usagePlanId": "<p>The Id of the usage plan associated with the usage data.</p>",
|
||||
"UpdateUsageRequest$keyId": "<p>The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.</p>",
|
||||
"UpdateResourceRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"UpdateResourceRequest$resourceId": "<p>[Required] The identifier of the <a>Resource</a> resource.</p>",
|
||||
"UpdateRestApiRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"UpdateStageRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
|
||||
"UpdateStageRequest$stageName": "<p>[Required] The name of the <a>Stage</a> resource to change information about.</p>",
|
||||
"UpdateUsagePlanRequest$usagePlanId": "<p>[Required] The Id of the to-be-updated usage plan.</p>",
|
||||
"UpdateUsageRequest$usagePlanId": "<p>[Required] The Id of the usage plan associated with the usage data.</p>",
|
||||
"UpdateUsageRequest$keyId": "<p>[Required] The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.</p>",
|
||||
"UpdateVpcLinkRequest$vpcLinkId": "<p>[Required] The identifier of the <a>VpcLink</a>. It is used in an <a>Integration</a> to reference this <a>VpcLink</a>.</p>",
|
||||
"Usage$usagePlanId": "<p>The plan Id associated with this usage data.</p>",
|
||||
"Usage$startDate": "<p>The starting date of the usage data.</p>",
|
||||
|
|
@ -1896,12 +1898,12 @@
|
|||
}
|
||||
},
|
||||
"TagResourceRequest": {
|
||||
"base": "<p>Adds or updates Tags on a gievn resource.</p>",
|
||||
"base": "<p>Adds or updates a tag on a given resource.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Tags": {
|
||||
"base": "<p>A collection of Tags associated with a given resource.</p>",
|
||||
"base": "<p>The collection of tags. Each tag element is associated with a given resource.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
|
|
@ -1970,7 +1972,7 @@
|
|||
}
|
||||
},
|
||||
"UntagResourceRequest": {
|
||||
"base": "<p>Removes Tags from a given resource.</p>",
|
||||
"base": "<p>Removes a tag from a given resource.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue