Amazon API Gateway helps developers deliver robust, secure and scalable mobile and web application backends. Amazon API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
", "operations": { "CreateApiKey": "Create an ApiKey resource.
", "CreateAuthorizer": "Adds a new Authorizer resource to an existing RestApi resource.
", "CreateBasePathMapping": "Creates a new BasePathMapping resource.
", "CreateDeployment": "Creates a Deployment resource, which makes a specified RestApi callable over the internet.
", "CreateDomainName": "Creates a new domain name.
", "CreateModel": "Adds a new Model resource to an existing RestApi resource.
", "CreateResource": "Creates a Resource resource.
", "CreateRestApi": "Creates a new RestApi resource.
", "CreateStage": "Creates a new Stage resource that references a pre-existing Deployment for the API.
", "DeleteApiKey": "Deletes the ApiKey resource.
", "DeleteAuthorizer": "Deletes an existing Authorizer resource.
", "DeleteBasePathMapping": "Deletes the BasePathMapping resource.
", "DeleteClientCertificate": "Deletes the ClientCertificate resource.
", "DeleteDeployment": "Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
", "DeleteDomainName": "Deletes the DomainName resource.
", "DeleteIntegration": "Represents a delete integration.
", "DeleteIntegrationResponse": "Represents a delete integration response.
", "DeleteMethod": "Deletes an existing Method resource.
", "DeleteMethodResponse": "Deletes an existing MethodResponse resource.
", "DeleteModel": "Deletes a model.
", "DeleteResource": "Deletes a Resource resource.
", "DeleteRestApi": "Deletes the specified API.
", "DeleteStage": "Deletes a Stage resource.
", "FlushStageAuthorizersCache": "Flushes all authorizer cache entries on a stage.
", "FlushStageCache": "Flushes a stage's cache.
", "GenerateClientCertificate": "Generates a ClientCertificate resource.
", "GetAccount": "Gets information about the current Account resource.
", "GetApiKey": "Gets information about the current ApiKey resource.
", "GetApiKeys": "Gets information about the current ApiKeys resource.
", "GetAuthorizer": "Describe an existing Authorizer resource.
", "GetAuthorizers": "Describe an existing Authorizers resource.
", "GetBasePathMapping": "Describe a BasePathMapping resource.
", "GetBasePathMappings": "Represents a collection of BasePathMapping resources.
", "GetClientCertificate": "Gets information about the current ClientCertificate resource.
", "GetClientCertificates": "Gets a collection of ClientCertificate resources.
", "GetDeployment": "Gets information about a Deployment resource.
", "GetDeployments": "Gets information about a Deployments collection.
", "GetDomainName": "Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
", "GetDomainNames": "Represents a collection of DomainName resources.
", "GetExport": "Exports a deployed version of a RestApi in a specified format.
", "GetIntegration": "Represents a get integration.
", "GetIntegrationResponse": "Represents a get integration response.
", "GetMethod": "Describe an existing Method resource.
", "GetMethodResponse": "Describes a MethodResponse resource.
", "GetModel": "Describes an existing model defined for a RestApi resource.
", "GetModelTemplate": "Generates a sample mapping template that can be used to transform a payload into the structure of a model.
", "GetModels": "Describes existing Models defined for a RestApi resource.
", "GetResource": "Lists information about a resource.
", "GetResources": "Lists information about a collection of Resource resources.
", "GetRestApi": "Lists the RestApi resource in the collection.
", "GetRestApis": "Lists the RestApis resources for your collection.
", "GetSdk": "Generates a client SDK for a RestApi and Stage.
", "GetStage": "Gets information about a Stage resource.
", "GetStages": "Gets information about one or more Stage resources.
", "ImportRestApi": "A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.
", "PutIntegration": "Represents a put integration.
", "PutIntegrationResponse": "Represents a put integration.
", "PutMethod": "Add a method to an existing Resource resource.
", "PutMethodResponse": "Adds a MethodResponse to an existing Method resource.
", "PutRestApi": "A feature of the Amazon 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.
", "TestInvokeAuthorizer": "Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
", "TestInvokeMethod": "Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
", "UpdateAccount": "Changes information about the current Account resource.
", "UpdateApiKey": "Changes information about an ApiKey resource.
", "UpdateAuthorizer": "Updates an existing Authorizer resource.
", "UpdateBasePathMapping": "Changes information about the BasePathMapping resource.
", "UpdateClientCertificate": "Changes information about an ClientCertificate resource.
", "UpdateDeployment": "Changes information about a Deployment resource.
", "UpdateDomainName": "Changes information about the DomainName resource.
", "UpdateIntegration": "Represents an update integration.
", "UpdateIntegrationResponse": "Represents an update integration response.
", "UpdateMethod": "Updates an existing Method resource.
", "UpdateMethodResponse": "Updates an existing MethodResponse resource.
", "UpdateModel": "Changes information about a model.
", "UpdateResource": "Changes information about a Resource resource.
", "UpdateRestApi": "Changes information about the specified API.
", "UpdateStage": "Changes information about a Stage resource.
" }, "shapes": { "Account": { "base": "Represents an AWS account that is associated with Amazon API Gateway.
", "refs": { } }, "ApiKey": { "base": "A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.
", "refs": { "ListOfApiKey$member": null } }, "ApiKeys": { "base": "Represents a collection of ApiKey resources.
", "refs": { } }, "Authorizer": { "base": "Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
", "refs": { "ListOfAuthorizer$member": null } }, "AuthorizerType": { "base": "The authorizer type. Only current value is TOKEN.
", "refs": { "Authorizer$type": "[Required] The type of the authorizer. Currently, the only valid type is TOKEN.
", "CreateAuthorizerRequest$type": "[Required] The type of the authorizer.
" } }, "Authorizers": { "base": "Represents a collection of Authorizer resources.
", "refs": { } }, "BadRequestException": { "base": null, "refs": { } }, "BasePathMapping": { "base": "Represents the base path that callers of the API that must provide as part of the URL after the domain name.
", "refs": { "ListOfBasePathMapping$member": null } }, "BasePathMappings": { "base": "Represents a collection of BasePathMapping resources.
", "refs": { } }, "Blob": { "base": null, "refs": { "ExportResponse$body": "The binary blob response to GetExport, which contains the export.
", "ImportRestApiRequest$body": "The POST request body containing external API definitions. Currently, only Swagger definition JSON files are supported.
", "PutRestApiRequest$body": "The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported.
", "SdkResponse$body": "The binary blob response to GetSdk, which contains the generated SDK.
" } }, "Boolean": { "base": null, "refs": { "ApiKey$enabled": "Specifies whether the API Key can be used by callers.
", "CreateApiKeyRequest$enabled": "Specifies whether the ApiKey can be used by callers.
", "CreateStageRequest$cacheClusterEnabled": "Whether cache clustering is enabled for the stage.
", "GetModelRequest$flatten": "Resolves all external model references and returns a flattened model schema.
", "ImportRestApiRequest$failOnWarnings": "A query parameter to indicate whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.
Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is /{method_setting_key}/metrics/enabled, and the value is a Boolean.
Specifies the whether data trace logging is enabled for this method, which effects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean.
Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is /{method_setting_key}/caching/enabled, and the value is a Boolean.
Specifies whether the cached responses are encrypted. The PATCH path for this setting is /{method_setting_key}/caching/dataEncrypted, and the value is a Boolean.
Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is /{method_setting_key}/caching/requireAuthorizationForCacheControl, and the value is a Boolean.
Specifies whether the method requires a valid ApiKey.
", "PutMethodRequest$apiKeyRequired": "Specifies whether the method required a valid ApiKey.
", "PutRestApiRequest$failOnWarnings": "A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.
Specifies whether a cache cluster is enabled for the stage.
" } }, "CacheClusterSize": { "base": "Returns the size of the CacheCluster.
", "refs": { "CreateDeploymentRequest$cacheClusterSize": "Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.
", "CreateStageRequest$cacheClusterSize": "The stage's cache cluster size.
", "Stage$cacheClusterSize": "The size of the cache cluster for the stage, if enabled.
" } }, "CacheClusterStatus": { "base": "Returns the status of the CacheCluster.
", "refs": { "Stage$cacheClusterStatus": "The status of the cache cluster for the stage, if enabled.
" } }, "ClientCertificate": { "base": "Represents a Client Certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
", "refs": { "ListOfClientCertificate$member": null } }, "ClientCertificates": { "base": "Represents a collection of ClientCertificate resources.
", "refs": { } }, "ConflictException": { "base": null, "refs": { } }, "CreateApiKeyRequest": { "base": "Request to create an ApiKey resource.
", "refs": { } }, "CreateAuthorizerRequest": { "base": "Request to add a new Authorizer to an existing RestApi resource.
", "refs": { } }, "CreateBasePathMappingRequest": { "base": "Requests Amazon API Gateway to create a new BasePathMapping resource.
", "refs": { } }, "CreateDeploymentRequest": { "base": "Requests Amazon API Gateway to create a Deployment resource.
", "refs": { } }, "CreateDomainNameRequest": { "base": "A request to create a new domain name.
", "refs": { } }, "CreateModelRequest": { "base": "Request to add a new Model to an existing RestApi resource.
", "refs": { } }, "CreateResourceRequest": { "base": "Requests Amazon API Gateway to create a Resource resource.
", "refs": { } }, "CreateRestApiRequest": { "base": "The POST Request to add a new RestApi resource to your collection.
", "refs": { } }, "CreateStageRequest": { "base": "Requests Amazon API Gateway to create a Stage resource.
", "refs": { } }, "DeleteApiKeyRequest": { "base": "A request to delete the ApiKey resource.
", "refs": { } }, "DeleteAuthorizerRequest": { "base": "Request to delete an existing Authorizer resource.
", "refs": { } }, "DeleteBasePathMappingRequest": { "base": "A request to delete the BasePathMapping resource.
", "refs": { } }, "DeleteClientCertificateRequest": { "base": "A request to delete the ClientCertificate resource.
", "refs": { } }, "DeleteDeploymentRequest": { "base": "Requests Amazon API Gateway to delete a Deployment resource.
", "refs": { } }, "DeleteDomainNameRequest": { "base": "A request to delete the DomainName resource.
", "refs": { } }, "DeleteIntegrationRequest": { "base": "Represents a delete integration request.
", "refs": { } }, "DeleteIntegrationResponseRequest": { "base": "Represents a delete integration response request.
", "refs": { } }, "DeleteMethodRequest": { "base": "Request to delete an existing Method resource.
", "refs": { } }, "DeleteMethodResponseRequest": { "base": "A request to delete an existing MethodResponse resource.
", "refs": { } }, "DeleteModelRequest": { "base": "Request to delete an existing model in an existing RestApi resource.
", "refs": { } }, "DeleteResourceRequest": { "base": "Request to delete a Resource.
", "refs": { } }, "DeleteRestApiRequest": { "base": "Request to delete the specified API from your collection.
", "refs": { } }, "DeleteStageRequest": { "base": "Requests Amazon API Gateway to delete a Stage resource.
", "refs": { } }, "Deployment": { "base": "An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.
", "refs": { "ListOfDeployment$member": null } }, "Deployments": { "base": "Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on ways to interact with your collection. The collection offers a paginated view of the contained deployments.
", "refs": { } }, "DomainName": { "base": "Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
", "refs": { "ListOfDomainName$member": null } }, "DomainNames": { "base": "Represents a collection of DomainName resources.
", "refs": { } }, "Double": { "base": null, "refs": { "MethodSetting$throttlingRateLimit": "Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double.
Returns the rateLimit when ThrottleSettings is called.
" } }, "ExportResponse": { "base": "The binary blob response to GetExport, which contains the generated SDK.
", "refs": { } }, "FlushStageAuthorizersCacheRequest": { "base": "Request to flush authorizer cache entries on a specified stage.
", "refs": { } }, "FlushStageCacheRequest": { "base": "Requests Amazon API Gateway to flush a stage's cache.
", "refs": { } }, "GenerateClientCertificateRequest": { "base": "A request to generate a ClientCertificate resource.
", "refs": { } }, "GetAccountRequest": { "base": "Requests Amazon API Gateway to get information about the current Account resource.
", "refs": { } }, "GetApiKeyRequest": { "base": "A request to get information about the current ApiKey resource.
", "refs": { } }, "GetApiKeysRequest": { "base": "A request to get information about the current ApiKeys resource.
", "refs": { } }, "GetAuthorizerRequest": { "base": "Request to describe an existing Authorizer resource.
", "refs": { } }, "GetAuthorizersRequest": { "base": "Request to describe an existing Authorizers resource.
", "refs": { } }, "GetBasePathMappingRequest": { "base": "Request to describe a BasePathMapping resource.
", "refs": { } }, "GetBasePathMappingsRequest": { "base": "A request to get information about a collection of BasePathMapping resources.
", "refs": { } }, "GetClientCertificateRequest": { "base": "A request to get information about the current ClientCertificate resource.
", "refs": { } }, "GetClientCertificatesRequest": { "base": "A request to get information about a collection of ClientCertificate resources.
", "refs": { } }, "GetDeploymentRequest": { "base": "Requests Amazon API Gateway to get information about a Deployment resource.
", "refs": { } }, "GetDeploymentsRequest": { "base": "Requests Amazon API Gateway to get information about a Deployments collection.
", "refs": { } }, "GetDomainNameRequest": { "base": "Request to get the name of a DomainName resource.
", "refs": { } }, "GetDomainNamesRequest": { "base": "Request to describe a collection of DomainName resources.
", "refs": { } }, "GetExportRequest": { "base": "Request a new export of a RestApi for a particular Stage.
", "refs": { } }, "GetIntegrationRequest": { "base": "Represents a get integration request.
", "refs": { } }, "GetIntegrationResponseRequest": { "base": "Represents a get integration response request.
", "refs": { } }, "GetMethodRequest": { "base": "Request to describe an existing Method resource.
", "refs": { } }, "GetMethodResponseRequest": { "base": "Request to describe a MethodResponse resource.
", "refs": { } }, "GetModelRequest": { "base": "Request to list information about a model in an existing RestApi resource.
", "refs": { } }, "GetModelTemplateRequest": { "base": "Request to generate a sample mapping template used to transform the payload.
", "refs": { } }, "GetModelsRequest": { "base": "Request to list existing Models defined for a RestApi resource.
", "refs": { } }, "GetResourceRequest": { "base": "Request to list information about a resource.
", "refs": { } }, "GetResourcesRequest": { "base": "Request to list information about a collection of resources.
", "refs": { } }, "GetRestApiRequest": { "base": "The GET request to list an existing RestApi defined for your collection.
", "refs": { } }, "GetRestApisRequest": { "base": "The GET request to list existing RestApis defined for your collection.
", "refs": { } }, "GetSdkRequest": { "base": "Request a new generated client SDK for a RestApi and Stage.
", "refs": { } }, "GetStageRequest": { "base": "Requests Amazon API Gateway to get information about a Stage resource.
", "refs": { } }, "GetStagesRequest": { "base": "Requests Amazon API Gateway to get information about one or more Stage resources.
", "refs": { } }, "ImportRestApiRequest": { "base": "A POST request to import an API to Amazon API Gateway using an input of an API definition file.
", "refs": { } }, "Integer": { "base": null, "refs": { "MethodSetting$throttlingBurstLimit": "Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.
Specifies the time to live (TTL) in seconds, for cached responses. The higher a the TTL, the longer the response will be cached. The PATCH path for this setting is /{method_setting_key}/caching/ttlInSeconds, and the value is an integer.
The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.
", "TestInvokeMethodResponse$status": "The HTTP status code.
", "ThrottleSettings$burstLimit": "Returns the burstLimit when ThrottleSettings is called.
" } }, "Integration": { "base": "Represents a HTTP, AWS, or Mock integration.
", "refs": { "Method$methodIntegration": "The method's integration.
" } }, "IntegrationResponse": { "base": "Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the backend response.
", "refs": { "MapOfIntegrationResponse$value": null } }, "IntegrationType": { "base": "The integration type. The valid value is HTTP, AWS, or MOCK.
Specifies the integration's type. The valid value is HTTP, AWS, or MOCK.
Specifies a put integration input's type.
" } }, "LimitExceededException": { "base": null, "refs": { } }, "ListOfARNs": { "base": null, "refs": { "Authorizer$providerARNs": null, "CreateAuthorizerRequest$providerARNs": null } }, "ListOfApiKey": { "base": null, "refs": { "ApiKeys$items": "The current page of any ApiKey resources in the collection of ApiKey resources.
" } }, "ListOfAuthorizer": { "base": null, "refs": { "Authorizers$items": "Gets the current list of Authorizer resources in the collection.
" } }, "ListOfBasePathMapping": { "base": null, "refs": { "BasePathMappings$items": "The current page of any BasePathMapping resources in the collection of base path mapping resources.
" } }, "ListOfClientCertificate": { "base": null, "refs": { "ClientCertificates$items": "The current page of any ClientCertificate resources in the collection of ClientCertificate resources.
" } }, "ListOfDeployment": { "base": null, "refs": { "Deployments$items": "The current page of any Deployment resources in the collection of deployment resources.
" } }, "ListOfDomainName": { "base": null, "refs": { "DomainNames$items": "The current page of any DomainName resources in the collection of DomainName resources.
" } }, "ListOfModel": { "base": null, "refs": { "Models$items": "Gets the current Model resource in the collection.
" } }, "ListOfPatchOperation": { "base": "A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.", "refs": { "UpdateAccountRequest$patchOperations": "A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
", "UpdateApiKeyRequest$patchOperations": "A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
", "UpdateAuthorizerRequest$patchOperations": "A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
", "UpdateBasePathMappingRequest$patchOperations": "A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
", "UpdateClientCertificateRequest$patchOperations": "A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
", "UpdateDeploymentRequest$patchOperations": "A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
", "UpdateDomainNameRequest$patchOperations": "A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
", "UpdateIntegrationRequest$patchOperations": "A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
", "UpdateIntegrationResponseRequest$patchOperations": "A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
", "UpdateMethodRequest$patchOperations": "A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
", "UpdateMethodResponseRequest$patchOperations": "A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
", "UpdateModelRequest$patchOperations": "A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
", "UpdateResourceRequest$patchOperations": "A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
", "UpdateRestApiRequest$patchOperations": "A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
", "UpdateStageRequest$patchOperations": "A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
" } }, "ListOfResource": { "base": null, "refs": { "Resources$items": "Gets the current Resource resource in the collection.
" } }, "ListOfRestApi": { "base": null, "refs": { "RestApis$items": "An array of links to the current page of RestApi resources.
" } }, "ListOfStage": { "base": null, "refs": { "Stages$item": "An individual Stage resource.
" } }, "ListOfStageKeys": { "base": null, "refs": { "CreateApiKeyRequest$stageKeys": "Specifies whether the ApiKey can be used by callers.
" } }, "ListOfString": { "base": null, "refs": { "ApiKey$stageKeys": "A list of Stage resources that are associated with the ApiKey resource.
", "Integration$cacheKeyParameters": "Specifies the integration's cache key parameters.
", "MapOfStringToList$value": null, "PutIntegrationRequest$cacheKeyParameters": "Specifies a put integration input's cache key parameters.
", "RestApi$warnings": null } }, "Long": { "base": null, "refs": { "TestInvokeAuthorizerResponse$latency": "The execution latency of the test authorizer request
", "TestInvokeMethodResponse$latency": "The execution latency of the test invoke request.
" } }, "MapOfHeaderValues": { "base": null, "refs": { "TestInvokeAuthorizerRequest$headers": "[Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.
", "TestInvokeMethodRequest$headers": "A key-value map of headers to simulate an incoming invocation request.
", "TestInvokeMethodResponse$headers": "The headers of HTTP response.
" } }, "MapOfIntegrationResponse": { "base": null, "refs": { "Integration$integrationResponses": "Specifies the integration's responses.
" } }, "MapOfMethod": { "base": null, "refs": { "Resource$resourceMethods": "Map of methods for this resource, which is included only if the request uses the embed query option.
" } }, "MapOfMethodResponse": { "base": null, "refs": { "Method$methodResponses": "Represents available responses that can be sent to the caller. Method responses are represented as a key/value map, with an HTTP status code as the key and a MethodResponse as the value. The status codes are available for the Integration responses to map to.
" } }, "MapOfMethodSettings": { "base": null, "refs": { "Stage$methodSettings": "A map that defines the method settings for a Stage resource. Keys are defined as {resource_path}/{http_method} for an individual method override, or \\*/\\* for the settings applied to all methods in the stage.
Represents request parameters that can be accepted by Amazon API Gateway. Request parameters are represented as a key/value map, with a source as the key and a Boolean flag as the value. The Boolean flag is used to specify whether the parameter is required. A source must match the pattern method.request.{location}.{name}, where location is either querystring, path, or header. name is a valid, unique parameter name. Sources specified here are available to the integration for mapping to integration request parameters or templates.
Represents response parameters that can be sent back to the caller by Amazon API Gateway. Response parameters are represented as a key/value map, with a destination as the key and a boolean flag as the value, which is used to specify whether the parameter is required. A destination must match the pattern method.response.header.{name}, where name is a valid, unique header name. Destinations specified here are available to the integration for mapping from integration response parameters.
Represents requests parameters that are sent with the backend request. Request parameters are represented as a key/value map, with a destination as the key and a source as the value. A source must match an existing method request parameter, or a static value. Static values must be enclosed with single quotes, and be pre-encoded based on their destination in the request. The destination must match the pattern integration.request.{location}.{name}, where location is either querystring, path, or header. name must be a valid, unique parameter name.
Represents response parameters that can be sent back to the caller by Amazon API Gateway. Response parameters are represented as a key/value map, with a destination as the key and a Boolean flag as the value. The Boolean flag is used to specify whether the parameter is required. A destination must match the pattern method.response.header.{name}, where name is a valid, unique header name. Destinations specified here are available to the integration for mapping from integration response parameters.
A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
A map that defines the stage variables for the new Stage resource. Variable names can have alphanumeric characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType 'swagger', any combination of the following parameters are supported: 'integrations' will export x-amazon-apigateway-integration extensions 'authorizers' will export x-amazon-apigateway-authorizer extensions 'postman' will export with Postman extensions, allowing for import to the Postman tool
", "GetSdkRequest$parameters": "A key-value map of query string parameters that specify properties of the SDK, depending on the requested sdkType. For sdkType 'objectivec', a parameter named \"classPrefix\" is required. For sdkType 'android', parameters named \"groupId\", \"artifactId\", \"artifactVersion\", and \"invokerPackage\" are required.
", "ImportRestApiRequest$parameters": "Custom header parameters as part of the request.
", "Integration$requestParameters": "Represents requests parameters that are sent with the backend request. Request parameters are represented as a key/value map, with a destination as the key and a source as the value. A source must match an existing method request parameter, or a static value. Static values must be enclosed with single quotes, and be pre-encoded based on their destination in the request. The destination must match the pattern integration.request.{location}.{name}, where location is either querystring, path, or header. name must be a valid, unique parameter name.
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
", "IntegrationResponse$responseParameters": "Represents response parameters that can be read from the backend response. Response parameters are represented as a key/value map, with a destination as the key and a source as the value. A destination must match an existing response parameter in the MethodResponse. The source can be a header from the backend response, or a static value. Static values are specified using enclosing single quotes, and backend response headers can be read using the pattern integration.response.header.{name}.
Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
", "Method$requestModels": "Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.
", "MethodResponse$responseModels": "Specifies the Model 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 Model name as the value.
", "PutIntegrationRequest$requestParameters": "Represents request parameters that are sent with the backend request. Request parameters are represented as a key/value map, with a destination as the key and a source as the value. A source must match an existing method request parameter, or a static value. Static values must be enclosed with single quotes, and be pre-encoded based on their destination in the request. The destination must match the pattern integration.request.{location}.{name}, where location is either querystring, path, or header. name must be a valid, unique parameter name.
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
", "PutIntegrationResponseRequest$responseParameters": "Represents response parameters that can be read from the backend response. Response parameters are represented as a key/value map, with a destination as the key and a source as the value. A destination must match an existing response parameter in the Method. The source can be a header from the backend response, or a static value. Static values are specified using enclosing single quotes, and backend response headers can be read using the pattern integration.response.header.{name}.
Specifies a put integration response's templates.
", "PutMethodRequest$requestModels": "Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.
", "PutMethodResponseRequest$responseModels": "Specifies the Model 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 Model name as the value.
", "PutRestApiRequest$parameters": "Custom headers supplied as part of the request.
", "Stage$variables": "A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
A key-value map of stage variables to simulate an invocation on a deployed Stage.
", "TestInvokeAuthorizerRequest$additionalContext": "[Optional] A key-value map of additional context variables.
", "TestInvokeAuthorizerResponse$claims": null, "TestInvokeMethodRequest$stageVariables": "A key-value map of stage variables to simulate an invocation on a deployed Stage.
" } }, "Method": { "base": "Represents a method.
", "refs": { "MapOfMethod$value": null } }, "MethodResponse": { "base": "Represents a method response. Amazon API Gateway sends back the status code to the caller as the HTTP status code. Parameters and models can be used to transform the response from the method's integration.
", "refs": { "MapOfMethodResponse$value": null } }, "MethodSetting": { "base": "Specifies the method setting properties.
", "refs": { "MapOfMethodSettings$value": null } }, "MethodSnapshot": { "base": "Represents a summary of a Method resource, given a particular date and time.
", "refs": { "MapOfMethodSnapshot$value": null } }, "Model": { "base": "Represents the structure of a request or response payload for a method.
", "refs": { "ListOfModel$member": null } }, "Models": { "base": "Represents a collection of Model resources.
", "refs": { } }, "NotFoundException": { "base": null, "refs": { } }, "NullableBoolean": { "base": null, "refs": { "CreateDeploymentRequest$cacheClusterEnabled": "Enables a cache cluster for the Stage resource specified in the input.
", "MapOfStringToBoolean$value": null, "Method$apiKeyRequired": "Specifies whether the method requires a valid ApiKey.
" } }, "NullableInteger": { "base": null, "refs": { "Authorizer$authorizerResultTtlInSeconds": "The TTL in seconds of cached authorizer results. If 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.
", "CreateAuthorizerRequest$authorizerResultTtlInSeconds": "The TTL of cached authorizer results.
", "GetApiKeysRequest$limit": "The maximum number of ApiKeys to get information about.
", "GetAuthorizersRequest$limit": "Limit the number of Authorizer resources in the response.
", "GetBasePathMappingsRequest$limit": "The maximum number of BasePathMapping resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
", "GetClientCertificatesRequest$limit": "The maximum number of ClientCertificate resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
", "GetDeploymentsRequest$limit": "The maximum number of Deployment resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
", "GetDomainNamesRequest$limit": "The maximum number of DomainName resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
", "GetModelsRequest$limit": "The maximum number of models in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
", "GetResourcesRequest$limit": "The maximum number of Resource resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
", "GetRestApisRequest$limit": "The maximum number of RestApi resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
" } }, "PatchOperation": { "base": "A single patch operation to apply to the specified resource. Please refer to http://tools.ietf.org/html/rfc6902#section-4 for an explanation of how each operation is used.", "refs": { "ListOfPatchOperation$member": null } }, "PathToMapOfMethodSnapshot": { "base": null, "refs": { "Deployment$apiSummary": "Gets a summary of the RestApi at the date and time that the deployment resource was created.
" } }, "ProviderARN": { "base": null, "refs": { "ListOfARNs$member": null } }, "PutIntegrationRequest": { "base": "Represents a put integration request.
", "refs": { } }, "PutIntegrationResponseRequest": { "base": "Represents a put integration response request.
", "refs": { } }, "PutMethodRequest": { "base": "Request to add a method to an existing Resource resource.
", "refs": { } }, "PutMethodResponseRequest": { "base": "Request to add a MethodResponse to an existing Method resource.
", "refs": { } }, "PutMode": { "base": null, "refs": { "PutRestApiRequest$mode": "The mode query parameter to specify the update mode. Valid values are \"merge\" and \"overwrite\". By default, the update mode is \"merge\".
A PUT request to update an existing API, with external API definitions specified as the request body.
", "refs": { } }, "Resource": { "base": "Represents a resource.
", "refs": { "ListOfResource$member": null } }, "Resources": { "base": "Represents a collection of Resource resources.
", "refs": { } }, "RestApi": { "base": "Represents a REST API.
", "refs": { "ListOfRestApi$member": null } }, "RestApis": { "base": "Contains references to your APIs and links that guide you in ways to interact with your collection. A collection offers a paginated view of your APIs.
", "refs": { } }, "SdkResponse": { "base": "The binary blob response to GetSdk, which contains the generated SDK.
", "refs": { } }, "ServiceUnavailableException": { "base": null, "refs": { } }, "Stage": { "base": "Represents a unique identifier for a version of a deployed RestApi that is callable by users.
", "refs": { "ListOfStage$member": null } }, "StageKey": { "base": "A reference to a unique stage identified in the format {restApiId}/{stage}.
A list of Stage resource that are associated with the ApiKey resource.
", "refs": { } }, "StatusCode": { "base": "The status code.
", "refs": { "DeleteIntegrationResponseRequest$statusCode": "Specifies a delete integration response request's status code.
", "DeleteMethodResponseRequest$statusCode": "The status code identifier for the MethodResponse resource.
", "GetIntegrationResponseRequest$statusCode": "Specifies a get integration response request's status code.
", "GetMethodResponseRequest$statusCode": "The status code identifier for the MethodResponse resource.
", "IntegrationResponse$statusCode": "Specifies the status code that is used to map the integration response to an existing MethodResponse.
", "MethodResponse$statusCode": "The method response's status code.
", "PutIntegrationResponseRequest$statusCode": "Specifies the status code that is used to map the integration response to an existing MethodResponse.
", "PutMethodResponseRequest$statusCode": "The method response's status code.
", "UpdateIntegrationResponseRequest$statusCode": "Specifies an update integration response request's status code.
", "UpdateMethodResponseRequest$statusCode": "The status code identifier for the MethodResponse resource.
" } }, "String": { "base": null, "refs": { "Account$cloudwatchRoleArn": "Specifies the Amazon resource name (ARN) of an Amazon CloudWatch role for the current Account resource.
", "ApiKey$id": "The identifier of the API Key.
", "ApiKey$name": "The name of the API Key.
", "ApiKey$description": "The description of the API Key.
", "ApiKeys$position": null, "Authorizer$id": "The identifier for the authorizer resource.
", "Authorizer$name": "[Required] The name of the authorizer.
", "Authorizer$authType": "Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.
", "Authorizer$authorizerUri": "[Required] Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN authorizers, this must be a well-formed Lambda function URI. The URI should be of the form arn:aws:apigateway:{region}:lambda:path/{service_api}. Region is used to determine the right endpoint. In this case, path is used to indicate that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations
Specifies the credentials required for the authorizer, if any. Two options are available. To specify an IAM Role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
", "Authorizer$identitySource": "[Required] The source of the identity in an incoming request. For TOKEN authorizers, this value is a mapping expression with the same syntax as integration parameter mappings. The only valid source for tokens is 'header', so the expression should match 'method.request.header.[headerName]'. The value of the header '[headerName]' will be interpreted as the incoming token.
", "Authorizer$identityValidationExpression": "A validation expression for the incoming identity. For TOKEN authorizers, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.
", "Authorizers$position": null, "BadRequestException$message": null, "BasePathMapping$basePath": "The base path name that callers of the API must provide as part of the URL after the domain name.
", "BasePathMapping$restApiId": "The name of the API.
", "BasePathMapping$stage": "The name of the API's stage.
", "BasePathMappings$position": null, "ClientCertificate$clientCertificateId": "The identifier of the Client Certificate.
", "ClientCertificate$description": "The description of the Client Certificate.
", "ClientCertificate$pemEncodedCertificate": "The PEM-encoded public key of the Client Certificate, that can be used to configure certificate authentication in the integration endpoint .
", "ClientCertificates$position": null, "ConflictException$message": null, "CreateApiKeyRequest$name": "The name of the ApiKey.
", "CreateApiKeyRequest$description": "The description of the ApiKey.
", "CreateAuthorizerRequest$restApiId": "The RestApi identifier under which the Authorizer will be created.
", "CreateAuthorizerRequest$name": "[Required] The name of the authorizer.
", "CreateAuthorizerRequest$authType": "Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.
", "CreateAuthorizerRequest$authorizerUri": "[Required] Specifies the authorizer's Uniform Resource Identifier (URI).
", "CreateAuthorizerRequest$authorizerCredentials": "Specifies the credentials required for the authorizer, if any.
", "CreateAuthorizerRequest$identitySource": "[Required] The source of the identity in an incoming request.
", "CreateAuthorizerRequest$identityValidationExpression": "A validation expression for the incoming identity.
", "CreateBasePathMappingRequest$domainName": "The domain name of the BasePathMapping resource to create.
", "CreateBasePathMappingRequest$basePath": "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.
", "CreateBasePathMappingRequest$restApiId": "The name of the API that you want to apply this mapping to.
", "CreateBasePathMappingRequest$stage": "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.
", "CreateDeploymentRequest$restApiId": "The RestApi resource identifier for the Deployment resource to create.
", "CreateDeploymentRequest$stageName": "The name of the Stage resource for the Deployment resource to create.
", "CreateDeploymentRequest$stageDescription": "The description of the Stage resource for the Deployment resource to create.
", "CreateDeploymentRequest$description": "The description for the Deployment resource to create.
", "CreateDomainNameRequest$domainName": "The name of the DomainName resource.
", "CreateDomainNameRequest$certificateName": "The name of the certificate.
", "CreateDomainNameRequest$certificateBody": "The body of the server certificate provided by your certificate authority.
", "CreateDomainNameRequest$certificatePrivateKey": "Your certificate's private key.
", "CreateDomainNameRequest$certificateChain": "The intermediate certificates and optionally the root certificate, one after the other without any blank lines. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.
", "CreateModelRequest$restApiId": "The RestApi identifier under which the Model will be created.
", "CreateModelRequest$name": "The name of the model.
", "CreateModelRequest$description": "The description of the model.
", "CreateModelRequest$schema": "The schema for the model. For application/json models, this should be JSON-schema draft v4 model.
The content-type for the model.
", "CreateResourceRequest$restApiId": "The identifier of the RestApi for the resource.
", "CreateResourceRequest$parentId": "The parent resource's identifier.
", "CreateResourceRequest$pathPart": "The last path segment for this resource.
", "CreateRestApiRequest$name": "The name of the RestApi.
", "CreateRestApiRequest$description": "The description of the RestApi.
", "CreateRestApiRequest$cloneFrom": "The Id of the RestApi that you want to clone from.
", "CreateStageRequest$restApiId": "The identifier of the RestApi resource for the Stage resource to create.
", "CreateStageRequest$stageName": "The name for the Stage resource.
", "CreateStageRequest$deploymentId": "The identifier of the Deployment resource for the Stage resource.
", "CreateStageRequest$description": "The description of the Stage resource.
", "DeleteApiKeyRequest$apiKey": "The identifier of the ApiKey resource to be deleted.
", "DeleteAuthorizerRequest$restApiId": "The RestApi identifier for the Authorizer resource.
", "DeleteAuthorizerRequest$authorizerId": "The identifier of the Authorizer resource.
", "DeleteBasePathMappingRequest$domainName": "The domain name of the BasePathMapping resource to delete.
", "DeleteBasePathMappingRequest$basePath": "The base path name of the BasePathMapping resource to delete.
", "DeleteClientCertificateRequest$clientCertificateId": "The identifier of the ClientCertificate resource to be deleted.
", "DeleteDeploymentRequest$restApiId": "The identifier of the RestApi resource for the Deployment resource to delete.
", "DeleteDeploymentRequest$deploymentId": "The identifier of the Deployment resource to delete.
", "DeleteDomainNameRequest$domainName": "The name of the DomainName resource to be deleted.
", "DeleteIntegrationRequest$restApiId": "Specifies a delete integration request's API identifier.
", "DeleteIntegrationRequest$resourceId": "Specifies a delete integration request's resource identifier.
", "DeleteIntegrationRequest$httpMethod": "Specifies a delete integration request's HTTP method.
", "DeleteIntegrationResponseRequest$restApiId": "Specifies a delete integration response request's API identifier.
", "DeleteIntegrationResponseRequest$resourceId": "Specifies a delete integration response request's resource identifier.
", "DeleteIntegrationResponseRequest$httpMethod": "Specifies a delete integration response request's HTTP method.
", "DeleteMethodRequest$restApiId": "The RestApi identifier for the Method resource.
", "DeleteMethodRequest$resourceId": "The Resource identifier for the Method resource.
", "DeleteMethodRequest$httpMethod": "The HTTP verb that identifies the Method resource.
", "DeleteMethodResponseRequest$restApiId": "The RestApi identifier for the MethodResponse resource.
", "DeleteMethodResponseRequest$resourceId": "The Resource identifier for the MethodResponse resource.
", "DeleteMethodResponseRequest$httpMethod": "The HTTP verb identifier for the parent Method resource.
", "DeleteModelRequest$restApiId": "The RestApi under which the model will be deleted.
", "DeleteModelRequest$modelName": "The name of the model to delete.
", "DeleteResourceRequest$restApiId": "The RestApi identifier for the Resource resource.
", "DeleteResourceRequest$resourceId": "The identifier of the Resource resource.
", "DeleteRestApiRequest$restApiId": "The ID of the RestApi you want to delete.
", "DeleteStageRequest$restApiId": "The identifier of the RestApi resource for the Stage resource to delete.
", "DeleteStageRequest$stageName": "The name of the Stage resource to delete.
", "Deployment$id": "The identifier for the deployment resource.
", "Deployment$description": "The description for the deployment resource.
", "Deployments$position": null, "DomainName$domainName": "The name of the DomainName resource.
", "DomainName$certificateName": "The name of the certificate.
", "DomainName$distributionDomainName": "The domain name of the Amazon CloudFront distribution. For more information, see the Amazon CloudFront documentation.
", "DomainNames$position": null, "ExportResponse$contentType": "The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.
", "ExportResponse$contentDisposition": "The content-disposition header value in the HTTP reseponse.
", "FlushStageAuthorizersCacheRequest$restApiId": "The API identifier of the stage to flush.
", "FlushStageAuthorizersCacheRequest$stageName": "The name of the stage to flush.
", "FlushStageCacheRequest$restApiId": "The API identifier of the stage to flush its cache.
", "FlushStageCacheRequest$stageName": "The name of the stage to flush its cache.
", "GenerateClientCertificateRequest$description": "The description of the ClientCertificate.
", "GetApiKeyRequest$apiKey": "The identifier of the ApiKey resource.
", "GetApiKeysRequest$position": "The position of the current ApiKeys resource to get information about.
", "GetAuthorizerRequest$restApiId": "The RestApi identifier for the Authorizer resource.
", "GetAuthorizerRequest$authorizerId": "The identifier of the Authorizer resource.
", "GetAuthorizersRequest$restApiId": "The RestApi identifier for the Authorizers resource.
", "GetAuthorizersRequest$position": "If not all Authorizer resources in the response were present, the position will specificy where to start the next page of results.
", "GetBasePathMappingRequest$domainName": "The domain name of the BasePathMapping resource to be described.
", "GetBasePathMappingRequest$basePath": "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.
", "GetBasePathMappingsRequest$domainName": "The domain name of a BasePathMapping resource.
", "GetBasePathMappingsRequest$position": "The position of the current BasePathMapping resource in the collection to get information about.
", "GetClientCertificateRequest$clientCertificateId": "The identifier of the ClientCertificate resource to be described.
", "GetClientCertificatesRequest$position": "The position of the current ClientCertificate resource in the collection to get information about.
", "GetDeploymentRequest$restApiId": "The identifier of the RestApi resource for the Deployment resource to get information about.
", "GetDeploymentRequest$deploymentId": "The identifier of the Deployment resource to get information about.
", "GetDeploymentsRequest$restApiId": "The identifier of the RestApi resource for the collection of Deployment resources to get information about.
", "GetDeploymentsRequest$position": "The position of the current Deployment resource in the collection to get information about.
", "GetDomainNameRequest$domainName": "The name of the DomainName resource.
", "GetDomainNamesRequest$position": "The position of the current domain names to get information about.
", "GetExportRequest$restApiId": "The identifier of the RestApi to be exported.
", "GetExportRequest$stageName": "The name of the Stage that will be exported.
", "GetExportRequest$exportType": "The type of export. Currently only 'swagger' is supported.
", "GetExportRequest$accepts": "The content-type of the export, for example 'application/json'. Currently 'application/json' and 'application/yaml' are supported for exportType 'swagger'. Should be specifed in the 'Accept' header for direct API requests.
", "GetIntegrationRequest$restApiId": "Specifies a get integration request's API identifier.
", "GetIntegrationRequest$resourceId": "Specifies a get integration request's resource identifier
", "GetIntegrationRequest$httpMethod": "Specifies a get integration request's HTTP method.
", "GetIntegrationResponseRequest$restApiId": "Specifies a get integration response request's API identifier.
", "GetIntegrationResponseRequest$resourceId": "Specifies a get integration response request's resource identifier.
", "GetIntegrationResponseRequest$httpMethod": "Specifies a get integration response request's HTTP method.
", "GetMethodRequest$restApiId": "The RestApi identifier for the Method resource.
", "GetMethodRequest$resourceId": "The Resource identifier for the Method resource.
", "GetMethodRequest$httpMethod": "Specifies the put method request's HTTP method type.
", "GetMethodResponseRequest$restApiId": "The RestApi identifier for the MethodResponse resource.
", "GetMethodResponseRequest$resourceId": "The Resource identifier for the MethodResponse resource.
", "GetMethodResponseRequest$httpMethod": "The HTTP verb identifier for the parent Method resource.
", "GetModelRequest$restApiId": "The RestApi identifier under which the Model exists.
", "GetModelRequest$modelName": "The name of the model as an identifier.
", "GetModelTemplateRequest$restApiId": "The ID of the RestApi under which the model exists.
", "GetModelTemplateRequest$modelName": "The name of the model for which to generate a template.
", "GetModelsRequest$restApiId": "The RestApi identifier.
", "GetModelsRequest$position": "The position of the next set of results in the Models resource to get information about.
", "GetResourceRequest$restApiId": "The RestApi identifier for the resource.
", "GetResourceRequest$resourceId": "The identifier for the Resource resource.
", "GetResourcesRequest$restApiId": "The RestApi identifier for the Resource.
", "GetResourcesRequest$position": "The position of the next set of results in the current Resources resource to get information about.
", "GetRestApiRequest$restApiId": "The identifier of the RestApi resource.
", "GetRestApisRequest$position": "The position of the current RestApis resource in the collection to get information about.
", "GetSdkRequest$restApiId": "The identifier of the RestApi that the SDK will use.
", "GetSdkRequest$stageName": "The name of the Stage that the SDK will use.
", "GetSdkRequest$sdkType": "The language for the generated SDK. Currently javascript, android, and objectivec (for iOS) are supported.
", "GetStageRequest$restApiId": "The identifier of the RestApi resource for the Stage resource to get information about.
", "GetStageRequest$stageName": "The name of the Stage resource to get information about.
", "GetStagesRequest$restApiId": "The stages' API identifiers.
", "GetStagesRequest$deploymentId": "The stages' deployment identifiers.
", "Integration$httpMethod": "Specifies the integration's HTTP method type.
", "Integration$uri": "Specifies the integration's Uniform Resource Identifier (URI). For HTTP integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification. For AWS integrations, the URI should be of the form arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}. Region, subdomain and service are used to determine the right endpoint. For AWS services that use the Action= query string parameter, service_api should be a valid action for the desired service. For RESTful AWS service APIs, path is used to indicate that the remaining substring in the URI should be treated as the path to the resource, including the initial /.
Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\\*:user/\\*. To use resource-based permissions on supported AWS services, specify null.
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available requestTemplates defined on the Integration. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.
WHEN_NO_MATCH passes the request body for unmapped content types through to the Integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.
WHEN_NO_TEMPLATES will allow 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.
Specifies the integration's cache namespace.
", "IntegrationResponse$selectionPattern": "Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the backend. If the backend is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS backends, the HTTP status code is matched.
", "LimitExceededException$retryAfterSeconds": null, "LimitExceededException$message": null, "ListOfString$member": null, "MapOfHeaderValues$key": null, "MapOfHeaderValues$value": null, "MapOfIntegrationResponse$key": null, "MapOfMethod$key": null, "MapOfMethodResponse$key": null, "MapOfMethodSettings$key": null, "MapOfMethodSnapshot$key": null, "MapOfStringToBoolean$key": null, "MapOfStringToList$key": null, "MapOfStringToString$key": null, "MapOfStringToString$value": null, "Method$httpMethod": "The HTTP method.
", "Method$authorizationType": "The method's authorization type.
", "Method$authorizerId": "Specifies the identifier of an Authorizer to use on this Method. The authorizationType must be CUSTOM.
", "MethodSetting$loggingLevel": "Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO.
Specifies the type of authorization used for the method.
", "Model$id": "The identifier for the model resource.
", "Model$name": "The name of the model.
", "Model$description": "The description of the model.
", "Model$schema": "The schema for the model. For application/json models, this should be JSON-schema draft v4 model.
The content-type for the model.
", "Models$position": null, "NotFoundException$message": null, "PatchOperation$path": "Operation objects MUST have exactly one \"path\" member. That member's value is a string containing a `JSON-Pointer` value that references a location within the target document (the \"target location\") where the operation is performed.
", "PatchOperation$value": "The actual value content.
", "PatchOperation$from": "The \"move\" and \"copy\" operation object MUST contain a \"from\" member, which is a string containing a JSON Pointer value that references the location in the target document to move the value from.
Specifies a put integration request's API identifier.
", "PutIntegrationRequest$resourceId": "Specifies a put integration request's resource ID.
", "PutIntegrationRequest$httpMethod": "Specifies a put integration request's HTTP method.
", "PutIntegrationRequest$integrationHttpMethod": "Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
", "PutIntegrationRequest$uri": "Specifies a put integration input's Uniform Resource Identifier (URI). When the integration type is HTTP or AWS, this field is required. For integration with Lambda as an AWS service proxy, this value is of the 'arn:aws:apigateway:<region>:lambda:path/2015-03-31/functions/<functionArn>/invocations' format.
", "PutIntegrationRequest$credentials": "Specifies whether credentials are required for a put integration.
", "PutIntegrationRequest$passthroughBehavior": "Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available requestTemplates defined on the Integration. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.
WHEN_NO_MATCH passes the request body for unmapped content types through to the Integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.
WHEN_NO_TEMPLATES will allow 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.
Specifies a put integration input's cache namespace.
", "PutIntegrationResponseRequest$restApiId": "Specifies a put integration response request's API identifier.
", "PutIntegrationResponseRequest$resourceId": "Specifies a put integration response request's resource identifier.
", "PutIntegrationResponseRequest$httpMethod": "Specifies a put integration response request's HTTP method.
", "PutIntegrationResponseRequest$selectionPattern": "Specifies the selection pattern of a put integration response.
", "PutMethodRequest$restApiId": "The RestApi identifier for the new Method resource.
", "PutMethodRequest$resourceId": "The Resource identifier for the new Method resource.
", "PutMethodRequest$httpMethod": "Specifies the put method request's HTTP method type.
", "PutMethodRequest$authorizationType": "Specifies the type of authorization used for the method.
", "PutMethodRequest$authorizerId": "Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.
", "PutMethodResponseRequest$restApiId": "The RestApi identifier for the Method resource.
", "PutMethodResponseRequest$resourceId": "The Resource identifier for the Method resource.
", "PutMethodResponseRequest$httpMethod": "The HTTP verb that identifies the Method resource.
", "PutRestApiRequest$restApiId": "The identifier of the RestApi to be updated.
", "Resource$id": "The resource's identifier.
", "Resource$parentId": "The parent resource's identifier.
", "Resource$pathPart": "The last path segment for this resource.
", "Resource$path": "The full path for this resource.
", "Resources$position": null, "RestApi$id": "The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
", "RestApi$name": "The API's name.
", "RestApi$description": "The API's description.
", "RestApis$position": null, "SdkResponse$contentType": "The content-type header value in the HTTP response.
", "SdkResponse$contentDisposition": "The content-disposition header value in the HTTP reseponse.
", "ServiceUnavailableException$retryAfterSeconds": null, "ServiceUnavailableException$message": null, "Stage$deploymentId": "The identifier of the Deployment that the stage points to.
", "Stage$clientCertificateId": null, "Stage$stageName": "The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.
", "Stage$description": "The stage's description.
", "StageKey$restApiId": "A list of Stage resources that are associated with the ApiKey resource.
", "StageKey$stageName": "The stage name in the RestApi that the stage key references.
", "Template$value": "The Apache Velocity Template Language (VTL) template content used for the template resource.
", "TestInvokeAuthorizerRequest$restApiId": "Specifies a test invoke authorizer request's RestApi identifier.
", "TestInvokeAuthorizerRequest$authorizerId": "Specifies a test invoke authorizer request's Authorizer ID.
", "TestInvokeAuthorizerRequest$pathWithQueryString": "[Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
", "TestInvokeAuthorizerRequest$body": "[Optional] The simulated request body of an incoming invocation request.
", "TestInvokeAuthorizerResponse$log": "The Amazon API Gateway execution log for the test authorizer request.
", "TestInvokeAuthorizerResponse$principalId": "The principal identity returned by the Authorizer
", "TestInvokeAuthorizerResponse$policy": "The policy JSON document returned by the Authorizer
", "TestInvokeMethodRequest$restApiId": "Specifies a test invoke method request's API identifier.
", "TestInvokeMethodRequest$resourceId": "Specifies a test invoke method request's resource ID.
", "TestInvokeMethodRequest$httpMethod": "Specifies a test invoke method request's HTTP method.
", "TestInvokeMethodRequest$pathWithQueryString": "The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
", "TestInvokeMethodRequest$body": "The simulated request body of an incoming invocation request.
", "TestInvokeMethodRequest$clientCertificateId": "A ClientCertificate identifier to use in the test invocation. API Gateway will use use the certificate when making the HTTPS request to the defined backend endpoint.
", "TestInvokeMethodResponse$body": "The body of HTTP response.
", "TestInvokeMethodResponse$log": "The Amazon API Gateway execution log for the test invoke request.
", "TooManyRequestsException$retryAfterSeconds": null, "TooManyRequestsException$message": null, "UnauthorizedException$message": null, "UpdateApiKeyRequest$apiKey": "The identifier of the ApiKey resource to be updated.
", "UpdateAuthorizerRequest$restApiId": "The RestApi identifier for the Authorizer resource.
", "UpdateAuthorizerRequest$authorizerId": "The identifier of the Authorizer resource.
", "UpdateBasePathMappingRequest$domainName": "The domain name of the BasePathMapping resource to change.
", "UpdateBasePathMappingRequest$basePath": "The base path of the BasePathMapping resource to change.
", "UpdateClientCertificateRequest$clientCertificateId": "The identifier of the ClientCertificate resource to be updated.
", "UpdateDeploymentRequest$restApiId": "The replacement identifier of the RestApi resource for the Deployment resource to change information about.
", "UpdateDeploymentRequest$deploymentId": "The replacment identifier for the Deployment resource to change information about.
", "UpdateDomainNameRequest$domainName": "The name of the DomainName resource to be changed.
", "UpdateIntegrationRequest$restApiId": "Represents an update integration request's API identifier.
", "UpdateIntegrationRequest$resourceId": "Represents an update integration request's resource identifier.
", "UpdateIntegrationRequest$httpMethod": "Represents an update integration request's HTTP method.
", "UpdateIntegrationResponseRequest$restApiId": "Specifies an update integration response request's API identifier.
", "UpdateIntegrationResponseRequest$resourceId": "Specifies an update integration response request's resource identifier.
", "UpdateIntegrationResponseRequest$httpMethod": "Specifies an update integration response request's HTTP method.
", "UpdateMethodRequest$restApiId": "The RestApi identifier for the Method resource.
", "UpdateMethodRequest$resourceId": "The Resource identifier for the Method resource.
", "UpdateMethodRequest$httpMethod": "The HTTP verb that identifies the Method resource.
", "UpdateMethodResponseRequest$restApiId": "The RestApi identifier for the MethodResponse resource.
", "UpdateMethodResponseRequest$resourceId": "The Resource identifier for the MethodResponse resource.
", "UpdateMethodResponseRequest$httpMethod": "The HTTP verb identifier for the parent Method resource.
", "UpdateModelRequest$restApiId": "The RestApi identifier under which the model exists.
", "UpdateModelRequest$modelName": "The name of the model to update.
", "UpdateResourceRequest$restApiId": "The RestApi identifier for the Resource resource.
", "UpdateResourceRequest$resourceId": "The identifier of the Resource resource.
", "UpdateRestApiRequest$restApiId": "The ID of the RestApi you want to update.
", "UpdateStageRequest$restApiId": "The identifier of the RestApi resource for the Stage resource to change information about.
", "UpdateStageRequest$stageName": "The name of the Stage resource to change information about.
" } }, "Template": { "base": "Represents a mapping template used to transform a payload.
", "refs": { } }, "TestInvokeAuthorizerRequest": { "base": "Make a request to simulate the execution of an Authorizer.
", "refs": { } }, "TestInvokeAuthorizerResponse": { "base": "Represents the response of the test invoke request in for a custom Authorizer
", "refs": { } }, "TestInvokeMethodRequest": { "base": "Make a request to simulate the execution of a Method.
", "refs": { } }, "TestInvokeMethodResponse": { "base": "Represents the response of the test invoke request in HTTP method.
", "refs": { } }, "ThrottleSettings": { "base": "Returns the throttle settings.
", "refs": { "Account$throttleSettings": "Specifies the application programming interface (API) throttle settings for the current Account resource.
" } }, "Timestamp": { "base": null, "refs": { "ApiKey$createdDate": "The date when the API Key was created, in ISO 8601 format.
", "ApiKey$lastUpdatedDate": "When the API Key was last updated, in ISO 8601 format.
", "ClientCertificate$createdDate": "The date when the Client Certificate was created, in ISO 8601 format.
", "ClientCertificate$expirationDate": "The date when the Client Certificate will expire, in ISO 8601 format.
", "Deployment$createdDate": "The date and time that the deployment resource was created.
", "DomainName$certificateUploadDate": "The date when the certificate was uploaded, in ISO 8601 format.
", "RestApi$createdDate": "The date when the API was created, in ISO 8601 format.
", "Stage$createdDate": "The date and time that the stage was created, in ISO 8601 format.
", "Stage$lastUpdatedDate": "The date and time that information about the stage was last updated, in ISO 8601 format.
" } }, "TooManyRequestsException": { "base": null, "refs": { } }, "UnauthorizedCacheControlHeaderStrategy": { "base": null, "refs": { "MethodSetting$unauthorizedCacheControlHeaderStrategy": "Specifies the strategy on how to handle the unauthorized requests for cache invalidation. The PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy, and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, SUCCEED_WITHOUT_RESPONSE_HEADER.
Requests Amazon API Gateway to change information about the current Account resource.
", "refs": { } }, "UpdateApiKeyRequest": { "base": "A request to change information about an ApiKey resource.
", "refs": { } }, "UpdateAuthorizerRequest": { "base": "Request to update an existing Authorizer resource.
", "refs": { } }, "UpdateBasePathMappingRequest": { "base": "A request to change information about the BasePathMapping resource.
", "refs": { } }, "UpdateClientCertificateRequest": { "base": "A request to change information about an ClientCertificate resource.
", "refs": { } }, "UpdateDeploymentRequest": { "base": "Requests Amazon API Gateway to change information about a Deployment resource.
", "refs": { } }, "UpdateDomainNameRequest": { "base": "A request to change information about the DomainName resource.
", "refs": { } }, "UpdateIntegrationRequest": { "base": "Represents an update integration request.
", "refs": { } }, "UpdateIntegrationResponseRequest": { "base": "Represents an update integration response request.
", "refs": { } }, "UpdateMethodRequest": { "base": "Request to update an existing Method resource.
", "refs": { } }, "UpdateMethodResponseRequest": { "base": "A request to update an existing MethodResponse resource.
", "refs": { } }, "UpdateModelRequest": { "base": "Request to update an existing model in an existing RestApi resource.
", "refs": { } }, "UpdateResourceRequest": { "base": "Request to change information about a Resource resource.
", "refs": { } }, "UpdateRestApiRequest": { "base": "Request to update an existing RestApi resource in your collection.
", "refs": { } }, "UpdateStageRequest": { "base": "Requests Amazon API Gateway to change information about a Stage resource.
", "refs": { } }, "op": { "base": null, "refs": { "PatchOperation$op": "A patch operation whose value indicates the operation to perform. Its value MUST be one of \"add\", \"remove\", \"replace\", \"move\", \"copy\", or \"test\"; other values are errors.
" } } } }