{"files":{"SKILL.md":"---\nname: amazon-api-gateway\ndescription: \"Amazon API Gateway API skill. Use when working with Amazon API Gateway for apikeys, restapis, domainnames. Covers 120 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# Amazon API Gateway\nAPI version: 2015-07-09\n\n## Auth\nAWS SigV4\n\n## Base URL\nNot specified.\n\n## Setup\n1. Configure auth: AWS SigV4\n2. GET /account -- gets information about the current account resource.\n3. POST /apikeys -- create first apikey\n\n## Endpoints\n120 endpoints across 11 groups. See references/api-spec.lap for full details.\n\n### Apikeys\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /apikeys | Create an ApiKey resource. |\n| DELETE | /apikeys/{api_Key} | Deletes the ApiKey resource. |\n| GET | /apikeys/{api_Key} | Gets information about the current ApiKey resource. |\n| GET | /apikeys | Gets information about the current ApiKeys resource. |\n| PATCH | /apikeys/{api_Key} | Changes information about an ApiKey resource. |\n\n### Restapis\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /restapis/{restapi_id}/authorizers | Adds a new Authorizer resource to an existing RestApi resource. |\n| POST | /restapis/{restapi_id}/deployments | Creates a Deployment resource, which makes a specified RestApi callable over the internet. |\n| POST | /restapis/{restapi_id}/documentation/parts | Creates a documentation part. |\n| POST | /restapis/{restapi_id}/documentation/versions | Creates a documentation version |\n| POST | /restapis/{restapi_id}/models | Adds a new Model resource to an existing RestApi resource. |\n| POST | /restapis/{restapi_id}/requestvalidators | Creates a RequestValidator of a given RestApi. |\n| POST | /restapis/{restapi_id}/resources/{parent_id} | Creates a Resource resource. |\n| POST | /restapis | Creates a new RestApi resource. |\n| POST | /restapis/{restapi_id}/stages | Creates a new Stage resource that references a pre-existing Deployment for the API. |\n| DELETE | /restapis/{restapi_id}/authorizers/{authorizer_id} | Deletes an existing Authorizer resource. |\n| DELETE | /restapis/{restapi_id}/deployments/{deployment_id} | Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it. |\n| DELETE | /restapis/{restapi_id}/documentation/parts/{part_id} | Deletes a documentation part |\n| DELETE | /restapis/{restapi_id}/documentation/versions/{doc_version} | Deletes a documentation version. |\n| DELETE | /restapis/{restapi_id}/gatewayresponses/{response_type} | Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings. |\n| DELETE | /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration | Represents a delete integration. |\n| DELETE | /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code} | Represents a delete integration response. |\n| DELETE | /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method} | Deletes an existing Method resource. |\n| DELETE | /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code} | Deletes an existing MethodResponse resource. |\n| DELETE | /restapis/{restapi_id}/models/{model_name} | Deletes a model. |\n| DELETE | /restapis/{restapi_id}/requestvalidators/{requestvalidator_id} | Deletes a RequestValidator of a given RestApi. |\n| DELETE | /restapis/{restapi_id}/resources/{resource_id} | Deletes a Resource resource. |\n| DELETE | /restapis/{restapi_id} | Deletes the specified API. |\n| DELETE | /restapis/{restapi_id}/stages/{stage_name} | Deletes a Stage resource. |\n| DELETE | /restapis/{restapi_id}/stages/{stage_name}/cache/authorizers | Flushes all authorizer cache entries on a stage. |\n| DELETE | /restapis/{restapi_id}/stages/{stage_name}/cache/data | Flushes a stage's cache. |\n| GET | /restapis/{restapi_id}/authorizers/{authorizer_id} | Describe an existing Authorizer resource. |\n| GET | /restapis/{restapi_id}/authorizers | Describe an existing Authorizers resource. |\n| GET | /restapis/{restapi_id}/deployments/{deployment_id} | Gets information about a Deployment resource. |\n| GET | /restapis/{restapi_id}/deployments | Gets information about a Deployments collection. |\n| GET | /restapis/{restapi_id}/documentation/parts/{part_id} | Gets a documentation part. |\n| GET | /restapis/{restapi_id}/documentation/parts | Gets documentation parts. |\n| GET | /restapis/{restapi_id}/documentation/versions/{doc_version} | Gets a documentation version. |\n| GET | /restapis/{restapi_id}/documentation/versions | Gets documentation versions. |\n| GET | /restapis/{restapi_id}/stages/{stage_name}/exports/{export_type} | Exports a deployed version of a RestApi in a specified format. |\n| GET | /restapis/{restapi_id}/gatewayresponses/{response_type} | Gets a GatewayResponse of a specified response type on the given RestApi. |\n| GET | /restapis/{restapi_id}/gatewayresponses | Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types. |\n| GET | /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration | Get the integration settings. |\n| GET | /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code} | Represents a get integration response. |\n| GET | /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method} | Describe an existing Method resource. |\n| GET | /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code} | Describes a MethodResponse resource. |\n| GET | /restapis/{restapi_id}/models/{model_name} | Describes an existing model defined for a RestApi resource. |\n| GET | /restapis/{restapi_id}/models/{model_name}/default_template | Generates a sample mapping template that can be used to transform a payload into the structure of a model. |\n| GET | /restapis/{restapi_id}/models | Describes existing Models defined for a RestApi resource. |\n| GET | /restapis/{restapi_id}/requestvalidators/{requestvalidator_id} | Gets a RequestValidator of a given RestApi. |\n| GET | /restapis/{restapi_id}/requestvalidators | Gets the RequestValidators collection of a given RestApi. |\n| GET | /restapis/{restapi_id}/resources/{resource_id} | Lists information about a resource. |\n| GET | /restapis/{restapi_id}/resources | Lists information about a collection of Resource resources. |\n| GET | /restapis/{restapi_id} | Lists the RestApi resource in the collection. |\n| GET | /restapis | Lists the RestApis resources for your collection. |\n| GET | /restapis/{restapi_id}/stages/{stage_name}/sdks/{sdk_type} | Generates a client SDK for a RestApi and Stage. |\n| GET | /restapis/{restapi_id}/stages/{stage_name} | Gets information about a Stage resource. |\n| GET | /restapis/{restapi_id}/stages | Gets information about one or more Stage resources. |\n| PUT | /restapis/{restapi_id}/documentation/parts | Imports documentation parts |\n| PUT | /restapis/{restapi_id}/gatewayresponses/{response_type} | Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi. |\n| PUT | /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration | Sets up a method's integration. |\n| PUT | /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code} | Represents a put integration. |\n| PUT | /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method} | Add a method to an existing Resource resource. |\n| PUT | /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code} | Adds a MethodResponse to an existing Method resource. |\n| PUT | /restapis/{restapi_id} | A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API. |\n| POST | /restapis/{restapi_id}/authorizers/{authorizer_id} | Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body. |\n| POST | /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method} | Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body. |\n| PATCH | /restapis/{restapi_id}/authorizers/{authorizer_id} | Updates an existing Authorizer resource. |\n| PATCH | /restapis/{restapi_id}/deployments/{deployment_id} | Changes information about a Deployment resource. |\n| PATCH | /restapis/{restapi_id}/documentation/parts/{part_id} | Updates a documentation part. |\n| PATCH | /restapis/{restapi_id}/documentation/versions/{doc_version} | Updates a documentation version. |\n| PATCH | /restapis/{restapi_id}/gatewayresponses/{response_type} | Updates a GatewayResponse of a specified response type on the given RestApi. |\n| PATCH | /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration | Represents an update integration. |\n| PATCH | /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code} | Represents an update integration response. |\n| PATCH | /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method} | Updates an existing Method resource. |\n| PATCH | /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code} | Updates an existing MethodResponse resource. |\n| PATCH | /restapis/{restapi_id}/models/{model_name} | Changes information about a model. The maximum size of the model is 400 KB. |\n| PATCH | /restapis/{restapi_id}/requestvalidators/{requestvalidator_id} | Updates a RequestValidator of a given RestApi. |\n| PATCH | /restapis/{restapi_id}/resources/{resource_id} | Changes information about a Resource resource. |\n| PATCH | /restapis/{restapi_id} | Changes information about the specified API. |\n| PATCH | /restapis/{restapi_id}/stages/{stage_name} | Changes information about a Stage resource. |\n\n### Domainnames\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /domainnames/{domain_name}/basepathmappings | Creates a new BasePathMapping resource. |\n| POST | /domainnames | Creates a new domain name. |\n| DELETE | /domainnames/{domain_name}/basepathmappings/{base_path} | Deletes the BasePathMapping resource. |\n| DELETE | /domainnames/{domain_name} | Deletes the DomainName resource. |\n| GET | /domainnames/{domain_name}/basepathmappings/{base_path} | Describe a BasePathMapping resource. |\n| GET | /domainnames/{domain_name}/basepathmappings | Represents a collection of BasePathMapping resources. |\n| GET | /domainnames/{domain_name} | Represents a domain name that is contained in a simpler, more intuitive URL that can be called. |\n| GET | /domainnames | Represents a collection of DomainName resources. |\n| PATCH | /domainnames/{domain_name}/basepathmappings/{base_path} | Changes information about the BasePathMapping resource. |\n| PATCH | /domainnames/{domain_name} | Changes information about the DomainName resource. |\n\n### Usageplans\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /usageplans | Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload. |\n| POST | /usageplans/{usageplanId}/keys | Creates a usage plan key for adding an existing API key to a usage plan. |\n| DELETE | /usageplans/{usageplanId} | Deletes a usage plan of a given plan Id. |\n| DELETE | /usageplans/{usageplanId}/keys/{keyId} | Deletes a usage plan key and remove the underlying API key from the associated usage plan. |\n| GET | /usageplans/{usageplanId}/usage | Gets the usage data of a usage plan in a specified time interval. |\n| GET | /usageplans/{usageplanId} | Gets a usage plan of a given plan identifier. |\n| GET | /usageplans/{usageplanId}/keys/{keyId} | Gets a usage plan key of a given key identifier. |\n| GET | /usageplans/{usageplanId}/keys | Gets all the usage plan keys representing the API keys added to a specified usage plan. |\n| GET | /usageplans | Gets all the usage plans of the caller's account. |\n| PATCH | /usageplans/{usageplanId}/keys/{keyId}/usage | Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key. |\n| PATCH | /usageplans/{usageplanId} | Updates a usage plan of a given plan Id. |\n\n### Vpclinks\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /vpclinks | Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services. |\n| DELETE | /vpclinks/{vpclink_id} | Deletes an existing VpcLink of a specified identifier. |\n| GET | /vpclinks/{vpclink_id} | Gets a specified VPC link under the caller's account in a region. |\n| GET | /vpclinks | Gets the VpcLinks collection under the caller's account in a selected region. |\n| PATCH | /vpclinks/{vpclink_id} | Updates an existing VpcLink of a specified identifier. |\n\n### Clientcertificates\n| Method | Path | Description |\n|--------|------|-------------|\n| DELETE | /clientcertificates/{clientcertificate_id} | Deletes the ClientCertificate resource. |\n| POST | /clientcertificates | Generates a ClientCertificate resource. |\n| GET | /clientcertificates/{clientcertificate_id} | Gets information about the current ClientCertificate resource. |\n| GET | /clientcertificates | Gets a collection of ClientCertificate resources. |\n| PATCH | /clientcertificates/{clientcertificate_id} | Changes information about an ClientCertificate resource. |\n\n### Account\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /account | Gets information about the current Account resource. |\n| PATCH | /account | Changes information about the current Account resource. |\n\n### Sdktypes\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /sdktypes/{sdktype_id} | Gets an SDK type. |\n| GET | /sdktypes | Gets SDK types |\n\n### Tags\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /tags/{resource_arn} | Gets the Tags collection for a given resource. |\n| PUT | /tags/{resource_arn} | Adds or updates a tag on a given resource. |\n| DELETE | /tags/{resource_arn} | Removes a tag from a given resource. |\n\n### Apikeys?mode=import\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /apikeys?mode=import | Import API keys from an external source, such as a CSV-formatted file. |\n\n### Restapis?mode=import\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /restapis?mode=import | A feature of the API Gateway control service for creating a new API from an external API definition file. |\n\n## Common Questions\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"Create a apikey?\" -> POST /apikeys\n- \"Create a authorizer?\" -> POST /restapis/{restapi_id}/authorizers\n- \"Create a basepathmapping?\" -> POST /domainnames/{domain_name}/basepathmappings\n- \"Create a deployment?\" -> POST /restapis/{restapi_id}/deployments\n- \"Create a part?\" -> POST /restapis/{restapi_id}/documentation/parts\n- \"Create a version?\" -> POST /restapis/{restapi_id}/documentation/versions\n- \"Create a domainname?\" -> POST /domainnames\n- \"Create a model?\" -> POST /restapis/{restapi_id}/models\n- \"Create a requestvalidator?\" -> POST /restapis/{restapi_id}/requestvalidators\n- \"Create a restapis?\" -> POST /restapis\n- \"Create a stage?\" -> POST /restapis/{restapi_id}/stages\n- \"Create a usageplan?\" -> POST /usageplans\n- \"Create a key?\" -> POST /usageplans/{usageplanId}/keys\n- \"Create a vpclink?\" -> POST /vpclinks\n- \"Delete a apikey?\" -> DELETE /apikeys/{api_Key}\n- \"Delete a authorizer?\" -> DELETE /restapis/{restapi_id}/authorizers/{authorizer_id}\n- \"Delete a basepathmapping?\" -> DELETE /domainnames/{domain_name}/basepathmappings/{base_path}\n- \"Delete a clientcertificate?\" -> DELETE /clientcertificates/{clientcertificate_id}\n- \"Delete a deployment?\" -> DELETE /restapis/{restapi_id}/deployments/{deployment_id}\n- \"Delete a part?\" -> DELETE /restapis/{restapi_id}/documentation/parts/{part_id}\n- \"Delete a version?\" -> DELETE /restapis/{restapi_id}/documentation/versions/{doc_version}\n- \"Delete a domainname?\" -> DELETE /domainnames/{domain_name}\n- \"Delete a gatewayresponse?\" -> DELETE /restapis/{restapi_id}/gatewayresponses/{response_type}\n- \"Delete a response?\" -> DELETE /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}\n- \"Delete a method?\" -> DELETE /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}\n- \"Delete a model?\" -> DELETE /restapis/{restapi_id}/models/{model_name}\n- \"Delete a requestvalidator?\" -> DELETE /restapis/{restapi_id}/requestvalidators/{requestvalidator_id}\n- \"Delete a resource?\" -> DELETE /restapis/{restapi_id}/resources/{resource_id}\n- \"Delete a restapis?\" -> DELETE /restapis/{restapi_id}\n- \"Delete a stage?\" -> DELETE /restapis/{restapi_id}/stages/{stage_name}\n- \"Delete a usageplan?\" -> DELETE /usageplans/{usageplanId}\n- \"Delete a key?\" -> DELETE /usageplans/{usageplanId}/keys/{keyId}\n- \"Delete a vpclink?\" -> DELETE /vpclinks/{vpclink_id}\n- \"Create a clientcertificate?\" -> POST /clientcertificates\n- \"List all account?\" -> GET /account\n- \"Get apikey details?\" -> GET /apikeys/{api_Key}\n- \"List all apikeys?\" -> GET /apikeys\n- \"Get authorizer details?\" -> GET /restapis/{restapi_id}/authorizers/{authorizer_id}\n- \"List all authorizers?\" -> GET /restapis/{restapi_id}/authorizers\n- \"Get basepathmapping details?\" -> GET /domainnames/{domain_name}/basepathmappings/{base_path}\n- \"List all basepathmappings?\" -> GET /domainnames/{domain_name}/basepathmappings\n- \"Get clientcertificate details?\" -> GET /clientcertificates/{clientcertificate_id}\n- \"List all clientcertificates?\" -> GET /clientcertificates\n- \"Get deployment details?\" -> GET /restapis/{restapi_id}/deployments/{deployment_id}\n- \"List all deployments?\" -> GET /restapis/{restapi_id}/deployments\n- \"Get part details?\" -> GET /restapis/{restapi_id}/documentation/parts/{part_id}\n- \"List all parts?\" -> GET /restapis/{restapi_id}/documentation/parts\n- \"Get version details?\" -> GET /restapis/{restapi_id}/documentation/versions/{doc_version}\n- \"List all versions?\" -> GET /restapis/{restapi_id}/documentation/versions\n- \"Get domainname details?\" -> GET /domainnames/{domain_name}\n- \"List all domainnames?\" -> GET /domainnames\n- \"Get export details?\" -> GET /restapis/{restapi_id}/stages/{stage_name}/exports/{export_type}\n- \"Get gatewayresponse details?\" -> GET /restapis/{restapi_id}/gatewayresponses/{response_type}\n- \"List all gatewayresponses?\" -> GET /restapis/{restapi_id}/gatewayresponses\n- \"List all integration?\" -> GET /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration\n- \"Get response details?\" -> GET /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}\n- \"Get method details?\" -> GET /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}\n- \"Get model details?\" -> GET /restapis/{restapi_id}/models/{model_name}\n- \"List all default_template?\" -> GET /restapis/{restapi_id}/models/{model_name}/default_template\n- \"List all models?\" -> GET /restapis/{restapi_id}/models\n- \"Get requestvalidator details?\" -> GET /restapis/{restapi_id}/requestvalidators/{requestvalidator_id}\n- \"List all requestvalidators?\" -> GET /restapis/{restapi_id}/requestvalidators\n- \"Get resource details?\" -> GET /restapis/{restapi_id}/resources/{resource_id}\n- \"List all resources?\" -> GET /restapis/{restapi_id}/resources\n- \"Get restapis details?\" -> GET /restapis/{restapi_id}\n- \"List all restapis?\" -> GET /restapis\n- \"Get sdk details?\" -> GET /restapis/{restapi_id}/stages/{stage_name}/sdks/{sdk_type}\n- \"Get sdktype details?\" -> GET /sdktypes/{sdktype_id}\n- \"List all sdktypes?\" -> GET /sdktypes\n- \"Get stage details?\" -> GET /restapis/{restapi_id}/stages/{stage_name}\n- \"List all stages?\" -> GET /restapis/{restapi_id}/stages\n- \"Get tag details?\" -> GET /tags/{resource_arn}\n- \"List all usage?\" -> GET /usageplans/{usageplanId}/usage\n- \"Get usageplan details?\" -> GET /usageplans/{usageplanId}\n- \"Get key details?\" -> GET /usageplans/{usageplanId}/keys/{keyId}\n- \"List all keys?\" -> GET /usageplans/{usageplanId}/keys\n- \"List all usageplans?\" -> GET /usageplans\n- \"Get vpclink details?\" -> GET /vpclinks/{vpclink_id}\n- \"List all vpclinks?\" -> GET /vpclinks\n- \"Create a apikeys?mode=import?\" -> POST /apikeys?mode=import\n- \"Create a restapis?mode=import?\" -> POST /restapis?mode=import\n- \"Update a gatewayresponse?\" -> PUT /restapis/{restapi_id}/gatewayresponses/{response_type}\n- \"Update a response?\" -> PUT /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}\n- \"Update a method?\" -> PUT /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}\n- \"Update a restapis?\" -> PUT /restapis/{restapi_id}\n- \"Update a tag?\" -> PUT /tags/{resource_arn}\n- \"Delete a tag?\" -> DELETE /tags/{resource_arn}\n- \"Partially update a apikey?\" -> PATCH /apikeys/{api_Key}\n- \"Partially update a authorizer?\" -> PATCH /restapis/{restapi_id}/authorizers/{authorizer_id}\n- \"Partially update a basepathmapping?\" -> PATCH /domainnames/{domain_name}/basepathmappings/{base_path}\n- \"Partially update a clientcertificate?\" -> PATCH /clientcertificates/{clientcertificate_id}\n- \"Partially update a deployment?\" -> PATCH /restapis/{restapi_id}/deployments/{deployment_id}\n- \"Partially update a part?\" -> PATCH /restapis/{restapi_id}/documentation/parts/{part_id}\n- \"Partially update a version?\" -> PATCH /restapis/{restapi_id}/documentation/versions/{doc_version}\n- \"Partially update a domainname?\" -> PATCH /domainnames/{domain_name}\n- \"Partially update a gatewayresponse?\" -> PATCH /restapis/{restapi_id}/gatewayresponses/{response_type}\n- \"Partially update a response?\" -> PATCH /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}\n- \"Partially update a method?\" -> PATCH /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}\n- \"Partially update a model?\" -> PATCH /restapis/{restapi_id}/models/{model_name}\n- \"Partially update a requestvalidator?\" -> PATCH /restapis/{restapi_id}/requestvalidators/{requestvalidator_id}\n- \"Partially update a resource?\" -> PATCH /restapis/{restapi_id}/resources/{resource_id}\n- \"Partially update a restapis?\" -> PATCH /restapis/{restapi_id}\n- \"Partially update a stage?\" -> PATCH /restapis/{restapi_id}/stages/{stage_name}\n- \"Partially update a usageplan?\" -> PATCH /usageplans/{usageplanId}\n- \"Partially update a vpclink?\" -> PATCH /vpclinks/{vpclink_id}\n- \"How to authenticate?\" -> See Auth section above\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Paginated endpoints accept limit/offset or cursor parameters\n- Create/update endpoints return the modified resource on success\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Amazon API Gateway\n@version 2015-07-09\n@auth AWS SigV4\n@endpoints 120\n@hint download_for_search\n@toc apikeys(5), restapis(75), domainnames(10), usageplans(11), vpclinks(5), clientcertificates(5), account(2), sdktypes(2), tags(3), apikeys?mode=import(1), restapis?mode=import(1)\n\n@group apikeys\n@endpoint POST /apikeys\n@desc Create an ApiKey resource.\n@optional {name: str, description: str, enabled: bool, generateDistinctId: bool, value: str, stageKeys: [StageKey], customerId: str, tags: map<str,str>}\n@returns(200) {id: str?, value: str?, name: str?, customerId: str?, description: str?, enabled: bool?, createdDate: str(timestamp)?, lastUpdatedDate: str(timestamp)?, stageKeys: [str]?, tags: map<str,str>?}\n\n@endgroup\n\n@group restapis\n@endpoint POST /restapis/{restapi_id}/authorizers\n@desc Adds a new Authorizer resource to an existing RestApi resource.\n@required {restApiId: str, name: str, type: str}\n@optional {providerARNs: [str], authType: str, authorizerUri: str, authorizerCredentials: str, identitySource: str, identityValidationExpression: str, authorizerResultTtlInSeconds: int}\n@returns(200) {id: str?, name: str?, type: str?, providerARNs: [str]?, authType: str?, authorizerUri: str?, authorizerCredentials: str?, identitySource: str?, identityValidationExpression: str?, authorizerResultTtlInSeconds: int?}\n\n@endgroup\n\n@group domainnames\n@endpoint POST /domainnames/{domain_name}/basepathmappings\n@desc Creates a new BasePathMapping resource.\n@required {domainName: str, restApiId: str}\n@optional {basePath: str, stage: str}\n@returns(200) {basePath: str?, restApiId: str?, stage: str?}\n\n@endgroup\n\n@group restapis\n@endpoint POST /restapis/{restapi_id}/deployments\n@desc Creates a Deployment resource, which makes a specified RestApi callable over the internet.\n@required {restApiId: str}\n@optional {stageName: str, stageDescription: str, description: str, cacheClusterEnabled: bool, cacheClusterSize: str, variables: map<str,str>, canarySettings: DeploymentCanarySettings, tracingEnabled: bool}\n@returns(200) {id: str?, description: str?, createdDate: str(timestamp)?, apiSummary: map<str,map<str,MethodSnapshot>>?}\n\n@endpoint POST /restapis/{restapi_id}/documentation/parts\n@desc Creates a documentation part.\n@required {restApiId: str, location: DocumentationPartLocation, properties: str}\n@returns(200) {id: str?, location: DocumentationPartLocation?{type: str, path: str?, method: str?, statusCode: str?, name: str?}, properties: str?}\n\n@endpoint POST /restapis/{restapi_id}/documentation/versions\n@desc Creates a documentation version\n@required {restApiId: str, documentationVersion: str}\n@optional {stageName: str, description: str}\n@returns(200) {version: str?, createdDate: str(timestamp)?, description: str?}\n\n@endgroup\n\n@group domainnames\n@endpoint POST /domainnames\n@desc Creates a new domain name.\n@required {domainName: str}\n@optional {certificateName: str, certificateBody: str, certificatePrivateKey: str, certificateChain: str, certificateArn: str, regionalCertificateName: str, regionalCertificateArn: str, endpointConfiguration: EndpointConfiguration, tags: map<str,str>, securityPolicy: str, mutualTlsAuthentication: MutualTlsAuthenticationInput, ownershipVerificationCertificateArn: str}\n@returns(200) {domainName: str?, certificateName: str?, certificateArn: str?, certificateUploadDate: str(timestamp)?, regionalDomainName: str?, regionalHostedZoneId: str?, regionalCertificateName: str?, regionalCertificateArn: str?, distributionDomainName: str?, distributionHostedZoneId: str?, endpointConfiguration: EndpointConfiguration?{types: [str]?, vpcEndpointIds: [str]?}, domainNameStatus: str?, domainNameStatusMessage: str?, securityPolicy: str?, tags: map<str,str>?, mutualTlsAuthentication: MutualTlsAuthentication?{truststoreUri: str?, truststoreVersion: str?, truststoreWarnings: [str]?}, ownershipVerificationCertificateArn: str?}\n\n@endgroup\n\n@group restapis\n@endpoint POST /restapis/{restapi_id}/models\n@desc Adds a new Model resource to an existing RestApi resource.\n@required {restApiId: str, name: str, contentType: str}\n@optional {description: str, schema: str}\n@returns(200) {id: str?, name: str?, description: str?, schema: str?, contentType: str?}\n\n@endpoint POST /restapis/{restapi_id}/requestvalidators\n@desc Creates a RequestValidator of a given RestApi.\n@required {restApiId: str}\n@optional {name: str, validateRequestBody: bool, validateRequestParameters: bool}\n@returns(200) {id: str?, name: str?, validateRequestBody: bool?, validateRequestParameters: bool?}\n\n@endpoint POST /restapis/{restapi_id}/resources/{parent_id}\n@desc Creates a Resource resource.\n@required {restApiId: str, parentId: str, pathPart: str}\n@returns(200) {id: str?, parentId: str?, pathPart: str?, path: str?, resourceMethods: map<str,Method>?}\n\n@endpoint POST /restapis\n@desc Creates a new RestApi resource.\n@required {name: str}\n@optional {description: str, version: str, cloneFrom: str, binaryMediaTypes: [str], minimumCompressionSize: int, apiKeySource: str, endpointConfiguration: EndpointConfiguration, policy: str, tags: map<str,str>, disableExecuteApiEndpoint: bool}\n@returns(200) {id: str?, name: str?, description: str?, createdDate: str(timestamp)?, version: str?, warnings: [str]?, binaryMediaTypes: [str]?, minimumCompressionSize: int?, apiKeySource: str?, endpointConfiguration: EndpointConfiguration?{types: [str]?, vpcEndpointIds: [str]?}, policy: str?, tags: map<str,str>?, disableExecuteApiEndpoint: bool?, rootResourceId: str?}\n\n@endpoint POST /restapis/{restapi_id}/stages\n@desc Creates a new Stage resource that references a pre-existing Deployment for the API.\n@required {restApiId: str, stageName: str, deploymentId: str}\n@optional {description: str, cacheClusterEnabled: bool, cacheClusterSize: str, variables: map<str,str>, documentationVersion: str, canarySettings: CanarySettings, tracingEnabled: bool, tags: map<str,str>}\n@returns(200) {deploymentId: str?, clientCertificateId: str?, stageName: str?, description: str?, cacheClusterEnabled: bool?, cacheClusterSize: str?, cacheClusterStatus: str?, methodSettings: map<str,MethodSetting>?, variables: map<str,str>?, documentationVersion: str?, accessLogSettings: AccessLogSettings?{format: str?, destinationArn: str?}, canarySettings: CanarySettings?{percentTraffic: num(f64)?, deploymentId: str?, stageVariableOverrides: map<str, str>?: any, useStageCache: bool?}, tracingEnabled: bool?, webAclArn: str?, tags: map<str,str>?, createdDate: str(timestamp)?, lastUpdatedDate: str(timestamp)?}\n\n@endgroup\n\n@group usageplans\n@endpoint POST /usageplans\n@desc Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.\n@required {name: str}\n@optional {description: str, apiStages: [ApiStage], throttle: ThrottleSettings, quota: QuotaSettings, tags: map<str,str>}\n@returns(200) {id: str?, name: str?, description: str?, apiStages: [ApiStage]?, throttle: ThrottleSettings?{burstLimit: int?, rateLimit: num(f64)?}, quota: QuotaSettings?{limit: int?, offset: int?, period: str?}, productCode: str?, tags: map<str,str>?}\n\n@endpoint POST /usageplans/{usageplanId}/keys\n@desc Creates a usage plan key for adding an existing API key to a usage plan.\n@required {usagePlanId: str, keyId: str, keyType: str}\n@returns(200) {id: str?, type: str?, value: str?, name: str?}\n\n@endgroup\n\n@group vpclinks\n@endpoint POST /vpclinks\n@desc Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.\n@required {name: str, targetArns: [str]}\n@optional {description: str, tags: map<str,str>}\n@returns(200) {id: str?, name: str?, description: str?, targetArns: [str]?, status: str?, statusMessage: str?, tags: map<str,str>?}\n\n@endgroup\n\n@group apikeys\n@endpoint DELETE /apikeys/{api_Key}\n@desc Deletes the ApiKey resource.\n@required {apiKey: str}\n\n@endgroup\n\n@group restapis\n@endpoint DELETE /restapis/{restapi_id}/authorizers/{authorizer_id}\n@desc Deletes an existing Authorizer resource.\n@required {restApiId: str, authorizerId: str}\n\n@endgroup\n\n@group domainnames\n@endpoint DELETE /domainnames/{domain_name}/basepathmappings/{base_path}\n@desc Deletes the BasePathMapping resource.\n@required {domainName: str, basePath: str}\n\n@endgroup\n\n@group clientcertificates\n@endpoint DELETE /clientcertificates/{clientcertificate_id}\n@desc Deletes the ClientCertificate resource.\n@required {clientCertificateId: str}\n\n@endgroup\n\n@group restapis\n@endpoint DELETE /restapis/{restapi_id}/deployments/{deployment_id}\n@desc Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.\n@required {restApiId: str, deploymentId: str}\n\n@endpoint DELETE /restapis/{restapi_id}/documentation/parts/{part_id}\n@desc Deletes a documentation part\n@required {restApiId: str, documentationPartId: str}\n\n@endpoint DELETE /restapis/{restapi_id}/documentation/versions/{doc_version}\n@desc Deletes a documentation version.\n@required {restApiId: str, documentationVersion: str}\n\n@endgroup\n\n@group domainnames\n@endpoint DELETE /domainnames/{domain_name}\n@desc Deletes the DomainName resource.\n@required {domainName: str}\n\n@endgroup\n\n@group restapis\n@endpoint DELETE /restapis/{restapi_id}/gatewayresponses/{response_type}\n@desc Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.\n@required {restApiId: str, responseType: str}\n\n@endpoint DELETE /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration\n@desc Represents a delete integration.\n@required {restApiId: str, resourceId: str, httpMethod: str}\n\n@endpoint DELETE /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}\n@desc Represents a delete integration response.\n@required {restApiId: str, resourceId: str, httpMethod: str, statusCode: str}\n\n@endpoint DELETE /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}\n@desc Deletes an existing Method resource.\n@required {restApiId: str, resourceId: str, httpMethod: str}\n\n@endpoint DELETE /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}\n@desc Deletes an existing MethodResponse resource.\n@required {restApiId: str, resourceId: str, httpMethod: str, statusCode: str}\n\n@endpoint DELETE /restapis/{restapi_id}/models/{model_name}\n@desc Deletes a model.\n@required {restApiId: str, modelName: str}\n\n@endpoint DELETE /restapis/{restapi_id}/requestvalidators/{requestvalidator_id}\n@desc Deletes a RequestValidator of a given RestApi.\n@required {restApiId: str, requestValidatorId: str}\n\n@endpoint DELETE /restapis/{restapi_id}/resources/{resource_id}\n@desc Deletes a Resource resource.\n@required {restApiId: str, resourceId: str}\n\n@endpoint DELETE /restapis/{restapi_id}\n@desc Deletes the specified API.\n@required {restApiId: str}\n\n@endpoint DELETE /restapis/{restapi_id}/stages/{stage_name}\n@desc Deletes a Stage resource.\n@required {restApiId: str, stageName: str}\n\n@endgroup\n\n@group usageplans\n@endpoint DELETE /usageplans/{usageplanId}\n@desc Deletes a usage plan of a given plan Id.\n@required {usagePlanId: str}\n\n@endpoint DELETE /usageplans/{usageplanId}/keys/{keyId}\n@desc Deletes a usage plan key and remove the underlying API key from the associated usage plan.\n@required {usagePlanId: str, keyId: str}\n\n@endgroup\n\n@group vpclinks\n@endpoint DELETE /vpclinks/{vpclink_id}\n@desc Deletes an existing VpcLink of a specified identifier.\n@required {vpcLinkId: str}\n\n@endgroup\n\n@group restapis\n@endpoint DELETE /restapis/{restapi_id}/stages/{stage_name}/cache/authorizers\n@desc Flushes all authorizer cache entries on a stage.\n@required {restApiId: str, stageName: str}\n\n@endpoint DELETE /restapis/{restapi_id}/stages/{stage_name}/cache/data\n@desc Flushes a stage's cache.\n@required {restApiId: str, stageName: str}\n\n@endgroup\n\n@group clientcertificates\n@endpoint POST /clientcertificates\n@desc Generates a ClientCertificate resource.\n@optional {description: str, tags: map<str,str>}\n@returns(200) {clientCertificateId: str?, description: str?, pemEncodedCertificate: str?, createdDate: str(timestamp)?, expirationDate: str(timestamp)?, tags: map<str,str>?}\n\n@endgroup\n\n@group account\n@endpoint GET /account\n@desc Gets information about the current Account resource.\n@returns(200) {cloudwatchRoleArn: str?, throttleSettings: ThrottleSettings?{burstLimit: int?, rateLimit: num(f64)?}, features: [str]?, apiKeyVersion: str?}\n\n@endgroup\n\n@group apikeys\n@endpoint GET /apikeys/{api_Key}\n@desc Gets information about the current ApiKey resource.\n@required {apiKey: str}\n@optional {includeValue: bool}\n@returns(200) {id: str?, value: str?, name: str?, customerId: str?, description: str?, enabled: bool?, createdDate: str(timestamp)?, lastUpdatedDate: str(timestamp)?, stageKeys: [str]?, tags: map<str,str>?}\n\n@endpoint GET /apikeys\n@desc Gets information about the current ApiKeys resource.\n@optional {position: str, limit: int, name: str, customerId: str, includeValues: bool}\n@returns(200) {warnings: [str]?, position: str?, items: [ApiKey]?}\n\n@endgroup\n\n@group restapis\n@endpoint GET /restapis/{restapi_id}/authorizers/{authorizer_id}\n@desc Describe an existing Authorizer resource.\n@required {restApiId: str, authorizerId: str}\n@returns(200) {id: str?, name: str?, type: str?, providerARNs: [str]?, authType: str?, authorizerUri: str?, authorizerCredentials: str?, identitySource: str?, identityValidationExpression: str?, authorizerResultTtlInSeconds: int?}\n\n@endpoint GET /restapis/{restapi_id}/authorizers\n@desc Describe an existing Authorizers resource.\n@required {restApiId: str}\n@optional {position: str, limit: int}\n@returns(200) {position: str?, items: [Authorizer]?}\n\n@endgroup\n\n@group domainnames\n@endpoint GET /domainnames/{domain_name}/basepathmappings/{base_path}\n@desc Describe a BasePathMapping resource.\n@required {domainName: str, basePath: str}\n@returns(200) {basePath: str?, restApiId: str?, stage: str?}\n\n@endpoint GET /domainnames/{domain_name}/basepathmappings\n@desc Represents a collection of BasePathMapping resources.\n@required {domainName: str}\n@optional {position: str, limit: int}\n@returns(200) {position: str?, items: [BasePathMapping]?}\n\n@endgroup\n\n@group clientcertificates\n@endpoint GET /clientcertificates/{clientcertificate_id}\n@desc Gets information about the current ClientCertificate resource.\n@required {clientCertificateId: str}\n@returns(200) {clientCertificateId: str?, description: str?, pemEncodedCertificate: str?, createdDate: str(timestamp)?, expirationDate: str(timestamp)?, tags: map<str,str>?}\n\n@endpoint GET /clientcertificates\n@desc Gets a collection of ClientCertificate resources.\n@optional {position: str, limit: int}\n@returns(200) {position: str?, items: [ClientCertificate]?}\n\n@endgroup\n\n@group restapis\n@endpoint GET /restapis/{restapi_id}/deployments/{deployment_id}\n@desc Gets information about a Deployment resource.\n@required {restApiId: str, deploymentId: str}\n@optional {embed: [str]}\n@returns(200) {id: str?, description: str?, createdDate: str(timestamp)?, apiSummary: map<str,map<str,MethodSnapshot>>?}\n\n@endpoint GET /restapis/{restapi_id}/deployments\n@desc Gets information about a Deployments collection.\n@required {restApiId: str}\n@optional {position: str, limit: int}\n@returns(200) {position: str?, items: [Deployment]?}\n\n@endpoint GET /restapis/{restapi_id}/documentation/parts/{part_id}\n@desc Gets a documentation part.\n@required {restApiId: str, documentationPartId: str}\n@returns(200) {id: str?, location: DocumentationPartLocation?{type: str, path: str?, method: str?, statusCode: str?, name: str?}, properties: str?}\n\n@endpoint GET /restapis/{restapi_id}/documentation/parts\n@desc Gets documentation parts.\n@required {restApiId: str}\n@optional {type: str, name: str, path: str, position: str, limit: int, locationStatus: str}\n@returns(200) {position: str?, items: [DocumentationPart]?}\n\n@endpoint GET /restapis/{restapi_id}/documentation/versions/{doc_version}\n@desc Gets a documentation version.\n@required {restApiId: str, documentationVersion: str}\n@returns(200) {version: str?, createdDate: str(timestamp)?, description: str?}\n\n@endpoint GET /restapis/{restapi_id}/documentation/versions\n@desc Gets documentation versions.\n@required {restApiId: str}\n@optional {position: str, limit: int}\n@returns(200) {position: str?, items: [DocumentationVersion]?}\n\n@endgroup\n\n@group domainnames\n@endpoint GET /domainnames/{domain_name}\n@desc Represents a domain name that is contained in a simpler, more intuitive URL that can be called.\n@required {domainName: str}\n@returns(200) {domainName: str?, certificateName: str?, certificateArn: str?, certificateUploadDate: str(timestamp)?, regionalDomainName: str?, regionalHostedZoneId: str?, regionalCertificateName: str?, regionalCertificateArn: str?, distributionDomainName: str?, distributionHostedZoneId: str?, endpointConfiguration: EndpointConfiguration?{types: [str]?, vpcEndpointIds: [str]?}, domainNameStatus: str?, domainNameStatusMessage: str?, securityPolicy: str?, tags: map<str,str>?, mutualTlsAuthentication: MutualTlsAuthentication?{truststoreUri: str?, truststoreVersion: str?, truststoreWarnings: [str]?}, ownershipVerificationCertificateArn: str?}\n\n@endpoint GET /domainnames\n@desc Represents a collection of DomainName resources.\n@optional {position: str, limit: int}\n@returns(200) {position: str?, items: [DomainName]?}\n\n@endgroup\n\n@group restapis\n@endpoint GET /restapis/{restapi_id}/stages/{stage_name}/exports/{export_type}\n@desc Exports a deployed version of a RestApi in a specified format.\n@required {restApiId: str, stageName: str, exportType: str}\n@optional {parameters: map<str,str>, Accept: str}\n@returns(200) {contentType: str?, contentDisposition: str?, body: bytes?}\n\n@endpoint GET /restapis/{restapi_id}/gatewayresponses/{response_type}\n@desc Gets a GatewayResponse of a specified response type on the given RestApi.\n@required {restApiId: str, responseType: str}\n@returns(200) {responseType: str?, statusCode: str?, responseParameters: map<str,str>?, responseTemplates: map<str,str>?, defaultResponse: bool?}\n\n@endpoint GET /restapis/{restapi_id}/gatewayresponses\n@desc Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.\n@required {restApiId: str}\n@optional {position: str, limit: int}\n@returns(200) {position: str?, items: [GatewayResponse]?}\n\n@endpoint GET /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration\n@desc Get the integration settings.\n@required {restApiId: str, resourceId: str, httpMethod: str}\n@returns(200) {type: str?, httpMethod: str?, uri: str?, connectionType: str?, connectionId: str?, credentials: str?, requestParameters: map<str,str>?, requestTemplates: map<str,str>?, passthroughBehavior: str?, contentHandling: str?, timeoutInMillis: int?, cacheNamespace: str?, cacheKeyParameters: [str]?, integrationResponses: map<str,IntegrationResponse>?, tlsConfig: TlsConfig?{insecureSkipVerification: bool?}}\n\n@endpoint GET /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}\n@desc Represents a get integration response.\n@required {restApiId: str, resourceId: str, httpMethod: str, statusCode: str}\n@returns(200) {statusCode: str?, selectionPattern: str?, responseParameters: map<str,str>?, responseTemplates: map<str,str>?, contentHandling: str?}\n\n@endpoint GET /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}\n@desc Describe an existing Method resource.\n@required {restApiId: str, resourceId: str, httpMethod: str}\n@returns(200) {httpMethod: str?, authorizationType: str?, authorizerId: str?, apiKeyRequired: bool?, requestValidatorId: str?, operationName: str?, requestParameters: map<str,bool>?, requestModels: map<str,str>?, methodResponses: map<str,MethodResponse>?, methodIntegration: Integration?{type: str?, httpMethod: str?, uri: str?, connectionType: str?, connectionId: str?, credentials: str?, requestParameters: map<str, str>?: any, requestTemplates: map<str, str>?: any, passthroughBehavior: str?, contentHandling: str?, timeoutInMillis: int?, cacheNamespace: str?, cacheKeyParameters: [str]?, integrationResponses: map<str, IntegrationResponse>?: any, tlsConfig: TlsConfig?{insecureSkipVerification: bool?}}, authorizationScopes: [str]?}\n\n@endpoint GET /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}\n@desc Describes a MethodResponse resource.\n@required {restApiId: str, resourceId: str, httpMethod: str, statusCode: str}\n@returns(200) {statusCode: str?, responseParameters: map<str,bool>?, responseModels: map<str,str>?}\n\n@endpoint GET /restapis/{restapi_id}/models/{model_name}\n@desc Describes an existing model defined for a RestApi resource.\n@required {restApiId: str, modelName: str}\n@optional {flatten: bool}\n@returns(200) {id: str?, name: str?, description: str?, schema: str?, contentType: str?}\n\n@endpoint GET /restapis/{restapi_id}/models/{model_name}/default_template\n@desc Generates a sample mapping template that can be used to transform a payload into the structure of a model.\n@required {restApiId: str, modelName: str}\n@returns(200) {value: str?}\n\n@endpoint GET /restapis/{restapi_id}/models\n@desc Describes existing Models defined for a RestApi resource.\n@required {restApiId: str}\n@optional {position: str, limit: int}\n@returns(200) {position: str?, items: [Model]?}\n\n@endpoint GET /restapis/{restapi_id}/requestvalidators/{requestvalidator_id}\n@desc Gets a RequestValidator of a given RestApi.\n@required {restApiId: str, requestValidatorId: str}\n@returns(200) {id: str?, name: str?, validateRequestBody: bool?, validateRequestParameters: bool?}\n\n@endpoint GET /restapis/{restapi_id}/requestvalidators\n@desc Gets the RequestValidators collection of a given RestApi.\n@required {restApiId: str}\n@optional {position: str, limit: int}\n@returns(200) {position: str?, items: [RequestValidator]?}\n\n@endpoint GET /restapis/{restapi_id}/resources/{resource_id}\n@desc Lists information about a resource.\n@required {restApiId: str, resourceId: str}\n@optional {embed: [str]}\n@returns(200) {id: str?, parentId: str?, pathPart: str?, path: str?, resourceMethods: map<str,Method>?}\n\n@endpoint GET /restapis/{restapi_id}/resources\n@desc Lists information about a collection of Resource resources.\n@required {restApiId: str}\n@optional {position: str, limit: int, embed: [str]}\n@returns(200) {position: str?, items: [Resource]?}\n\n@endpoint GET /restapis/{restapi_id}\n@desc Lists the RestApi resource in the collection.\n@required {restApiId: str}\n@returns(200) {id: str?, name: str?, description: str?, createdDate: str(timestamp)?, version: str?, warnings: [str]?, binaryMediaTypes: [str]?, minimumCompressionSize: int?, apiKeySource: str?, endpointConfiguration: EndpointConfiguration?{types: [str]?, vpcEndpointIds: [str]?}, policy: str?, tags: map<str,str>?, disableExecuteApiEndpoint: bool?, rootResourceId: str?}\n\n@endpoint GET /restapis\n@desc Lists the RestApis resources for your collection.\n@optional {position: str, limit: int}\n@returns(200) {position: str?, items: [RestApi]?}\n\n@endpoint GET /restapis/{restapi_id}/stages/{stage_name}/sdks/{sdk_type}\n@desc Generates a client SDK for a RestApi and Stage.\n@required {restApiId: str, stageName: str, sdkType: str}\n@optional {parameters: map<str,str>}\n@returns(200) {contentType: str?, contentDisposition: str?, body: bytes?}\n\n@endgroup\n\n@group sdktypes\n@endpoint GET /sdktypes/{sdktype_id}\n@desc Gets an SDK type.\n@required {id: str}\n@returns(200) {id: str?, friendlyName: str?, description: str?, configurationProperties: [SdkConfigurationProperty]?}\n\n@endpoint GET /sdktypes\n@desc Gets SDK types\n@optional {position: str, limit: int}\n@returns(200) {position: str?, items: [SdkType]?}\n\n@endgroup\n\n@group restapis\n@endpoint GET /restapis/{restapi_id}/stages/{stage_name}\n@desc Gets information about a Stage resource.\n@required {restApiId: str, stageName: str}\n@returns(200) {deploymentId: str?, clientCertificateId: str?, stageName: str?, description: str?, cacheClusterEnabled: bool?, cacheClusterSize: str?, cacheClusterStatus: str?, methodSettings: map<str,MethodSetting>?, variables: map<str,str>?, documentationVersion: str?, accessLogSettings: AccessLogSettings?{format: str?, destinationArn: str?}, canarySettings: CanarySettings?{percentTraffic: num(f64)?, deploymentId: str?, stageVariableOverrides: map<str, str>?: any, useStageCache: bool?}, tracingEnabled: bool?, webAclArn: str?, tags: map<str,str>?, createdDate: str(timestamp)?, lastUpdatedDate: str(timestamp)?}\n\n@endpoint GET /restapis/{restapi_id}/stages\n@desc Gets information about one or more Stage resources.\n@required {restApiId: str}\n@optional {deploymentId: str}\n@returns(200) {item: [Stage]?}\n\n@endgroup\n\n@group tags\n@endpoint GET /tags/{resource_arn}\n@desc Gets the Tags collection for a given resource.\n@required {resourceArn: str}\n@optional {position: str, limit: int}\n@returns(200) {tags: map<str,str>?}\n\n@endgroup\n\n@group usageplans\n@endpoint GET /usageplans/{usageplanId}/usage\n@desc Gets the usage data of a usage plan in a specified time interval.\n@required {usagePlanId: str, startDate: str, endDate: str}\n@optional {keyId: str, position: str, limit: int}\n@returns(200) {usagePlanId: str?, startDate: str?, endDate: str?, position: str?, items: map<str,[[int(i64)]]>?}\n\n@endpoint GET /usageplans/{usageplanId}\n@desc Gets a usage plan of a given plan identifier.\n@required {usagePlanId: str}\n@returns(200) {id: str?, name: str?, description: str?, apiStages: [ApiStage]?, throttle: ThrottleSettings?{burstLimit: int?, rateLimit: num(f64)?}, quota: QuotaSettings?{limit: int?, offset: int?, period: str?}, productCode: str?, tags: map<str,str>?}\n\n@endpoint GET /usageplans/{usageplanId}/keys/{keyId}\n@desc Gets a usage plan key of a given key identifier.\n@required {usagePlanId: str, keyId: str}\n@returns(200) {id: str?, type: str?, value: str?, name: str?}\n\n@endpoint GET /usageplans/{usageplanId}/keys\n@desc Gets all the usage plan keys representing the API keys added to a specified usage plan.\n@required {usagePlanId: str}\n@optional {position: str, limit: int, name: str}\n@returns(200) {position: str?, items: [UsagePlanKey]?}\n\n@endpoint GET /usageplans\n@desc Gets all the usage plans of the caller's account.\n@optional {position: str, keyId: str, limit: int}\n@returns(200) {position: str?, items: [UsagePlan]?}\n\n@endgroup\n\n@group vpclinks\n@endpoint GET /vpclinks/{vpclink_id}\n@desc Gets a specified VPC link under the caller's account in a region.\n@required {vpcLinkId: str}\n@returns(200) {id: str?, name: str?, description: str?, targetArns: [str]?, status: str?, statusMessage: str?, tags: map<str,str>?}\n\n@endpoint GET /vpclinks\n@desc Gets the VpcLinks collection under the caller's account in a selected region.\n@optional {position: str, limit: int}\n@returns(200) {position: str?, items: [VpcLink]?}\n\n@endgroup\n\n@group apikeys?mode=import\n@endpoint POST /apikeys?mode=import\n@desc Import API keys from an external source, such as a CSV-formatted file.\n@required {format: str, body: bytes}\n@optional {failonwarnings: bool}\n@returns(200) {ids: [str]?, warnings: [str]?}\n\n@endgroup\n\n@group restapis\n@endpoint PUT /restapis/{restapi_id}/documentation/parts\n@desc Imports documentation parts\n@required {restApiId: str, body: bytes}\n@optional {mode: str, failonwarnings: bool}\n@returns(200) {ids: [str]?, warnings: [str]?}\n\n@endgroup\n\n@group restapis?mode=import\n@endpoint POST /restapis?mode=import\n@desc A feature of the API Gateway control service for creating a new API from an external API definition file.\n@required {body: bytes}\n@optional {failonwarnings: bool, parameters: map<str,str>}\n@returns(200) {id: str?, name: str?, description: str?, createdDate: str(timestamp)?, version: str?, warnings: [str]?, binaryMediaTypes: [str]?, minimumCompressionSize: int?, apiKeySource: str?, endpointConfiguration: EndpointConfiguration?{types: [str]?, vpcEndpointIds: [str]?}, policy: str?, tags: map<str,str>?, disableExecuteApiEndpoint: bool?, rootResourceId: str?}\n\n@endgroup\n\n@group restapis\n@endpoint PUT /restapis/{restapi_id}/gatewayresponses/{response_type}\n@desc Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.\n@required {restApiId: str, responseType: str}\n@optional {statusCode: str, responseParameters: map<str,str>, responseTemplates: map<str,str>}\n@returns(200) {responseType: str?, statusCode: str?, responseParameters: map<str,str>?, responseTemplates: map<str,str>?, defaultResponse: bool?}\n\n@endpoint PUT /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration\n@desc Sets up a method's integration.\n@required {restApiId: str, resourceId: str, httpMethod: str, type: str}\n@optional {integrationHttpMethod: str, uri: str, connectionType: str, connectionId: str, credentials: str, requestParameters: map<str,str>, requestTemplates: map<str,str>, passthroughBehavior: str, cacheNamespace: str, cacheKeyParameters: [str], contentHandling: str, timeoutInMillis: int, tlsConfig: TlsConfig}\n@returns(200) {type: str?, httpMethod: str?, uri: str?, connectionType: str?, connectionId: str?, credentials: str?, requestParameters: map<str,str>?, requestTemplates: map<str,str>?, passthroughBehavior: str?, contentHandling: str?, timeoutInMillis: int?, cacheNamespace: str?, cacheKeyParameters: [str]?, integrationResponses: map<str,IntegrationResponse>?, tlsConfig: TlsConfig?{insecureSkipVerification: bool?}}\n\n@endpoint PUT /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}\n@desc Represents a put integration.\n@required {restApiId: str, resourceId: str, httpMethod: str, statusCode: str}\n@optional {selectionPattern: str, responseParameters: map<str,str>, responseTemplates: map<str,str>, contentHandling: str}\n@returns(200) {statusCode: str?, selectionPattern: str?, responseParameters: map<str,str>?, responseTemplates: map<str,str>?, contentHandling: str?}\n\n@endpoint PUT /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}\n@desc Add a method to an existing Resource resource.\n@required {restApiId: str, resourceId: str, httpMethod: str, authorizationType: str}\n@optional {authorizerId: str, apiKeyRequired: bool, operationName: str, requestParameters: map<str,bool>, requestModels: map<str,str>, requestValidatorId: str, authorizationScopes: [str]}\n@returns(200) {httpMethod: str?, authorizationType: str?, authorizerId: str?, apiKeyRequired: bool?, requestValidatorId: str?, operationName: str?, requestParameters: map<str,bool>?, requestModels: map<str,str>?, methodResponses: map<str,MethodResponse>?, methodIntegration: Integration?{type: str?, httpMethod: str?, uri: str?, connectionType: str?, connectionId: str?, credentials: str?, requestParameters: map<str, str>?: any, requestTemplates: map<str, str>?: any, passthroughBehavior: str?, contentHandling: str?, timeoutInMillis: int?, cacheNamespace: str?, cacheKeyParameters: [str]?, integrationResponses: map<str, IntegrationResponse>?: any, tlsConfig: TlsConfig?{insecureSkipVerification: bool?}}, authorizationScopes: [str]?}\n\n@endpoint PUT /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}\n@desc Adds a MethodResponse to an existing Method resource.\n@required {restApiId: str, resourceId: str, httpMethod: str, statusCode: str}\n@optional {responseParameters: map<str,bool>, responseModels: map<str,str>}\n@returns(200) {statusCode: str?, responseParameters: map<str,bool>?, responseModels: map<str,str>?}\n\n@endpoint PUT /restapis/{restapi_id}\n@desc A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.\n@required {restApiId: str, body: bytes}\n@optional {mode: str, failonwarnings: bool, parameters: map<str,str>}\n@returns(200) {id: str?, name: str?, description: str?, createdDate: str(timestamp)?, version: str?, warnings: [str]?, binaryMediaTypes: [str]?, minimumCompressionSize: int?, apiKeySource: str?, endpointConfiguration: EndpointConfiguration?{types: [str]?, vpcEndpointIds: [str]?}, policy: str?, tags: map<str,str>?, disableExecuteApiEndpoint: bool?, rootResourceId: str?}\n\n@endgroup\n\n@group tags\n@endpoint PUT /tags/{resource_arn}\n@desc Adds or updates a tag on a given resource.\n@required {resourceArn: str, tags: map<str,str>}\n\n@endgroup\n\n@group restapis\n@endpoint POST /restapis/{restapi_id}/authorizers/{authorizer_id}\n@desc Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.\n@required {restApiId: str, authorizerId: str}\n@optional {headers: map<str,str>, multiValueHeaders: map<str,[str]>, pathWithQueryString: str, body: str, stageVariables: map<str,str>, additionalContext: map<str,str>}\n@returns(200) {clientStatus: int?, log: str?, latency: int(i64)?, principalId: str?, policy: str?, authorization: map<str,[str]>?, claims: map<str,str>?}\n\n@endpoint POST /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}\n@desc Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.\n@required {restApiId: str, resourceId: str, httpMethod: str}\n@optional {pathWithQueryString: str, body: str, headers: map<str,str>, multiValueHeaders: map<str,[str]>, clientCertificateId: str, stageVariables: map<str,str>}\n@returns(200) {status: int?, body: str?, headers: map<str,str>?, multiValueHeaders: map<str,[str]>?, log: str?, latency: int(i64)?}\n\n@endgroup\n\n@group tags\n@endpoint DELETE /tags/{resource_arn}\n@desc Removes a tag from a given resource.\n@required {resourceArn: str, tagKeys: [str]}\n\n@endgroup\n\n@group account\n@endpoint PATCH /account\n@desc Changes information about the current Account resource.\n@optional {patchOperations: [PatchOperation]}\n@returns(200) {cloudwatchRoleArn: str?, throttleSettings: ThrottleSettings?{burstLimit: int?, rateLimit: num(f64)?}, features: [str]?, apiKeyVersion: str?}\n\n@endgroup\n\n@group apikeys\n@endpoint PATCH /apikeys/{api_Key}\n@desc Changes information about an ApiKey resource.\n@required {apiKey: str}\n@optional {patchOperations: [PatchOperation]}\n@returns(200) {id: str?, value: str?, name: str?, customerId: str?, description: str?, enabled: bool?, createdDate: str(timestamp)?, lastUpdatedDate: str(timestamp)?, stageKeys: [str]?, tags: map<str,str>?}\n\n@endgroup\n\n@group restapis\n@endpoint PATCH /restapis/{restapi_id}/authorizers/{authorizer_id}\n@desc Updates an existing Authorizer resource.\n@required {restApiId: str, authorizerId: str}\n@optional {patchOperations: [PatchOperation]}\n@returns(200) {id: str?, name: str?, type: str?, providerARNs: [str]?, authType: str?, authorizerUri: str?, authorizerCredentials: str?, identitySource: str?, identityValidationExpression: str?, authorizerResultTtlInSeconds: int?}\n\n@endgroup\n\n@group domainnames\n@endpoint PATCH /domainnames/{domain_name}/basepathmappings/{base_path}\n@desc Changes information about the BasePathMapping resource.\n@required {domainName: str, basePath: str}\n@optional {patchOperations: [PatchOperation]}\n@returns(200) {basePath: str?, restApiId: str?, stage: str?}\n\n@endgroup\n\n@group clientcertificates\n@endpoint PATCH /clientcertificates/{clientcertificate_id}\n@desc Changes information about an ClientCertificate resource.\n@required {clientCertificateId: str}\n@optional {patchOperations: [PatchOperation]}\n@returns(200) {clientCertificateId: str?, description: str?, pemEncodedCertificate: str?, createdDate: str(timestamp)?, expirationDate: str(timestamp)?, tags: map<str,str>?}\n\n@endgroup\n\n@group restapis\n@endpoint PATCH /restapis/{restapi_id}/deployments/{deployment_id}\n@desc Changes information about a Deployment resource.\n@required {restApiId: str, deploymentId: str}\n@optional {patchOperations: [PatchOperation]}\n@returns(200) {id: str?, description: str?, createdDate: str(timestamp)?, apiSummary: map<str,map<str,MethodSnapshot>>?}\n\n@endpoint PATCH /restapis/{restapi_id}/documentation/parts/{part_id}\n@desc Updates a documentation part.\n@required {restApiId: str, documentationPartId: str}\n@optional {patchOperations: [PatchOperation]}\n@returns(200) {id: str?, location: DocumentationPartLocation?{type: str, path: str?, method: str?, statusCode: str?, name: str?}, properties: str?}\n\n@endpoint PATCH /restapis/{restapi_id}/documentation/versions/{doc_version}\n@desc Updates a documentation version.\n@required {restApiId: str, documentationVersion: str}\n@optional {patchOperations: [PatchOperation]}\n@returns(200) {version: str?, createdDate: str(timestamp)?, description: str?}\n\n@endgroup\n\n@group domainnames\n@endpoint PATCH /domainnames/{domain_name}\n@desc Changes information about the DomainName resource.\n@required {domainName: str}\n@optional {patchOperations: [PatchOperation]}\n@returns(200) {domainName: str?, certificateName: str?, certificateArn: str?, certificateUploadDate: str(timestamp)?, regionalDomainName: str?, regionalHostedZoneId: str?, regionalCertificateName: str?, regionalCertificateArn: str?, distributionDomainName: str?, distributionHostedZoneId: str?, endpointConfiguration: EndpointConfiguration?{types: [str]?, vpcEndpointIds: [str]?}, domainNameStatus: str?, domainNameStatusMessage: str?, securityPolicy: str?, tags: map<str,str>?, mutualTlsAuthentication: MutualTlsAuthentication?{truststoreUri: str?, truststoreVersion: str?, truststoreWarnings: [str]?}, ownershipVerificationCertificateArn: str?}\n\n@endgroup\n\n@group restapis\n@endpoint PATCH /restapis/{restapi_id}/gatewayresponses/{response_type}\n@desc Updates a GatewayResponse of a specified response type on the given RestApi.\n@required {restApiId: str, responseType: str}\n@optional {patchOperations: [PatchOperation]}\n@returns(200) {responseType: str?, statusCode: str?, responseParameters: map<str,str>?, responseTemplates: map<str,str>?, defaultResponse: bool?}\n\n@endpoint PATCH /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration\n@desc Represents an update integration.\n@required {restApiId: str, resourceId: str, httpMethod: str}\n@optional {patchOperations: [PatchOperation]}\n@returns(200) {type: str?, httpMethod: str?, uri: str?, connectionType: str?, connectionId: str?, credentials: str?, requestParameters: map<str,str>?, requestTemplates: map<str,str>?, passthroughBehavior: str?, contentHandling: str?, timeoutInMillis: int?, cacheNamespace: str?, cacheKeyParameters: [str]?, integrationResponses: map<str,IntegrationResponse>?, tlsConfig: TlsConfig?{insecureSkipVerification: bool?}}\n\n@endpoint PATCH /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}\n@desc Represents an update integration response.\n@required {restApiId: str, resourceId: str, httpMethod: str, statusCode: str}\n@optional {patchOperations: [PatchOperation]}\n@returns(200) {statusCode: str?, selectionPattern: str?, responseParameters: map<str,str>?, responseTemplates: map<str,str>?, contentHandling: str?}\n\n@endpoint PATCH /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}\n@desc Updates an existing Method resource.\n@required {restApiId: str, resourceId: str, httpMethod: str}\n@optional {patchOperations: [PatchOperation]}\n@returns(200) {httpMethod: str?, authorizationType: str?, authorizerId: str?, apiKeyRequired: bool?, requestValidatorId: str?, operationName: str?, requestParameters: map<str,bool>?, requestModels: map<str,str>?, methodResponses: map<str,MethodResponse>?, methodIntegration: Integration?{type: str?, httpMethod: str?, uri: str?, connectionType: str?, connectionId: str?, credentials: str?, requestParameters: map<str, str>?: any, requestTemplates: map<str, str>?: any, passthroughBehavior: str?, contentHandling: str?, timeoutInMillis: int?, cacheNamespace: str?, cacheKeyParameters: [str]?, integrationResponses: map<str, IntegrationResponse>?: any, tlsConfig: TlsConfig?{insecureSkipVerification: bool?}}, authorizationScopes: [str]?}\n\n@endpoint PATCH /restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}\n@desc Updates an existing MethodResponse resource.\n@required {restApiId: str, resourceId: str, httpMethod: str, statusCode: str}\n@optional {patchOperations: [PatchOperation]}\n@returns(200) {statusCode: str?, responseParameters: map<str,bool>?, responseModels: map<str,str>?}\n\n@endpoint PATCH /restapis/{restapi_id}/models/{model_name}\n@desc Changes information about a model. The maximum size of the model is 400 KB.\n@required {restApiId: str, modelName: str}\n@optional {patchOperations: [PatchOperation]}\n@returns(200) {id: str?, name: str?, description: str?, schema: str?, contentType: str?}\n\n@endpoint PATCH /restapis/{restapi_id}/requestvalidators/{requestvalidator_id}\n@desc Updates a RequestValidator of a given RestApi.\n@required {restApiId: str, requestValidatorId: str}\n@optional {patchOperations: [PatchOperation]}\n@returns(200) {id: str?, name: str?, validateRequestBody: bool?, validateRequestParameters: bool?}\n\n@endpoint PATCH /restapis/{restapi_id}/resources/{resource_id}\n@desc Changes information about a Resource resource.\n@required {restApiId: str, resourceId: str}\n@optional {patchOperations: [PatchOperation]}\n@returns(200) {id: str?, parentId: str?, pathPart: str?, path: str?, resourceMethods: map<str,Method>?}\n\n@endpoint PATCH /restapis/{restapi_id}\n@desc Changes information about the specified API.\n@required {restApiId: str}\n@optional {patchOperations: [PatchOperation]}\n@returns(200) {id: str?, name: str?, description: str?, createdDate: str(timestamp)?, version: str?, warnings: [str]?, binaryMediaTypes: [str]?, minimumCompressionSize: int?, apiKeySource: str?, endpointConfiguration: EndpointConfiguration?{types: [str]?, vpcEndpointIds: [str]?}, policy: str?, tags: map<str,str>?, disableExecuteApiEndpoint: bool?, rootResourceId: str?}\n\n@endpoint PATCH /restapis/{restapi_id}/stages/{stage_name}\n@desc Changes information about a Stage resource.\n@required {restApiId: str, stageName: str}\n@optional {patchOperations: [PatchOperation]}\n@returns(200) {deploymentId: str?, clientCertificateId: str?, stageName: str?, description: str?, cacheClusterEnabled: bool?, cacheClusterSize: str?, cacheClusterStatus: str?, methodSettings: map<str,MethodSetting>?, variables: map<str,str>?, documentationVersion: str?, accessLogSettings: AccessLogSettings?{format: str?, destinationArn: str?}, canarySettings: CanarySettings?{percentTraffic: num(f64)?, deploymentId: str?, stageVariableOverrides: map<str, str>?: any, useStageCache: bool?}, tracingEnabled: bool?, webAclArn: str?, tags: map<str,str>?, createdDate: str(timestamp)?, lastUpdatedDate: str(timestamp)?}\n\n@endgroup\n\n@group usageplans\n@endpoint PATCH /usageplans/{usageplanId}/keys/{keyId}/usage\n@desc Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.\n@required {usagePlanId: str, keyId: str}\n@optional {patchOperations: [PatchOperation]}\n@returns(200) {usagePlanId: str?, startDate: str?, endDate: str?, position: str?, items: map<str,[[int(i64)]]>?}\n\n@endpoint PATCH /usageplans/{usageplanId}\n@desc Updates a usage plan of a given plan Id.\n@required {usagePlanId: str}\n@optional {patchOperations: [PatchOperation]}\n@returns(200) {id: str?, name: str?, description: str?, apiStages: [ApiStage]?, throttle: ThrottleSettings?{burstLimit: int?, rateLimit: num(f64)?}, quota: QuotaSettings?{limit: int?, offset: int?, period: str?}, productCode: str?, tags: map<str,str>?}\n\n@endgroup\n\n@group vpclinks\n@endpoint PATCH /vpclinks/{vpclink_id}\n@desc Updates an existing VpcLink of a specified identifier.\n@required {vpcLinkId: str}\n@optional {patchOperations: [PatchOperation]}\n@returns(200) {id: str?, name: str?, description: str?, targetArns: [str]?, status: str?, statusMessage: str?, tags: map<str,str>?}\n\n@endgroup\n\n@end\n"}}