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":{ "name":"CreateApiKey", "http":{ "method":"POST", "requestUri":"/apikeys", "responseCode":201 }, "input":{"shape":"CreateApiKeyRequest"}, "output":{ "shape":"ApiKey", "documentation":"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.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true }, { "shape":"LimitExceededException", "error":{"httpStatusCode":429}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true } ] }, "CreateBasePathMapping":{ "name":"CreateBasePathMapping", "http":{ "method":"POST", "requestUri":"/domainnames/{domain_name}/basepathmappings", "responseCode":201 }, "input":{ "shape":"CreateBasePathMappingRequest", "documentation":"Requests Amazon API Gateway to create a new BasePathMapping resource.
" }, "output":{ "shape":"BasePathMapping", "documentation":"Represents the base path that callers of the API that must provide as part of the URL after the domain name.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"ConflictException", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Creates a new BasePathMapping resource.
" }, "CreateDeployment":{ "name":"CreateDeployment", "http":{ "method":"POST", "requestUri":"/restapis/{restapi_id}/deployments", "responseCode":201 }, "input":{ "shape":"CreateDeploymentRequest", "documentation":"Requests Amazon API Gateway to create a Deployment resource.
" }, "output":{ "shape":"Deployment", "documentation":"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.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"ConflictException", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"LimitExceededException", "error":{"httpStatusCode":429}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true } ], "documentation":"Creates a Deployment resource, which makes a specified RestApi callable over the internet.
" }, "CreateDomainName":{ "name":"CreateDomainName", "http":{ "method":"POST", "requestUri":"/domainnames", "responseCode":201 }, "input":{ "shape":"CreateDomainNameRequest", "documentation":"A request to create a new domain name.
" }, "output":{ "shape":"DomainName", "documentation":"Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Creates a new domain name.
" }, "CreateModel":{ "name":"CreateModel", "http":{ "method":"POST", "requestUri":"/restapis/{restapi_id}/models", "responseCode":201 }, "input":{ "shape":"CreateModelRequest", "documentation":"Request to add a new Model to an existing RestApi resource.
" }, "output":{ "shape":"Model", "documentation":"Represents the structure of a request or response payload for a method.
" }, "errors":[ { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"ConflictException", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"LimitExceededException", "error":{"httpStatusCode":429}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Adds a new Model resource to an existing RestApi resource.
" }, "CreateResource":{ "name":"CreateResource", "http":{ "method":"POST", "requestUri":"/restapis/{restapi_id}/resources/{parent_id}", "responseCode":201 }, "input":{ "shape":"CreateResourceRequest", "documentation":"Requests Amazon API Gateway to create a Resource resource.
" }, "output":{ "shape":"Resource", "documentation":"Represents a resource.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"ConflictException", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"LimitExceededException", "error":{"httpStatusCode":429}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Creates a Resource resource.
" }, "CreateRestApi":{ "name":"CreateRestApi", "http":{ "method":"POST", "requestUri":"/restapis", "responseCode":201 }, "input":{ "shape":"CreateRestApiRequest", "documentation":"Request to add a new RestApi resource to your collection.
" }, "output":{ "shape":"RestApi", "documentation":"Represents a REST API.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"LimitExceededException", "error":{"httpStatusCode":429}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Creates a new RestApi resource.
" }, "CreateStage":{ "name":"CreateStage", "http":{ "method":"POST", "requestUri":"/restapis/{restapi_id}/stages", "responseCode":201 }, "input":{ "shape":"CreateStageRequest", "documentation":"Requests Amazon API Gateway to create a Stage resource.
" }, "output":{ "shape":"Stage", "documentation":"Represents a unique identifier for a version of a deployed RestApi that is callable by users.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"ConflictException", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"LimitExceededException", "error":{"httpStatusCode":429}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Creates a Stage resource.
" }, "DeleteApiKey":{ "name":"DeleteApiKey", "http":{ "method":"DELETE", "requestUri":"/apikeys/{api_Key}", "responseCode":202 }, "input":{ "shape":"DeleteApiKeyRequest", "documentation":"A request to delete the ApiKey resource.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Deletes the ApiKey resource.
" }, "DeleteBasePathMapping":{ "name":"DeleteBasePathMapping", "http":{ "method":"DELETE", "requestUri":"/domainnames/{domain_name}/basepathmappings/{base_path}", "responseCode":202 }, "input":{ "shape":"DeleteBasePathMappingRequest", "documentation":"A request to delete the BasePathMapping resource.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Deletes the BasePathMapping resource.
" }, "DeleteClientCertificate":{ "name":"DeleteClientCertificate", "http":{ "method":"DELETE", "requestUri":"/clientcertificates/{clientcertificate_id}", "responseCode":202 }, "input":{"shape":"DeleteClientCertificateRequest"}, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true } ] }, "DeleteDeployment":{ "name":"DeleteDeployment", "http":{ "method":"DELETE", "requestUri":"/restapis/{restapi_id}/deployments/{deployment_id}", "responseCode":202 }, "input":{ "shape":"DeleteDeploymentRequest", "documentation":"Requests Amazon API Gateway to delete a Deployment resource.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
" }, "DeleteDomainName":{ "name":"DeleteDomainName", "http":{ "method":"DELETE", "requestUri":"/domainnames/{domain_name}", "responseCode":202 }, "input":{ "shape":"DeleteDomainNameRequest", "documentation":"A request to delete the DomainName resource.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Deletes the DomainName resource.
" }, "DeleteIntegration":{ "name":"DeleteIntegration", "http":{ "method":"DELETE", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration", "responseCode":204 }, "input":{ "shape":"DeleteIntegrationRequest", "documentation":"Represents a delete integration request.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Represents a delete integration.
" }, "DeleteIntegrationResponse":{ "name":"DeleteIntegrationResponse", "http":{ "method":"DELETE", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}", "responseCode":204 }, "input":{ "shape":"DeleteIntegrationResponseRequest", "documentation":"Represents a delete integration response request.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Represents a delete integration response.
" }, "DeleteMethod":{ "name":"DeleteMethod", "http":{ "method":"DELETE", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}", "responseCode":204 }, "input":{ "shape":"DeleteMethodRequest", "documentation":"Request to delete an existing Method resource.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Deletes an existing Method resource.
" }, "DeleteMethodResponse":{ "name":"DeleteMethodResponse", "http":{ "method":"DELETE", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}", "responseCode":204 }, "input":{ "shape":"DeleteMethodResponseRequest", "documentation":"A request to delete an existing MethodResponse resource.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Deletes an existing MethodResponse resource.
" }, "DeleteModel":{ "name":"DeleteModel", "http":{ "method":"DELETE", "requestUri":"/restapis/{restapi_id}/models/{model_name}", "responseCode":202 }, "input":{ "shape":"DeleteModelRequest", "documentation":"Request to delete an existing model in an existing RestApi resource.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"ConflictException", "error":{"httpStatusCode":409}, "exception":true } ], "documentation":"Deletes a model.
" }, "DeleteResource":{ "name":"DeleteResource", "http":{ "method":"DELETE", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}", "responseCode":202 }, "input":{ "shape":"DeleteResourceRequest", "documentation":"Request to delete a Resource.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Deletes a Resource resource.
" }, "DeleteRestApi":{ "name":"DeleteRestApi", "http":{ "method":"DELETE", "requestUri":"/restapis/{restapi_id}", "responseCode":202 }, "input":{ "shape":"DeleteRestApiRequest", "documentation":"Request to delete the specified API from your collection.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Deletes the specified API.
" }, "DeleteStage":{ "name":"DeleteStage", "http":{ "method":"DELETE", "requestUri":"/restapis/{restapi_id}/stages/{stage_name}", "responseCode":202 }, "input":{ "shape":"DeleteStageRequest", "documentation":"Requests Amazon API Gateway to delete a Stage resource.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Deletes a Stage resource.
" }, "FlushStageCache":{ "name":"FlushStageCache", "http":{ "method":"DELETE", "requestUri":"/restapis/{restapi_id}/stages/{stage_name}/cache/data", "responseCode":202 }, "input":{ "shape":"FlushStageCacheRequest", "documentation":"Requests Amazon API Gateway to flush a stage's cache.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Flushes a stage's cache.
" }, "GenerateClientCertificate":{ "name":"GenerateClientCertificate", "http":{ "method":"POST", "requestUri":"/clientcertificates", "responseCode":201 }, "input":{"shape":"GenerateClientCertificateRequest"}, "output":{"shape":"ClientCertificate"}, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true }, { "shape":"LimitExceededException", "error":{"httpStatusCode":429}, "exception":true } ] }, "GetAccount":{ "name":"GetAccount", "http":{ "method":"GET", "requestUri":"/account" }, "input":{ "shape":"GetAccountRequest", "documentation":"Requests Amazon API Gateway to get information about the current Account resource.
" }, "output":{ "shape":"Account", "documentation":"Represents an AWS account that is associated with Amazon API Gateway.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Gets information about the current Account resource.
" }, "GetApiKey":{ "name":"GetApiKey", "http":{ "method":"GET", "requestUri":"/apikeys/{api_Key}" }, "input":{ "shape":"GetApiKeyRequest", "documentation":"A request to get information about the current ApiKey resource.
" }, "output":{ "shape":"ApiKey", "documentation":"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.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Gets information about the current ApiKey resource.
" }, "GetApiKeys":{ "name":"GetApiKeys", "http":{ "method":"GET", "requestUri":"/apikeys" }, "input":{ "shape":"GetApiKeysRequest", "documentation":"A request to get information about the current ApiKeys resource.
" }, "output":{ "shape":"ApiKeys", "documentation":"Represents a collection of ApiKey resources.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Gets information about the current ApiKeys resource.
" }, "GetBasePathMapping":{ "name":"GetBasePathMapping", "http":{ "method":"GET", "requestUri":"/domainnames/{domain_name}/basepathmappings/{base_path}" }, "input":{ "shape":"GetBasePathMappingRequest", "documentation":"Request to describe a BasePathMapping resource.
" }, "output":{ "shape":"BasePathMapping", "documentation":"Represents the base path that callers of the API that must provide as part of the URL after the domain name.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Describe a BasePathMapping resource.
" }, "GetBasePathMappings":{ "name":"GetBasePathMappings", "http":{ "method":"GET", "requestUri":"/domainnames/{domain_name}/basepathmappings" }, "input":{ "shape":"GetBasePathMappingsRequest", "documentation":"A request to get information about a collection of BasePathMapping resources.
" }, "output":{ "shape":"BasePathMappings", "documentation":"Represents a collection of BasePathMapping resources.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Represents a collection of BasePathMapping resources.
" }, "GetClientCertificate":{ "name":"GetClientCertificate", "http":{ "method":"GET", "requestUri":"/clientcertificates/{clientcertificate_id}" }, "input":{"shape":"GetClientCertificateRequest"}, "output":{"shape":"ClientCertificate"}, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ] }, "GetClientCertificates":{ "name":"GetClientCertificates", "http":{ "method":"GET", "requestUri":"/clientcertificates" }, "input":{"shape":"GetClientCertificatesRequest"}, "output":{"shape":"ClientCertificates"}, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ] }, "GetDeployment":{ "name":"GetDeployment", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/deployments/{deployment_id}" }, "input":{ "shape":"GetDeploymentRequest", "documentation":"Requests Amazon API Gateway to get information about a Deployment resource.
" }, "output":{ "shape":"Deployment", "documentation":"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.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true } ], "documentation":"Gets information about a Deployment resource.
" }, "GetDeployments":{ "name":"GetDeployments", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/deployments" }, "input":{ "shape":"GetDeploymentsRequest", "documentation":"Requests Amazon API Gateway to get information about a Deployments collection.
" }, "output":{ "shape":"Deployments", "documentation":"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.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true } ], "documentation":"Gets information about a Deployments collection.
" }, "GetDomainName":{ "name":"GetDomainName", "http":{ "method":"GET", "requestUri":"/domainnames/{domain_name}" }, "input":{ "shape":"GetDomainNameRequest", "documentation":"Request to get the name of a DomainName resource.
" }, "output":{ "shape":"DomainName", "documentation":"Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
" }, "GetDomainNames":{ "name":"GetDomainNames", "http":{ "method":"GET", "requestUri":"/domainnames" }, "input":{ "shape":"GetDomainNamesRequest", "documentation":"Request to describe a collection of DomainName resources.
" }, "output":{ "shape":"DomainNames", "documentation":"Represents a collection of DomainName resources.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Represents a collection of DomainName resources.
" }, "GetIntegration":{ "name":"GetIntegration", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration" }, "input":{ "shape":"GetIntegrationRequest", "documentation":"Represents a get integration request.
" }, "output":{ "shape":"Integration", "documentation":"Represents a HTTP, AWS, or Mock integration.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Represents a get integration.
" }, "GetIntegrationResponse":{ "name":"GetIntegrationResponse", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}" }, "input":{ "shape":"GetIntegrationResponseRequest", "documentation":"Represents a get integration response request.
" }, "output":{ "shape":"IntegrationResponse", "documentation":"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.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Represents a get integration response.
" }, "GetMethod":{ "name":"GetMethod", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}" }, "input":{ "shape":"GetMethodRequest", "documentation":"Request to describe an existing Method resource.
" }, "output":{ "shape":"Method", "documentation":"Represents a method.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Describe an existing Method resource.
" }, "GetMethodResponse":{ "name":"GetMethodResponse", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}" }, "input":{ "shape":"GetMethodResponseRequest", "documentation":"Request to describe a MethodResponse resource.
" }, "output":{ "shape":"MethodResponse", "documentation":"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.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Describes a MethodResponse resource.
" }, "GetModel":{ "name":"GetModel", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/models/{model_name}" }, "input":{ "shape":"GetModelRequest", "documentation":"Request to list information about a model in an existing RestApi resource.
" }, "output":{ "shape":"Model", "documentation":"Represents the structure of a request or response payload for a method.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Describes an existing model defined for a RestApi resource.
" }, "GetModelTemplate":{ "name":"GetModelTemplate", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/models/{model_name}/default_template" }, "input":{ "shape":"GetModelTemplateRequest", "documentation":"Request to generate a sample mapping template used to transform the payload.
" }, "output":{ "shape":"Template", "documentation":"Represents a mapping template used to transform a payload.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Generates a sample mapping template that can be used to transform a payload into the structure of a model.
" }, "GetModels":{ "name":"GetModels", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/models" }, "input":{ "shape":"GetModelsRequest", "documentation":"Request to list existing Models defined for a RestApi resource.
" }, "output":{ "shape":"Models", "documentation":"Represents a collection of Model resources.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Describes existing Models defined for a RestApi resource.
" }, "GetResource":{ "name":"GetResource", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}" }, "input":{ "shape":"GetResourceRequest", "documentation":"Request to list information about a resource.
" }, "output":{ "shape":"Resource", "documentation":"Represents a resource.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Lists information about a resource.
" }, "GetResources":{ "name":"GetResources", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/resources" }, "input":{ "shape":"GetResourcesRequest", "documentation":"Request to list information about a collection of resources.
" }, "output":{ "shape":"Resources", "documentation":"Represents a collection of Resource resources.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Lists information about a collection of Resource resources.
" }, "GetRestApi":{ "name":"GetRestApi", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}" }, "input":{ "shape":"GetRestApiRequest", "documentation":"Request to list an existing RestApi defined for your collection.
" }, "output":{ "shape":"RestApi", "documentation":"Represents a REST API.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Lists the RestApi resource in the collection.
" }, "GetRestApis":{ "name":"GetRestApis", "http":{ "method":"GET", "requestUri":"/restapis" }, "input":{ "shape":"GetRestApisRequest", "documentation":"Request to list existing RestApis defined for your collection.
" }, "output":{ "shape":"RestApis", "documentation":"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.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Lists the RestApis resources for your collection.
" }, "GetSdk":{ "name":"GetSdk", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/stages/{stage_name}/sdks/{sdk_type}", "responseCode":200 }, "input":{"shape":"GetSdkRequest"}, "output":{"shape":"SdkResponse"}, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ] }, "GetStage":{ "name":"GetStage", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/stages/{stage_name}" }, "input":{ "shape":"GetStageRequest", "documentation":"Requests Amazon API Gateway to get information about a Stage resource.
" }, "output":{ "shape":"Stage", "documentation":"Represents a unique identifier for a version of a deployed RestApi that is callable by users.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Gets information about a Stage resource.
" }, "GetStages":{ "name":"GetStages", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/stages" }, "input":{ "shape":"GetStagesRequest", "documentation":"Requests Amazon API Gateway to get information about one or more Stage resources.
" }, "output":{ "shape":"Stages", "documentation":"A list of Stage resource that are associated with the ApiKey resource.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Gets information about one or more Stage resources.
" }, "PutIntegration":{ "name":"PutIntegration", "http":{ "method":"PUT", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration", "responseCode":201 }, "input":{ "shape":"PutIntegrationRequest", "documentation":"Represents a put integration request.
" }, "output":{ "shape":"Integration", "documentation":"Represents a HTTP, AWS, or Mock integration.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Represents a put integration.
" }, "PutIntegrationResponse":{ "name":"PutIntegrationResponse", "http":{ "method":"PUT", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}", "responseCode":201 }, "input":{ "shape":"PutIntegrationResponseRequest", "documentation":"Represents a put integration response request.
" }, "output":{ "shape":"IntegrationResponse", "documentation":"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.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"LimitExceededException", "error":{"httpStatusCode":429}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Represents a put integration.
" }, "PutMethod":{ "name":"PutMethod", "http":{ "method":"PUT", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}", "responseCode":201 }, "input":{ "shape":"PutMethodRequest", "documentation":"Request to add a method to an existing Resource resource.
" }, "output":{ "shape":"Method", "documentation":"Represents a method.
" }, "errors":[ { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"ConflictException", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"LimitExceededException", "error":{"httpStatusCode":429}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Add a method to an existing Resource resource.
" }, "PutMethodResponse":{ "name":"PutMethodResponse", "http":{ "method":"PUT", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}", "responseCode":201 }, "input":{ "shape":"PutMethodResponseRequest", "documentation":"Request to add a MethodResponse to an existing Method resource.
" }, "output":{ "shape":"MethodResponse", "documentation":"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.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"ConflictException", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"LimitExceededException", "error":{"httpStatusCode":429}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Adds a MethodResponse to an existing Method resource.
" }, "TestInvokeMethod":{ "name":"TestInvokeMethod", "http":{ "method":"POST", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}" }, "input":{"shape":"TestInvokeMethodRequest"}, "output":{ "shape":"TestInvokeMethodResponse", "documentation":"Represents the response of the test invoke request in HTTP method.
" }, "errors":[ { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ] }, "UpdateAccount":{ "name":"UpdateAccount", "http":{ "method":"PATCH", "requestUri":"/account" }, "input":{ "shape":"UpdateAccountRequest", "documentation":"Requests Amazon API Gateway to change information about the current Account resource.
" }, "output":{ "shape":"Account", "documentation":"Represents an AWS account that is associated with Amazon API Gateway.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Changes information about the current Account resource.
" }, "UpdateApiKey":{ "name":"UpdateApiKey", "http":{ "method":"PATCH", "requestUri":"/apikeys/{api_Key}" }, "input":{ "shape":"UpdateApiKeyRequest", "documentation":"A request to change information about an ApiKey resource.
" }, "output":{ "shape":"ApiKey", "documentation":"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.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Changes information about an ApiKey resource.
" }, "UpdateBasePathMapping":{ "name":"UpdateBasePathMapping", "http":{ "method":"PATCH", "requestUri":"/domainnames/{domain_name}/basepathmappings/{base_path}" }, "input":{ "shape":"UpdateBasePathMappingRequest", "documentation":"A request to change information about the BasePathMapping resource.
" }, "output":{ "shape":"BasePathMapping", "documentation":"Represents the base path that callers of the API that must provide as part of the URL after the domain name.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"ConflictException", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Changes information about the BasePathMapping resource.
" }, "UpdateClientCertificate":{ "name":"UpdateClientCertificate", "http":{ "method":"PATCH", "requestUri":"/clientcertificates/{clientcertificate_id}" }, "input":{"shape":"UpdateClientCertificateRequest"}, "output":{"shape":"ClientCertificate"}, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true } ] }, "UpdateDeployment":{ "name":"UpdateDeployment", "http":{ "method":"PATCH", "requestUri":"/restapis/{restapi_id}/deployments/{deployment_id}" }, "input":{ "shape":"UpdateDeploymentRequest", "documentation":"Requests Amazon API Gateway to change information about a Deployment resource.
" }, "output":{ "shape":"Deployment", "documentation":"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.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true } ], "documentation":"Changes information about a Deployment resource.
" }, "UpdateDomainName":{ "name":"UpdateDomainName", "http":{ "method":"PATCH", "requestUri":"/domainnames/{domain_name}" }, "input":{ "shape":"UpdateDomainNameRequest", "documentation":"A request to change information about the DomainName resource.
" }, "output":{ "shape":"DomainName", "documentation":"Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Changes information about the DomainName resource.
" }, "UpdateIntegration":{ "name":"UpdateIntegration", "http":{ "method":"PATCH", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration" }, "input":{ "shape":"UpdateIntegrationRequest", "documentation":"Represents an update integration request.
" }, "output":{ "shape":"Integration", "documentation":"Represents a HTTP, AWS, or Mock integration.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Represents an update integration.
" }, "UpdateIntegrationResponse":{ "name":"UpdateIntegrationResponse", "http":{ "method":"PATCH", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}" }, "input":{ "shape":"UpdateIntegrationResponseRequest", "documentation":"Represents an update integration response request.
" }, "output":{ "shape":"IntegrationResponse", "documentation":"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.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Represents an update integration response.
" }, "UpdateMethod":{ "name":"UpdateMethod", "http":{ "method":"PATCH", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}" }, "input":{ "shape":"UpdateMethodRequest", "documentation":"Request to update an existing Method resource.
" }, "output":{ "shape":"Method", "documentation":"Represents a method.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Updates an existing Method resource.
" }, "UpdateMethodResponse":{ "name":"UpdateMethodResponse", "http":{ "method":"PATCH", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}", "responseCode":201 }, "input":{ "shape":"UpdateMethodResponseRequest", "documentation":"A request to update an existing MethodResponse resource.
" }, "output":{ "shape":"MethodResponse", "documentation":"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.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"ConflictException", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"LimitExceededException", "error":{"httpStatusCode":429}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Updates an existing MethodResponse resource.
" }, "UpdateModel":{ "name":"UpdateModel", "http":{ "method":"PATCH", "requestUri":"/restapis/{restapi_id}/models/{model_name}" }, "input":{ "shape":"UpdateModelRequest", "documentation":"Request to update an existing model in an existing RestApi resource.
" }, "output":{ "shape":"Model", "documentation":"Represents the structure of a request or response payload for a method.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Changes information about a model.
" }, "UpdateResource":{ "name":"UpdateResource", "http":{ "method":"PATCH", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}" }, "input":{ "shape":"UpdateResourceRequest", "documentation":"Request to change information about a Resource resource.
" }, "output":{ "shape":"Resource", "documentation":"Represents a resource.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"ConflictException", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Changes information about a Resource resource.
" }, "UpdateRestApi":{ "name":"UpdateRestApi", "http":{ "method":"PATCH", "requestUri":"/restapis/{restapi_id}" }, "input":{ "shape":"UpdateRestApiRequest", "documentation":"Request to update an existing RestApi resource in your collection.
" }, "output":{ "shape":"RestApi", "documentation":"Represents a REST API.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"ConflictException", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Changes information about the specified API.
" }, "UpdateStage":{ "name":"UpdateStage", "http":{ "method":"PATCH", "requestUri":"/restapis/{restapi_id}/stages/{stage_name}" }, "input":{ "shape":"UpdateStageRequest", "documentation":"Requests Amazon API Gateway to change information about a Stage resource.
" }, "output":{ "shape":"Stage", "documentation":"Represents a unique identifier for a version of a deployed RestApi that is callable by users.
" }, "errors":[ { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true }, { "shape":"NotFoundException", "error":{"httpStatusCode":404}, "exception":true }, { "shape":"ConflictException", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"BadRequestException", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyRequestsException", "error":{"httpStatusCode":429}, "exception":true } ], "documentation":"Changes information about a Stage resource.
" } }, "shapes":{ "Account":{ "type":"structure", "members":{ "cloudwatchRoleArn":{ "shape":"String", "documentation":"Specifies the Amazon resource name (ARN) of an Amazon CloudWatch role for the current Account resource.
" }, "throttleSettings":{ "shape":"ThrottleSettings", "documentation":"Specifies the application programming interface (API) throttle settings for the current Account resource.
" } }, "documentation":"Represents an AWS account that is associated with Amazon API Gateway.
" }, "ApiKey":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"The identifier of the API Key.
" }, "name":{ "shape":"String", "documentation":"The name of the API Key.
" }, "description":{ "shape":"String", "documentation":"The description of the API Key.
" }, "enabled":{ "shape":"Boolean", "documentation":"Specifies whether the API Key can be used by callers.
" }, "stageKeys":{ "shape":"ListOfString", "documentation":"A list of Stage resources that are associated with the ApiKey resource.
" }, "createdDate":{ "shape":"Timestamp", "documentation":"The date when the API Key was created, in ISO 8601 format.
" }, "lastUpdatedDate":{ "shape":"Timestamp", "documentation":"When the API Key was last updated, in ISO 8601 format.
" } }, "documentation":"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.
" }, "ApiKeys":{ "type":"structure", "members":{ "position":{"shape":"String"}, "items":{ "shape":"ListOfApiKey", "documentation":"The current page of any ApiKey resources in the collection of ApiKey resources.
", "locationName":"item" } }, "documentation":"Represents a collection of ApiKey resources.
" }, "BadRequestException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "error":{"httpStatusCode":400}, "exception":true }, "BasePathMapping":{ "type":"structure", "members":{ "basePath":{ "shape":"String", "documentation":"The base path name that callers of the API must provide as part of the URL after the domain name.
" }, "restApiId":{ "shape":"String", "documentation":"The name of the API.
" }, "stage":{ "shape":"String", "documentation":"The name of the API's stage.
" } }, "documentation":"Represents the base path that callers of the API that must provide as part of the URL after the domain name.
" }, "BasePathMappings":{ "type":"structure", "members":{ "position":{"shape":"String"}, "items":{ "shape":"ListOfBasePathMapping", "documentation":"The current page of any BasePathMapping resources in the collection of base path mapping resources.
", "locationName":"item" } }, "documentation":"Represents a collection of BasePathMapping resources.
" }, "Blob":{"type":"blob"}, "Boolean":{"type":"boolean"}, "CacheClusterSize":{ "type":"string", "enum":[ "0.5", "1.6", "6.1", "13.5", "28.4", "58.2", "118", "237" ], "documentation":"Returns the size of the CacheCluster.
" }, "CacheClusterStatus":{ "type":"string", "enum":[ "CREATE_IN_PROGRESS", "AVAILABLE", "DELETE_IN_PROGRESS", "NOT_AVAILABLE", "FLUSH_IN_PROGRESS" ], "documentation":"Returns the status of the CacheCluster.
" }, "ClientCertificate":{ "type":"structure", "members":{ "clientCertificateId":{"shape":"String"}, "description":{"shape":"String"}, "pemEncodedCertificate":{"shape":"String"}, "createdDate":{"shape":"Timestamp"}, "expirationDate":{"shape":"Timestamp"} } }, "ClientCertificates":{ "type":"structure", "members":{ "position":{"shape":"String"}, "items":{ "shape":"ListOfClientCertificate", "locationName":"item" } } }, "ConflictException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "error":{"httpStatusCode":409}, "exception":true }, "CreateApiKeyRequest":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"The name of the ApiKey.
" }, "description":{ "shape":"String", "documentation":"The description of the ApiKey.
" }, "enabled":{ "shape":"Boolean", "documentation":"Specifies whether the ApiKey can be used by callers.
" }, "stageKeys":{ "shape":"ListOfStageKeys", "documentation":"Specifies whether the ApiKey can be used by callers.
" } } }, "CreateBasePathMappingRequest":{ "type":"structure", "required":[ "domainName", "restApiId" ], "members":{ "domainName":{ "shape":"String", "location":"uri", "locationName":"domain_name", "documentation":"The domain name of the BasePathMapping resource to create.
" }, "basePath":{ "shape":"String", "documentation":"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.
" }, "restApiId":{ "shape":"String", "documentation":"The name of the API that you want to apply this mapping to.
" }, "stage":{ "shape":"String", "documentation":"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.
" } }, "documentation":"Requests Amazon API Gateway to create a new BasePathMapping resource.
" }, "CreateDeploymentRequest":{ "type":"structure", "required":[ "restApiId", "stageName" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The RestApi resource identifier for the Deployment resource to create.
" }, "stageName":{ "shape":"String", "documentation":"The name of the Stage resource for the Deployment resource to create.
" }, "stageDescription":{ "shape":"String", "documentation":"The description of the Stage resource for the Deployment resource to create.
" }, "description":{ "shape":"String", "documentation":"The description for the Deployment resource to create.
" }, "cacheClusterEnabled":{ "shape":"NullableBoolean", "documentation":"Enables a cache cluster for the Stage resource specified in the input.
" }, "cacheClusterSize":{ "shape":"CacheClusterSize", "documentation":"Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.
" }, "variables":{ "shape":"MapOfStringToString", "documentation":"A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphabetic characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+
" } }, "documentation":"Requests Amazon API Gateway to create a Deployment resource.
" }, "CreateDomainNameRequest":{ "type":"structure", "members":{ "domainName":{ "shape":"String", "documentation":"The name of the DomainName resource.
" }, "certificateName":{ "shape":"String", "documentation":"The name of the certificate.
" }, "certificateBody":{ "shape":"String", "documentation":"The body of the server certificate provided by your certificate authority.
" }, "certificatePrivateKey":{ "shape":"String", "documentation":"Your certificate's private key.
" }, "certificateChain":{ "shape":"String", "documentation":"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.
" } }, "documentation":"A request to create a new domain name.
", "required":[ "domainName", "certificateName", "certificateBody", "certificatePrivateKey", "certificateChain" ] }, "CreateModelRequest":{ "type":"structure", "required":[ "restApiId", "name", "contentType" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The RestApi identifier under which the Model will be created.
" }, "name":{ "shape":"String", "documentation":"The name of the model.
" }, "description":{ "shape":"String", "documentation":"The description of the model.
" }, "schema":{ "shape":"String", "documentation":"The schema for the model. For application/json models, this should be JSON-schema draft v4 model.
The content-type for the model.
" } }, "documentation":"Request to add a new Model to an existing RestApi resource.
" }, "CreateResourceRequest":{ "type":"structure", "required":[ "restApiId", "parentId", "pathPart" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The identifier of the RestApi for the resource.
" }, "parentId":{ "shape":"String", "location":"uri", "locationName":"parent_id", "documentation":"The parent resource's identifier.
" }, "pathPart":{ "shape":"String", "documentation":"The last path segment for this resource.
" } }, "documentation":"Requests Amazon API Gateway to create a Resource resource.
" }, "CreateRestApiRequest":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"String", "documentation":"The name of the RestApi.
" }, "description":{ "shape":"String", "documentation":"The description of the RestApi.
" }, "cloneFrom":{ "shape":"String", "documentation":"The name of the RestApi that you want to clone from.
" } }, "documentation":"Request to add a new RestApi resource to your collection.
" }, "CreateStageRequest":{ "type":"structure", "required":[ "restApiId", "stageName", "deploymentId" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The identifier of the RestApi resource for the Stage resource to create.
" }, "stageName":{ "shape":"String", "documentation":"The name for the Stage resource.
" }, "deploymentId":{ "shape":"String", "documentation":"The identifier of the Deployment resource for the Stage resource.
" }, "description":{ "shape":"String", "documentation":"The description of the Stage resource.
" }, "cacheClusterEnabled":{ "shape":"Boolean", "documentation":"Whether cache clustering is enabled for the stage.
" }, "cacheClusterSize":{ "shape":"CacheClusterSize", "documentation":"The stage's cache cluster size.
" }, "variables":{ "shape":"MapOfStringToString", "documentation":"A map that defines the stage variables for the new Stage resource. Variable names can have alphabetic characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+
" } }, "documentation":"Requests Amazon API Gateway to create a Stage resource.
" }, "DeleteApiKeyRequest":{ "type":"structure", "required":["apiKey"], "members":{ "apiKey":{ "shape":"String", "location":"uri", "locationName":"api_Key", "documentation":"The identifier of the ApiKey resource to be deleted.
" } }, "documentation":"A request to delete the ApiKey resource.
" }, "DeleteBasePathMappingRequest":{ "type":"structure", "required":[ "domainName", "basePath" ], "members":{ "domainName":{ "shape":"String", "location":"uri", "locationName":"domain_name", "documentation":"The domain name of the BasePathMapping resource to delete.
" }, "basePath":{ "shape":"String", "location":"uri", "locationName":"base_path", "documentation":"The base path name of the BasePathMapping resource to delete.
" } }, "documentation":"A request to delete the BasePathMapping resource.
" }, "DeleteClientCertificateRequest":{ "type":"structure", "required":["clientCertificateId"], "members":{ "clientCertificateId":{ "shape":"String", "location":"uri", "locationName":"clientcertificate_id" } } }, "DeleteDeploymentRequest":{ "type":"structure", "required":[ "restApiId", "deploymentId" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The identifier of the RestApi resource for the Deployment resource to delete.
" }, "deploymentId":{ "shape":"String", "location":"uri", "locationName":"deployment_id", "documentation":"The identifier of the Deployment resource to delete.
" } }, "documentation":"Requests Amazon API Gateway to delete a Deployment resource.
" }, "DeleteDomainNameRequest":{ "type":"structure", "required":["domainName"], "members":{ "domainName":{ "shape":"String", "location":"uri", "locationName":"domain_name", "documentation":"The name of the DomainName resource to be deleted.
" } }, "documentation":"A request to delete the DomainName resource.
" }, "DeleteIntegrationRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"Specifies a delete integration request's API identifier.
" }, "resourceId":{ "shape":"String", "location":"uri", "locationName":"resource_id", "documentation":"Specifies a delete integration request's resource identifier.
" }, "httpMethod":{ "shape":"String", "location":"uri", "locationName":"http_method", "documentation":"Specifies a delete integration request's HTTP method.
" } }, "documentation":"Represents a delete integration request.
" }, "DeleteIntegrationResponseRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod", "statusCode" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"Specifies a delete integration response request's API identifier.
" }, "resourceId":{ "shape":"String", "location":"uri", "locationName":"resource_id", "documentation":"Specifies a delete integration response request's resource identifier.
" }, "httpMethod":{ "shape":"String", "location":"uri", "locationName":"http_method", "documentation":"Specifies a delete integration response request's HTTP method.
" }, "statusCode":{ "shape":"StatusCode", "location":"uri", "locationName":"status_code", "documentation":"Specifies a delete integration response request's status code.
" } }, "documentation":"Represents a delete integration response request.
" }, "DeleteMethodRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The RestApi identifier for the Method resource.
" }, "resourceId":{ "shape":"String", "location":"uri", "locationName":"resource_id", "documentation":"The Resource identifier for the Method resource.
" }, "httpMethod":{ "shape":"String", "location":"uri", "locationName":"http_method", "documentation":"The HTTP verb that identifies the Method resource.
" } }, "documentation":"Request to delete an existing Method resource.
" }, "DeleteMethodResponseRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod", "statusCode" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The RestApi identifier for the MethodResponse resource.
" }, "resourceId":{ "shape":"String", "location":"uri", "locationName":"resource_id", "documentation":"The Resource identifier for the MethodResponse resource.
" }, "httpMethod":{ "shape":"String", "location":"uri", "locationName":"http_method", "documentation":"The HTTP verb identifier for the parent Method resource.
" }, "statusCode":{ "shape":"StatusCode", "location":"uri", "locationName":"status_code", "documentation":"The status code identifier for the MethodResponse resource.
" } }, "documentation":"A request to delete an existing MethodResponse resource.
" }, "DeleteModelRequest":{ "type":"structure", "required":[ "restApiId", "modelName" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The RestApi under which the model will be deleted.
" }, "modelName":{ "shape":"String", "location":"uri", "locationName":"model_name", "documentation":"The name of the model to delete.
" } }, "documentation":"Request to delete an existing model in an existing RestApi resource.
" }, "DeleteResourceRequest":{ "type":"structure", "required":[ "restApiId", "resourceId" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The RestApi identifier for the Resource resource.
" }, "resourceId":{ "shape":"String", "location":"uri", "locationName":"resource_id", "documentation":"The identifier of the Resource resource.
" } }, "documentation":"Request to delete a Resource.
" }, "DeleteRestApiRequest":{ "type":"structure", "required":["restApiId"], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The ID of the RestApi you want to delete.
" } }, "documentation":"Request to delete the specified API from your collection.
" }, "DeleteStageRequest":{ "type":"structure", "required":[ "restApiId", "stageName" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The identifier of the RestApi resource for the Stage resource to delete.
" }, "stageName":{ "shape":"String", "location":"uri", "locationName":"stage_name", "documentation":"The name of the Stage resource to delete.
" } }, "documentation":"Requests Amazon API Gateway to delete a Stage resource.
" }, "Deployment":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"The identifier for the deployment resource.
" }, "description":{ "shape":"String", "documentation":"The description for the deployment resource.
" }, "createdDate":{ "shape":"Timestamp", "documentation":"The date and time that the deployment resource was created.
" }, "apiSummary":{ "shape":"PathToMapOfMethodSnapshot", "documentation":"Gets a summary of the RestApi at the date and time that the deployment resource was created.
" } }, "documentation":"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.
" }, "Deployments":{ "type":"structure", "members":{ "position":{"shape":"String"}, "items":{ "shape":"ListOfDeployment", "documentation":"The current page of any Deployment resources in the collection of deployment resources.
", "locationName":"item" } }, "documentation":"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.
" }, "DomainName":{ "type":"structure", "members":{ "domainName":{ "shape":"String", "documentation":"The name of the DomainName resource.
" }, "certificateName":{ "shape":"String", "documentation":"The name of the certificate.
" }, "certificateUploadDate":{ "shape":"Timestamp", "documentation":"The date when the certificate was uploaded, in ISO 8601 format.
" }, "distributionDomainName":{ "shape":"String", "documentation":"The domain name of the Amazon CloudFront distribution. For more information, see the Amazon CloudFront documentation.
" } }, "documentation":"Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
" }, "DomainNames":{ "type":"structure", "members":{ "position":{"shape":"String"}, "items":{ "shape":"ListOfDomainName", "documentation":"The current page of any DomainName resources in the collection of DomainName resources.
", "locationName":"item" } }, "documentation":"Represents a collection of DomainName resources.
" }, "Double":{"type":"double"}, "FlushStageCacheRequest":{ "type":"structure", "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The API identifier of the stage to flush its cache.
" }, "stageName":{ "shape":"String", "location":"uri", "locationName":"stage_name", "documentation":"The name of the stage to flush its cache.
" } }, "documentation":"Requests Amazon API Gateway to flush a stage's cache.
", "required":[ "restApiId", "stageName" ] }, "GenerateClientCertificateRequest":{ "type":"structure", "members":{ "description":{"shape":"String"} } }, "GetAccountRequest":{ "type":"structure", "members":{ }, "documentation":"Requests Amazon API Gateway to get information about the current Account resource.
" }, "GetApiKeyRequest":{ "type":"structure", "required":["apiKey"], "members":{ "apiKey":{ "shape":"String", "location":"uri", "locationName":"api_Key", "documentation":"The identifier of the ApiKey resource.
" } }, "documentation":"A request to get information about the current ApiKey resource.
" }, "GetApiKeysRequest":{ "type":"structure", "members":{ "position":{ "shape":"String", "location":"querystring", "locationName":"position", "documentation":"The position of the current ApiKeys resource to get information about.
" }, "limit":{ "shape":"NullableInteger", "location":"querystring", "locationName":"limit", "documentation":"The maximum number of ApiKeys to get information about.
" } }, "documentation":"A request to get information about the current ApiKeys resource.
" }, "GetBasePathMappingRequest":{ "type":"structure", "required":[ "domainName", "basePath" ], "members":{ "domainName":{ "shape":"String", "location":"uri", "locationName":"domain_name", "documentation":"The domain name of the BasePathMapping resource to be described.
" }, "basePath":{ "shape":"String", "location":"uri", "locationName":"base_path", "documentation":"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.
" } }, "documentation":"Request to describe a BasePathMapping resource.
" }, "GetBasePathMappingsRequest":{ "type":"structure", "required":["domainName"], "members":{ "domainName":{ "shape":"String", "location":"uri", "locationName":"domain_name", "documentation":"The domain name of a BasePathMapping resource.
" }, "position":{ "shape":"String", "location":"querystring", "locationName":"position", "documentation":"The position of the current BasePathMapping resource in the collection to get information about.
" }, "limit":{ "shape":"NullableInteger", "location":"querystring", "locationName":"limit", "documentation":"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.
" } }, "documentation":"A request to get information about a collection of BasePathMapping resources.
" }, "GetClientCertificateRequest":{ "type":"structure", "required":["clientCertificateId"], "members":{ "clientCertificateId":{ "shape":"String", "location":"uri", "locationName":"clientcertificate_id" } } }, "GetClientCertificatesRequest":{ "type":"structure", "members":{ "position":{ "shape":"String", "location":"querystring", "locationName":"position" }, "limit":{ "shape":"NullableInteger", "location":"querystring", "locationName":"limit" } } }, "GetDeploymentRequest":{ "type":"structure", "required":[ "restApiId", "deploymentId" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The identifier of the RestApi resource for the Deployment resource to get information about.
" }, "deploymentId":{ "shape":"String", "location":"uri", "locationName":"deployment_id", "documentation":"The identifier of the Deployment resource to get information about.
" } }, "documentation":"Requests Amazon API Gateway to get information about a Deployment resource.
" }, "GetDeploymentsRequest":{ "type":"structure", "required":["restApiId"], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The identifier of the RestApi resource for the collection of Deployment resources to get information about.
" }, "position":{ "shape":"String", "location":"querystring", "locationName":"position", "documentation":"The position of the current Deployment resource in the collection to get information about.
" }, "limit":{ "shape":"NullableInteger", "location":"querystring", "locationName":"limit", "documentation":"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.
" } }, "documentation":"Requests Amazon API Gateway to get information about a Deployments collection.
" }, "GetDomainNameRequest":{ "type":"structure", "required":["domainName"], "members":{ "domainName":{ "shape":"String", "location":"uri", "locationName":"domain_name", "documentation":"The name of the DomainName resource.
" } }, "documentation":"Request to get the name of a DomainName resource.
" }, "GetDomainNamesRequest":{ "type":"structure", "members":{ "position":{ "shape":"String", "location":"querystring", "locationName":"position", "documentation":"The position of the current domain names to get information about.
" }, "limit":{ "shape":"NullableInteger", "location":"querystring", "locationName":"limit", "documentation":"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.
" } }, "documentation":"Request to describe a collection of DomainName resources.
" }, "GetIntegrationRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"Specifies a get integration request's API identifier.
" }, "resourceId":{ "shape":"String", "location":"uri", "locationName":"resource_id", "documentation":"Specifies a get integration request's resource identifier
" }, "httpMethod":{ "shape":"String", "location":"uri", "locationName":"http_method", "documentation":"Specifies a get integration request's HTTP method.
" } }, "documentation":"Represents a get integration request.
" }, "GetIntegrationResponseRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod", "statusCode" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"Specifies a get integration response request's API identifier.
" }, "resourceId":{ "shape":"String", "location":"uri", "locationName":"resource_id", "documentation":"Specifies a get integration response request's resource identifier.
" }, "httpMethod":{ "shape":"String", "location":"uri", "locationName":"http_method", "documentation":"Specifies a get integration response request's HTTP method.
" }, "statusCode":{ "shape":"StatusCode", "location":"uri", "locationName":"status_code", "documentation":"Specifies a get integration response request's status code.
" } }, "documentation":"Represents a get integration response request.
" }, "GetMethodRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The RestApi identifier for the Method resource.
" }, "resourceId":{ "shape":"String", "location":"uri", "locationName":"resource_id", "documentation":"The Resource identifier for the Method resource.
" }, "httpMethod":{ "shape":"String", "location":"uri", "locationName":"http_method", "documentation":"Specifies the put method request's HTTP method type.
" } }, "documentation":"Request to describe an existing Method resource.
" }, "GetMethodResponseRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod", "statusCode" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The RestApi identifier for the MethodResponse resource.
" }, "resourceId":{ "shape":"String", "location":"uri", "locationName":"resource_id", "documentation":"The Resource identifier for the MethodResponse resource.
" }, "httpMethod":{ "shape":"String", "location":"uri", "locationName":"http_method", "documentation":"The HTTP verb identifier for the parent Method resource.
" }, "statusCode":{ "shape":"StatusCode", "location":"uri", "locationName":"status_code", "documentation":"The status code identifier for the MethodResponse resource.
" } }, "documentation":"Request to describe a MethodResponse resource.
" }, "GetModelRequest":{ "type":"structure", "required":[ "restApiId", "modelName" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The RestApi identifier under which the Model exists.
" }, "modelName":{ "shape":"String", "location":"uri", "locationName":"model_name", "documentation":"The name of the model as an identifier.
" }, "flatten":{ "shape":"Boolean", "location":"querystring", "locationName":"flatten", "documentation":"Resolves all external model references and returns a flattened model schema.
" } }, "documentation":"Request to list information about a model in an existing RestApi resource.
" }, "GetModelTemplateRequest":{ "type":"structure", "required":[ "restApiId", "modelName" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The ID of the RestApi under which the model exists.
" }, "modelName":{ "shape":"String", "location":"uri", "locationName":"model_name", "documentation":"The name of the model for which to generate a template.
" } }, "documentation":"Request to generate a sample mapping template used to transform the payload.
" }, "GetModelsRequest":{ "type":"structure", "required":["restApiId"], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The RestApi identifier.
" }, "position":{ "shape":"String", "location":"querystring", "locationName":"position", "documentation":"The position of the next set of results in the Models resource to get information about.
" }, "limit":{ "shape":"NullableInteger", "location":"querystring", "locationName":"limit", "documentation":"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.
" } }, "documentation":"Request to list existing Models defined for a RestApi resource.
" }, "GetResourceRequest":{ "type":"structure", "required":[ "restApiId", "resourceId" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The RestApi identifier for the resource.
" }, "resourceId":{ "shape":"String", "location":"uri", "locationName":"resource_id", "documentation":"The identifier for the Resource resource.
" } }, "documentation":"Request to list information about a resource.
" }, "GetResourcesRequest":{ "type":"structure", "required":["restApiId"], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The RestApi identifier for the Resource.
" }, "position":{ "shape":"String", "location":"querystring", "locationName":"position", "documentation":"The position of the next set of results in the current Resources resource to get information about.
" }, "limit":{ "shape":"NullableInteger", "location":"querystring", "locationName":"limit", "documentation":"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.
" } }, "documentation":"Request to list information about a collection of resources.
" }, "GetRestApiRequest":{ "type":"structure", "required":["restApiId"], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The identifier of the RestApi resource.
" } }, "documentation":"Request to list an existing RestApi defined for your collection.
" }, "GetRestApisRequest":{ "type":"structure", "members":{ "position":{ "shape":"String", "location":"querystring", "locationName":"position", "documentation":"The position of the current RestApis resource in the collection to get information about.
" }, "limit":{ "shape":"NullableInteger", "location":"querystring", "locationName":"limit", "documentation":"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.
" } }, "documentation":"Request to list existing RestApis defined for your collection.
" }, "GetSdkRequest":{ "type":"structure", "required":[ "restApiId", "stageName", "sdkType" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id" }, "stageName":{ "shape":"String", "location":"uri", "locationName":"stage_name" }, "sdkType":{ "shape":"String", "location":"uri", "locationName":"sdk_type" }, "parameters":{ "shape":"MapOfStringToString", "location":"querystring" } } }, "GetStageRequest":{ "type":"structure", "required":[ "restApiId", "stageName" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The identifier of the RestApi resource for the Stage resource to get information about.
" }, "stageName":{ "shape":"String", "location":"uri", "locationName":"stage_name", "documentation":"The name of the Stage resource to get information about.
" } }, "documentation":"Requests Amazon API Gateway to get information about a Stage resource.
" }, "GetStagesRequest":{ "type":"structure", "required":["restApiId"], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The stages' API identifiers.
" }, "deploymentId":{ "shape":"String", "location":"querystring", "locationName":"deploymentId", "documentation":"The stages' deployment identifiers.
" } }, "documentation":"Requests Amazon API Gateway to get information about one or more Stage resources.
" }, "Integer":{"type":"integer"}, "Integration":{ "type":"structure", "members":{ "type":{ "shape":"IntegrationType", "documentation":"Specifies the integration's type.
" }, "httpMethod":{ "shape":"String", "documentation":"Specifies the integration's HTTP method type.
" }, "uri":{ "shape":"String", "documentation":"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}:{service}:{path|action}/{service_api}. Region 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.
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.
Specifies the integration's request templates.
" }, "cacheNamespace":{ "shape":"String", "documentation":"Specifies the integration's cache namespace.
" }, "cacheKeyParameters":{ "shape":"ListOfString", "documentation":"Specifies the integration's cache key parameters.
" }, "integrationResponses":{ "shape":"MapOfIntegrationResponse", "documentation":"Specifies the integration's responses.
" } }, "documentation":"Represents a HTTP, AWS, or Mock integration.
" }, "IntegrationResponse":{ "type":"structure", "members":{ "statusCode":{ "shape":"StatusCode", "documentation":"Specifies the status code that is used to map the integration response to an existing MethodResponse.
" }, "selectionPattern":{ "shape":"String", "documentation":"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.
" }, "responseParameters":{ "shape":"MapOfStringToString", "documentation":"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 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.
" } }, "documentation":"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.
" }, "IntegrationType":{ "type":"string", "enum":[ "HTTP", "AWS", "MOCK" ], "documentation":"The integration type. Possible values are HTTP, AWS, or Mock.
" }, "LimitExceededException":{ "type":"structure", "members":{ "retryAfterSeconds":{ "shape":"String", "location":"header", "locationName":"Retry-After" }, "message":{"shape":"String"} }, "error":{"httpStatusCode":429}, "exception":true }, "ListOfApiKey":{ "type":"list", "member":{"shape":"ApiKey"} }, "ListOfBasePathMapping":{ "type":"list", "member":{"shape":"BasePathMapping"} }, "ListOfClientCertificate":{ "type":"list", "member":{"shape":"ClientCertificate"} }, "ListOfDeployment":{ "type":"list", "member":{"shape":"Deployment"} }, "ListOfDomainName":{ "type":"list", "member":{"shape":"DomainName"} }, "ListOfModel":{ "type":"list", "member":{"shape":"Model"} }, "ListOfPatchOperation":{ "type":"list", "member":{"shape":"PatchOperation"}, "documentation":"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":{ "type":"list", "member":{"shape":"Resource"} }, "ListOfRestApi":{ "type":"list", "member":{"shape":"RestApi"} }, "ListOfStage":{ "type":"list", "member":{"shape":"Stage"} }, "ListOfStageKeys":{ "type":"list", "member":{"shape":"StageKey"} }, "ListOfString":{ "type":"list", "member":{"shape":"String"} }, "Long":{"type":"long"}, "MapOfHeaderValues":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "MapOfIntegrationResponse":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"IntegrationResponse"} }, "MapOfMethod":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"Method"} }, "MapOfMethodResponse":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"MethodResponse"} }, "MapOfMethodSettings":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"MethodSetting"} }, "MapOfMethodSnapshot":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"MethodSnapshot"} }, "MapOfStringToBoolean":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"NullableBoolean"} }, "MapOfStringToString":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "Method":{ "type":"structure", "members":{ "httpMethod":{ "shape":"String", "documentation":"The HTTP method.
" }, "authorizationType":{ "shape":"String", "documentation":"The method's authorization type.
" }, "apiKeyRequired":{ "shape":"NullableBoolean", "documentation":"Specifies whether the method requires a valid ApiKey.
" }, "requestParameters":{ "shape":"MapOfStringToBoolean", "documentation":"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.
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.
" }, "methodResponses":{ "shape":"MapOfMethodResponse", "documentation":"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.
" }, "methodIntegration":{ "shape":"Integration", "documentation":"The method's integration.
" } }, "documentation":"Represents a method.
" }, "MethodResponse":{ "type":"structure", "members":{ "statusCode":{ "shape":"StatusCode", "documentation":"The method response's status code.
" }, "responseParameters":{ "shape":"MapOfStringToBoolean", "documentation":"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.
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.
" } }, "documentation":"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.
" }, "MethodSetting":{ "type":"structure", "members":{ "metricsEnabled":{ "shape":"Boolean", "documentation":"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 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 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 the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.
Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double.
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 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.
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 the method setting properties.
" }, "MethodSnapshot":{ "type":"structure", "members":{ "authorizationType":{ "shape":"String", "documentation":"Specifies the type of authorization used for the method.
" }, "apiKeyRequired":{ "shape":"Boolean", "documentation":"Specifies whether the method requires a valid ApiKey.
" } }, "documentation":"Represents a summary of a Method resource, given a particular date and time.
" }, "Model":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"The identifier for the model resource.
" }, "name":{ "shape":"String", "documentation":"The name of the model.
" }, "description":{ "shape":"String", "documentation":"The description of the model.
" }, "schema":{ "shape":"String", "documentation":"The schema for the model. For application/json models, this should be JSON-schema draft v4 model.
The content-type for the model.
" } }, "documentation":"Represents the structure of a request or response payload for a method.
" }, "Models":{ "type":"structure", "members":{ "position":{"shape":"String"}, "items":{ "shape":"ListOfModel", "documentation":"Gets the current Model resource in the collection.
", "locationName":"item" } }, "documentation":"Represents a collection of Model resources.
" }, "NotFoundException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "error":{"httpStatusCode":404}, "exception":true }, "NullableBoolean":{"type":"boolean"}, "NullableInteger":{"type":"integer"}, "PatchOperation":{ "type":"structure", "members":{ "op":{ "shape":"op", "documentation":"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.
" }, "path":{ "shape":"String", "documentation":"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.
" }, "value":{ "shape":"String", "documentation":"The actual value content.
" }, "from":{ "shape":"String", "documentation":"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.
" }, "resourceId":{ "shape":"String", "location":"uri", "locationName":"resource_id", "documentation":"Specifies a put integration request's resource ID.
" }, "httpMethod":{ "shape":"String", "location":"uri", "locationName":"http_method", "documentation":"Specifies a put integration request's HTTP method.
" }, "type":{ "shape":"IntegrationType", "documentation":"Specifies a put integration input's type.
" }, "integrationHttpMethod":{ "shape":"String", "documentation":"Specifies a put integration HTTP method.
", "locationName":"httpMethod" }, "uri":{ "shape":"String", "documentation":"Specifies a put integration input's Uniform Resource Identifier (URI).
" }, "credentials":{ "shape":"String", "documentation":"Specifies whether credentials are required for a put integration.
" }, "requestParameters":{ "shape":"MapOfStringToString", "documentation":"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.
Specifies the templates used to transform the method request body. Request templates are represented as a key/value map, with a content-type as the key and a template as the value.
" }, "cacheNamespace":{ "shape":"String", "documentation":"Specifies a put integration input's cache namespace.
" }, "cacheKeyParameters":{ "shape":"ListOfString", "documentation":"Specifies a put integration input's cache key parameters.
" } }, "documentation":"Represents a put integration request.
" }, "PutIntegrationResponseRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod", "statusCode" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"Specifies a put integration response request's API identifier.
" }, "resourceId":{ "shape":"String", "location":"uri", "locationName":"resource_id", "documentation":"Specifies a put integration response request's resource identifier.
" }, "httpMethod":{ "shape":"String", "location":"uri", "locationName":"http_method", "documentation":"Specifies a put integration response request's HTTP method.
" }, "statusCode":{ "shape":"StatusCode", "location":"uri", "locationName":"status_code", "documentation":"Specifies the status code that is used to map the integration response to an existing MethodResponse.
" }, "selectionPattern":{ "shape":"String", "documentation":"Specifies the selection pattern of a put integration response.
" }, "responseParameters":{ "shape":"MapOfStringToString", "documentation":"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.
" } }, "documentation":"Represents a put integration response request.
" }, "PutMethodRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod", "authorizationType" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The RestApi identifier for the new Method resource.
" }, "resourceId":{ "shape":"String", "location":"uri", "locationName":"resource_id", "documentation":"The Resource identifier for the new Method resource.
" }, "httpMethod":{ "shape":"String", "location":"uri", "locationName":"http_method", "documentation":"Specifies the put method request's HTTP method type.
" }, "authorizationType":{ "shape":"String", "documentation":"Specifies the type of authorization used for the method.
" }, "apiKeyRequired":{ "shape":"Boolean", "documentation":"Specifies whether the method required a valid ApiKey.
" }, "requestParameters":{ "shape":"MapOfStringToBoolean", "documentation":"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.
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.
" } }, "documentation":"Request to add a method to an existing Resource resource.
" }, "PutMethodResponseRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod", "statusCode" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The RestApi identifier for the Method resource.
" }, "resourceId":{ "shape":"String", "location":"uri", "locationName":"resource_id", "documentation":"The Resource identifier for the Method resource.
" }, "httpMethod":{ "shape":"String", "location":"uri", "locationName":"http_method", "documentation":"The HTTP verb that identifies the Method resource.
" }, "statusCode":{ "shape":"StatusCode", "location":"uri", "locationName":"status_code", "documentation":"The method response's status code.
" }, "responseParameters":{ "shape":"MapOfStringToBoolean", "documentation":"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.
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.
" } }, "documentation":"Request to add a MethodResponse to an existing Method resource.
" }, "Resource":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"The resource's identifier.
" }, "parentId":{ "shape":"String", "documentation":"The parent resource's identifier.
" }, "pathPart":{ "shape":"String", "documentation":"The last path segment for this resource.
" }, "path":{ "shape":"String", "documentation":"The full path for this resource.
" }, "resourceMethods":{ "shape":"MapOfMethod", "documentation":"Map of methods for this resource, which is included only if requested using the embed option.
" } }, "documentation":"Represents a resource.
" }, "Resources":{ "type":"structure", "members":{ "position":{"shape":"String"}, "items":{ "shape":"ListOfResource", "documentation":"Gets the current Resource resource in the collection.
", "locationName":"item" } }, "documentation":"Represents a collection of Resource resources.
" }, "RestApi":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
" }, "name":{ "shape":"String", "documentation":"The API's name.
" }, "description":{ "shape":"String", "documentation":"The API's description.
" }, "createdDate":{ "shape":"Timestamp", "documentation":"The date when the API was created, in ISO 8601 format.
" } }, "documentation":"Represents a REST API.
" }, "RestApis":{ "type":"structure", "members":{ "position":{"shape":"String"}, "items":{ "shape":"ListOfRestApi", "documentation":"An array of links to the current page of RestApi resources.
", "locationName":"item" } }, "documentation":"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.
" }, "SdkResponse":{ "type":"structure", "members":{ "contentType":{ "shape":"String", "location":"header", "locationName":"Content-Type" }, "contentDisposition":{ "shape":"String", "location":"header", "locationName":"Content-Disposition" }, "body":{"shape":"Blob"} }, "payload":"body" }, "ServiceUnavailableException":{ "type":"structure", "members":{ "retryAfterSeconds":{ "shape":"String", "location":"header", "locationName":"Retry-After" }, "message":{"shape":"String"} }, "error":{"httpStatusCode":503}, "exception":true, "fault":true }, "Stage":{ "type":"structure", "members":{ "deploymentId":{ "shape":"String", "documentation":"The identifier of the Deployment that the stage points to.
" }, "clientCertificateId":{"shape":"String"}, "stageName":{ "shape":"String", "documentation":"The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.
" }, "description":{ "shape":"String", "documentation":"The stage's description.
" }, "cacheClusterEnabled":{ "shape":"Boolean", "documentation":"Specifies whether a cache cluster is enabled for the stage.
" }, "cacheClusterSize":{ "shape":"CacheClusterSize", "documentation":"The size of the cache cluster for the stage, if enabled.
" }, "cacheClusterStatus":{ "shape":"CacheClusterStatus", "documentation":"The status of the cache cluster for the stage, if enabled.
" }, "methodSettings":{ "shape":"MapOfMethodSettings", "documentation":"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.
A map that defines the stage variables for a Stage resource. Variable names can have alphabetic characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+
" }, "createdDate":{ "shape":"Timestamp", "documentation":"The date and time that the stage was created, in ISO 8601 format.
" }, "lastUpdatedDate":{ "shape":"Timestamp", "documentation":"The date and time that information about the stage was last updated, in ISO 8601 format.
" } }, "documentation":"Represents a unique identifier for a version of a deployed RestApi that is callable by users.
" }, "StageKey":{ "type":"structure", "members":{ "restApiId":{ "shape":"String", "documentation":"A list of Stage resources that are associated with the ApiKey resource.
" }, "stageName":{ "shape":"String", "documentation":"The stage name in the RestApi that the stage key references.
" } }, "documentation":"A reference to a unique stage identified in the format {restApiId}/{stage}.
An individual Stage resource.
" } }, "documentation":"A list of Stage resource that are associated with the ApiKey resource.
" }, "StatusCode":{ "type":"string", "pattern":"[1-5]\\d\\d", "documentation":"The status code.
" }, "String":{"type":"string"}, "Template":{ "type":"structure", "members":{ "value":{ "shape":"String", "documentation":"The Apache Velocity Template Language (VTL) template content used for the template resource.
" } }, "documentation":"Represents a mapping template used to transform a payload.
" }, "TestInvokeMethodRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id" }, "resourceId":{ "shape":"String", "location":"uri", "locationName":"resource_id" }, "httpMethod":{ "shape":"String", "location":"uri", "locationName":"http_method" }, "pathWithQueryString":{"shape":"String"}, "body":{"shape":"String"}, "headers":{"shape":"MapOfHeaderValues"}, "clientCertificateId":{"shape":"String"}, "stageVariables":{"shape":"MapOfStringToString"} } }, "TestInvokeMethodResponse":{ "type":"structure", "members":{ "status":{ "shape":"Integer", "documentation":"The HTTP status code.
" }, "body":{ "shape":"String", "documentation":"The body of HTTP response.
" }, "headers":{ "shape":"MapOfHeaderValues", "documentation":"The headers of HTTP response.
" }, "log":{ "shape":"String", "documentation":"The Amazon API Gateway execution log for the test invoke request.
" }, "latency":{ "shape":"Long", "documentation":"The execution latency of the test invoke request.
" } }, "documentation":"Represents the response of the test invoke request in HTTP method.
" }, "ThrottleSettings":{ "type":"structure", "members":{ "burstLimit":{ "shape":"Integer", "documentation":"Returns the burstLimit when ThrottleSettings is called.
" }, "rateLimit":{ "shape":"Double", "documentation":"Returns the rateLimit when ThrottleSettings is called.
" } }, "documentation":"Returns the throttle settings.
" }, "Timestamp":{"type":"timestamp"}, "TooManyRequestsException":{ "type":"structure", "members":{ "retryAfterSeconds":{ "shape":"String", "location":"header", "locationName":"Retry-After" }, "message":{"shape":"String"} }, "error":{"httpStatusCode":429}, "exception":true }, "UnauthorizedException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "error":{"httpStatusCode":401}, "exception":true }, "UpdateAccountRequest":{ "type":"structure", "members":{ "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
" } }, "documentation":"Requests Amazon API Gateway to change information about the current Account resource.
" }, "UpdateApiKeyRequest":{ "type":"structure", "required":["apiKey"], "members":{ "apiKey":{ "shape":"String", "location":"uri", "locationName":"api_Key", "documentation":"The identifier of the ApiKey resource to be updated.
" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
" } }, "documentation":"A request to change information about an ApiKey resource.
" }, "UpdateBasePathMappingRequest":{ "type":"structure", "required":[ "domainName", "basePath" ], "members":{ "domainName":{ "shape":"String", "location":"uri", "locationName":"domain_name", "documentation":"The domain name of the BasePathMapping resource to change.
" }, "basePath":{ "shape":"String", "location":"uri", "locationName":"base_path", "documentation":"The base path of the BasePathMapping resource to change.
" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
" } }, "documentation":"A request to change information about the BasePathMapping resource.
" }, "UpdateClientCertificateRequest":{ "type":"structure", "required":["clientCertificateId"], "members":{ "clientCertificateId":{ "shape":"String", "location":"uri", "locationName":"clientcertificate_id" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"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":{ "type":"structure", "required":[ "restApiId", "deploymentId" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The replacement identifier of the RestApi resource for the Deployment resource to change information about.
" }, "deploymentId":{ "shape":"String", "location":"uri", "locationName":"deployment_id", "documentation":"The replacment identifier for the Deployment resource to change information about.
" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
" } }, "documentation":"Requests Amazon API Gateway to change information about a Deployment resource.
" }, "UpdateDomainNameRequest":{ "type":"structure", "required":["domainName"], "members":{ "domainName":{ "shape":"String", "location":"uri", "locationName":"domain_name", "documentation":"The name of the DomainName resource to be changed.
" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
" } }, "documentation":"A request to change information about the DomainName resource.
" }, "UpdateIntegrationRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"Represents an update integration request's API identifier.
" }, "resourceId":{ "shape":"String", "location":"uri", "locationName":"resource_id", "documentation":"Represents an update integration request's resource identifier.
" }, "httpMethod":{ "shape":"String", "location":"uri", "locationName":"http_method", "documentation":"Represents an update integration request's HTTP method.
" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
" } }, "documentation":"Represents an update integration request.
" }, "UpdateIntegrationResponseRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod", "statusCode" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"Specifies an update integration response request's API identifier.
" }, "resourceId":{ "shape":"String", "location":"uri", "locationName":"resource_id", "documentation":"Specifies an update integration response request's resource identifier.
" }, "httpMethod":{ "shape":"String", "location":"uri", "locationName":"http_method", "documentation":"Specifies an update integration response request's HTTP method.
" }, "statusCode":{ "shape":"StatusCode", "location":"uri", "locationName":"status_code", "documentation":"Specifies an update integration response request's status code.
" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
" } }, "documentation":"Represents an update integration response request.
" }, "UpdateMethodRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The RestApi identifier for the Method resource.
" }, "resourceId":{ "shape":"String", "location":"uri", "locationName":"resource_id", "documentation":"The Resource identifier for the Method resource.
" }, "httpMethod":{ "shape":"String", "location":"uri", "locationName":"http_method", "documentation":"The HTTP verb that identifies the Method resource.
" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
" } }, "documentation":"Request to update an existing Method resource.
" }, "UpdateMethodResponseRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod", "statusCode" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The RestApi identifier for the MethodResponse resource.
" }, "resourceId":{ "shape":"String", "location":"uri", "locationName":"resource_id", "documentation":"The Resource identifier for the MethodResponse resource.
" }, "httpMethod":{ "shape":"String", "location":"uri", "locationName":"http_method", "documentation":"The HTTP verb identifier for the parent Method resource.
" }, "statusCode":{ "shape":"StatusCode", "location":"uri", "locationName":"status_code", "documentation":"The status code identifier for the MethodResponse resource.
" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
" } }, "documentation":"A request to update an existing MethodResponse resource.
" }, "UpdateModelRequest":{ "type":"structure", "required":[ "restApiId", "modelName" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The RestApi identifier under which the model exists.
" }, "modelName":{ "shape":"String", "location":"uri", "locationName":"model_name", "documentation":"The name of the model to update.
" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
" } }, "documentation":"Request to update an existing model in an existing RestApi resource.
" }, "UpdateResourceRequest":{ "type":"structure", "required":[ "restApiId", "resourceId" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The RestApi identifier for the Resource resource.
" }, "resourceId":{ "shape":"String", "location":"uri", "locationName":"resource_id", "documentation":"The identifier of the Resource resource.
" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
" } }, "documentation":"Request to change information about a Resource resource.
" }, "UpdateRestApiRequest":{ "type":"structure", "required":["restApiId"], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The ID of the RestApi you want to update.
" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
" } }, "documentation":"Request to update an existing RestApi resource in your collection.
" }, "UpdateStageRequest":{ "type":"structure", "required":[ "restApiId", "stageName" ], "members":{ "restApiId":{ "shape":"String", "location":"uri", "locationName":"restapi_id", "documentation":"The identifier of the RestApi resource for the Stage resource to change information about.
" }, "stageName":{ "shape":"String", "location":"uri", "locationName":"stage_name", "documentation":"The name of the Stage resource to change information about.
" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
" } }, "documentation":"Requests Amazon API Gateway to change information about a Stage resource.
" }, "op":{ "type":"string", "enum":[ "add", "remove", "replace", "move", "copy", "test" ] } }, "examples":{ } }