{ "opencollection": "1.0.0", "info": { "name": "APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Restapis API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Restapis", "type": "folder" }, "items": [ { "info": { "name": "GetAuthorizers", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/authorizers", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "position", "value": "", "type": "query", "description": "The current pagination position in the paged result set." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500." } ] }, "docs": "Describe an existing Authorizers resource." }, { "info": { "name": "CreateAuthorizer", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/authorizers", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new Authorizer resource to an existing RestApi resource." }, { "info": { "name": "GetDeployments", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/deployments", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "position", "value": "", "type": "query", "description": "The current pagination position in the paged result set." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500." } ] }, "docs": "Gets information about a Deployments collection." }, { "info": { "name": "CreateDeployment", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/deployments", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Deployment resource, which makes a specified RestApi callable over the internet." }, { "info": { "name": "GetDocumentationParts", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/documentation/parts", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "type", "value": "", "type": "query", "description": "The type of API entities of the to-be-retrieved documentation parts. " }, { "name": "name", "value": "", "type": "query", "description": "The name of API entities of the to-be-retrieved documentation parts." }, { "name": "path", "value": "", "type": "query", "description": "The path of API entities of the to-be-retrieved documentation parts." }, { "name": "position", "value": "", "type": "query", "description": "The current pagination position in the paged result set." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500." }, { "name": "locationStatus", "value": "", "type": "query", "description": "The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content." } ] }, "docs": "Gets documentation parts." }, { "info": { "name": "CreateDocumentationPart", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/documentation/parts", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a documentation part." }, { "info": { "name": "ImportDocumentationParts", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/documentation/parts", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "mode", "value": "", "type": "query", "description": "A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE." }, { "name": "failonwarnings", "value": "", "type": "query", "description": "A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Imports documentation parts" }, { "info": { "name": "GetDocumentationVersions", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/documentation/versions", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "position", "value": "", "type": "query", "description": "The current pagination position in the paged result set." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500." } ] }, "docs": "Gets documentation versions." }, { "info": { "name": "CreateDocumentationVersion", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/documentation/versions", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a documentation version" }, { "info": { "name": "GetModels", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/models", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "position", "value": "", "type": "query", "description": "The current pagination position in the paged result set." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500." } ] }, "docs": "Describes existing Models defined for a RestApi resource." }, { "info": { "name": "CreateModel", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/models", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The RestApi identifier under which the Model will be created." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new Model resource to an existing RestApi resource." }, { "info": { "name": "GetRequestValidators", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/requestvalidators", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "position", "value": "", "type": "query", "description": "The current pagination position in the paged result set." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500." } ] }, "docs": "Gets the RequestValidators collection of a given RestApi." }, { "info": { "name": "CreateRequestValidator", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/requestvalidators", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a RequestValidator of a given RestApi." }, { "info": { "name": "CreateResource", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/resources/:parent_id", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "parent_id", "value": "", "type": "path", "description": "The parent resource's identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Resource resource." }, { "info": { "name": "GetRestApis", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "position", "value": "", "type": "query", "description": "The current pagination position in the paged result set." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500." } ] }, "docs": "Lists the RestApis resources for your collection." }, { "info": { "name": "CreateRestApi", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/restapis", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new RestApi resource." }, { "info": { "name": "GetStages", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/stages", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "deploymentId", "value": "", "type": "query", "description": "The stages' deployment identifiers." } ] }, "docs": "Gets information about one or more Stage resources." }, { "info": { "name": "CreateStage", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/stages", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Stage resource that references a pre-existing Deployment for the API. " }, { "info": { "name": "GetAuthorizer", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/authorizers/:authorizer_id", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "authorizer_id", "value": "", "type": "path", "description": "The identifier of the Authorizer resource." } ] }, "docs": "Describe an existing Authorizer resource." }, { "info": { "name": "TestInvokeAuthorizer", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/authorizers/:authorizer_id", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "authorizer_id", "value": "", "type": "path", "description": "Specifies a test invoke authorizer request's Authorizer ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body." }, { "info": { "name": "UpdateAuthorizer", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/authorizers/:authorizer_id", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "authorizer_id", "value": "", "type": "path", "description": "The identifier of the Authorizer resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing Authorizer resource." }, { "info": { "name": "DeleteAuthorizer", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/authorizers/:authorizer_id", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "authorizer_id", "value": "", "type": "path", "description": "The identifier of the Authorizer resource." } ] }, "docs": "Deletes an existing Authorizer resource." }, { "info": { "name": "GetDeployment", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/deployments/:deployment_id", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "deployment_id", "value": "", "type": "path", "description": "The identifier of the Deployment resource to get information about." }, { "name": "embed", "value": "", "type": "query", "description": "A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the \"apisummary\" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary." } ] }, "docs": "Gets information about a Deployment resource." }, { "info": { "name": "UpdateDeployment", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/deployments/:deployment_id", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "deployment_id", "value": "", "type": "path", "description": "The replacement identifier for the Deployment resource to change information about." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changes information about a Deployment resource." }, { "info": { "name": "DeleteDeployment", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/deployments/:deployment_id", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "deployment_id", "value": "", "type": "path", "description": "The identifier of the Deployment resource to delete." } ] }, "docs": "Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it." }, { "info": { "name": "GetDocumentationPart", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/documentation/parts/:part_id", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "part_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." } ] }, "docs": "Gets a documentation part." }, { "info": { "name": "UpdateDocumentationPart", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/documentation/parts/:part_id", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "part_id", "value": "", "type": "path", "description": "The identifier of the to-be-updated documentation part." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a documentation part." }, { "info": { "name": "DeleteDocumentationPart", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/documentation/parts/:part_id", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "part_id", "value": "", "type": "path", "description": "The identifier of the to-be-deleted documentation part." } ] }, "docs": "Deletes a documentation part" }, { "info": { "name": "GetDocumentationVersion", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/documentation/versions/:doc_version", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "doc_version", "value": "", "type": "path", "description": "The version identifier of the to-be-retrieved documentation snapshot." } ] }, "docs": "Gets a documentation version." }, { "info": { "name": "UpdateDocumentationVersion", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/documentation/versions/:doc_version", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi.." }, { "name": "doc_version", "value": "", "type": "path", "description": "The version identifier of the to-be-updated documentation version." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a documentation version." }, { "info": { "name": "DeleteDocumentationVersion", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/documentation/versions/:doc_version", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "doc_version", "value": "", "type": "path", "description": "The version identifier of a to-be-deleted documentation snapshot." } ] }, "docs": "Deletes a documentation version." }, { "info": { "name": "GetGatewayResponse", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/gatewayresponses/:response_type", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "response_type", "value": "", "type": "path", "description": "The response type of the associated GatewayResponse." } ] }, "docs": "Gets a GatewayResponse of a specified response type on the given RestApi." }, { "info": { "name": "PutGatewayResponse", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/gatewayresponses/:response_type", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "response_type", "value": "", "type": "path", "description": "The response type of the associated GatewayResponse" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi." }, { "info": { "name": "UpdateGatewayResponse", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/gatewayresponses/:response_type", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "response_type", "value": "", "type": "path", "description": "The response type of the associated GatewayResponse." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a GatewayResponse of a specified response type on the given RestApi." }, { "info": { "name": "DeleteGatewayResponse", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/gatewayresponses/:response_type", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "response_type", "value": "", "type": "path", "description": "The response type of the associated GatewayResponse." } ] }, "docs": "Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings." }, { "info": { "name": "GetIntegration", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/resources/:resource_id/methods/:http_method/integration", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "resource_id", "value": "", "type": "path", "description": "Specifies a get integration request's resource identifier" }, { "name": "http_method", "value": "", "type": "path", "description": "Specifies a get integration request's HTTP method." } ] }, "docs": "Get the integration settings." }, { "info": { "name": "PutIntegration", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/resources/:resource_id/methods/:http_method/integration", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "resource_id", "value": "", "type": "path", "description": "Specifies a put integration request's resource ID." }, { "name": "http_method", "value": "", "type": "path", "description": "Specifies the HTTP method for the integration." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets up a method's integration." }, { "info": { "name": "UpdateIntegration", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/resources/:resource_id/methods/:http_method/integration", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "resource_id", "value": "", "type": "path", "description": "Represents an update integration request's resource identifier." }, { "name": "http_method", "value": "", "type": "path", "description": "Represents an update integration request's HTTP method." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Represents an update integration." }, { "info": { "name": "DeleteIntegration", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/resources/:resource_id/methods/:http_method/integration", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "resource_id", "value": "", "type": "path", "description": "Specifies a delete integration request's resource identifier." }, { "name": "http_method", "value": "", "type": "path", "description": "Specifies a delete integration request's HTTP method." } ] }, "docs": "Represents a delete integration." }, { "info": { "name": "GetIntegrationResponse", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/resources/:resource_id/methods/:http_method/integration/responses/:status_code", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "resource_id", "value": "", "type": "path", "description": "Specifies a get integration response request's resource identifier." }, { "name": "http_method", "value": "", "type": "path", "description": "Specifies a get integration response request's HTTP method." }, { "name": "status_code", "value": "", "type": "path", "description": "Specifies a get integration response request's status code." } ] }, "docs": "Represents a get integration response." }, { "info": { "name": "PutIntegrationResponse", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/resources/:resource_id/methods/:http_method/integration/responses/:status_code", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "resource_id", "value": "", "type": "path", "description": "Specifies a put integration response request's resource identifier." }, { "name": "http_method", "value": "", "type": "path", "description": "Specifies a put integration response request's HTTP method." }, { "name": "status_code", "value": "", "type": "path", "description": "Specifies the status code that is used to map the integration response to an existing MethodResponse." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Represents a put integration." }, { "info": { "name": "UpdateIntegrationResponse", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/resources/:resource_id/methods/:http_method/integration/responses/:status_code", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "resource_id", "value": "", "type": "path", "description": "Specifies an update integration response request's resource identifier." }, { "name": "http_method", "value": "", "type": "path", "description": "Specifies an update integration response request's HTTP method." }, { "name": "status_code", "value": "", "type": "path", "description": "Specifies an update integration response request's status code." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Represents an update integration response." }, { "info": { "name": "DeleteIntegrationResponse", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/resources/:resource_id/methods/:http_method/integration/responses/:status_code", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "resource_id", "value": "", "type": "path", "description": "Specifies a delete integration response request's resource identifier." }, { "name": "http_method", "value": "", "type": "path", "description": "Specifies a delete integration response request's HTTP method." }, { "name": "status_code", "value": "", "type": "path", "description": "Specifies a delete integration response request's status code." } ] }, "docs": "Represents a delete integration response." }, { "info": { "name": "GetMethod", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/resources/:resource_id/methods/:http_method", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "resource_id", "value": "", "type": "path", "description": "The Resource identifier for the Method resource." }, { "name": "http_method", "value": "", "type": "path", "description": "Specifies the method request's HTTP method type." } ] }, "docs": "Describe an existing Method resource." }, { "info": { "name": "TestInvokeMethod", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/resources/:resource_id/methods/:http_method", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "resource_id", "value": "", "type": "path", "description": "Specifies a test invoke method request's resource ID." }, { "name": "http_method", "value": "", "type": "path", "description": "Specifies a test invoke method request's HTTP method." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body." }, { "info": { "name": "PutMethod", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/resources/:resource_id/methods/:http_method", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "resource_id", "value": "", "type": "path", "description": "The Resource identifier for the new Method resource." }, { "name": "http_method", "value": "", "type": "path", "description": "Specifies the method request's HTTP method type." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a method to an existing Resource resource." }, { "info": { "name": "UpdateMethod", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/resources/:resource_id/methods/:http_method", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "resource_id", "value": "", "type": "path", "description": "The Resource identifier for the Method resource." }, { "name": "http_method", "value": "", "type": "path", "description": "The HTTP verb of the Method resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing Method resource." }, { "info": { "name": "DeleteMethod", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/resources/:resource_id/methods/:http_method", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "resource_id", "value": "", "type": "path", "description": "The Resource identifier for the Method resource." }, { "name": "http_method", "value": "", "type": "path", "description": "The HTTP verb of the Method resource." } ] }, "docs": "Deletes an existing Method resource." }, { "info": { "name": "GetMethodResponse", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/resources/:resource_id/methods/:http_method/responses/:status_code", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "resource_id", "value": "", "type": "path", "description": "The Resource identifier for the MethodResponse resource." }, { "name": "http_method", "value": "", "type": "path", "description": "The HTTP verb of the Method resource." }, { "name": "status_code", "value": "", "type": "path", "description": "The status code for the MethodResponse resource." } ] }, "docs": "Describes a MethodResponse resource." }, { "info": { "name": "PutMethodResponse", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/resources/:resource_id/methods/:http_method/responses/:status_code", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "resource_id", "value": "", "type": "path", "description": "The Resource identifier for the Method resource." }, { "name": "http_method", "value": "", "type": "path", "description": "The HTTP verb of the Method resource." }, { "name": "status_code", "value": "", "type": "path", "description": "The method response's status code." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a MethodResponse to an existing Method resource." }, { "info": { "name": "UpdateMethodResponse", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/resources/:resource_id/methods/:http_method/responses/:status_code", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "resource_id", "value": "", "type": "path", "description": "The Resource identifier for the MethodResponse resource." }, { "name": "http_method", "value": "", "type": "path", "description": "The HTTP verb of the Method resource." }, { "name": "status_code", "value": "", "type": "path", "description": "The status code for the MethodResponse resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing MethodResponse resource." }, { "info": { "name": "DeleteMethodResponse", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/resources/:resource_id/methods/:http_method/responses/:status_code", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "resource_id", "value": "", "type": "path", "description": "The Resource identifier for the MethodResponse resource." }, { "name": "http_method", "value": "", "type": "path", "description": "The HTTP verb of the Method resource." }, { "name": "status_code", "value": "", "type": "path", "description": "The status code identifier for the MethodResponse resource." } ] }, "docs": "Deletes an existing MethodResponse resource." }, { "info": { "name": "GetModel", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/models/:model_name", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The RestApi identifier under which the Model exists." }, { "name": "model_name", "value": "", "type": "path", "description": "The name of the model as an identifier." }, { "name": "flatten", "value": "", "type": "query", "description": "A query parameter of a Boolean value to resolve (true) all external model references and returns a flattened model schema or not (false) The default is false." } ] }, "docs": "Describes an existing model defined for a RestApi resource." }, { "info": { "name": "UpdateModel", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/models/:model_name", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "model_name", "value": "", "type": "path", "description": "The name of the model to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changes information about a model." }, { "info": { "name": "DeleteModel", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/models/:model_name", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "model_name", "value": "", "type": "path", "description": "The name of the model to delete." } ] }, "docs": "Deletes a model." }, { "info": { "name": "GetRequestValidator", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/requestvalidators/:requestvalidator_id", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "requestvalidator_id", "value": "", "type": "path", "description": "The identifier of the RequestValidator to be retrieved." } ] }, "docs": "Gets a RequestValidator of a given RestApi." }, { "info": { "name": "UpdateRequestValidator", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/requestvalidators/:requestvalidator_id", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "requestvalidator_id", "value": "", "type": "path", "description": "The identifier of RequestValidator to be updated." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a RequestValidator of a given RestApi." }, { "info": { "name": "DeleteRequestValidator", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/requestvalidators/:requestvalidator_id", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "requestvalidator_id", "value": "", "type": "path", "description": "The identifier of the RequestValidator to be deleted." } ] }, "docs": "Deletes a RequestValidator of a given RestApi." }, { "info": { "name": "GetResource", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/resources/:resource_id", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "resource_id", "value": "", "type": "path", "description": "The identifier for the Resource resource." }, { "name": "embed", "value": "", "type": "query", "description": "A query parameter to retrieve the specified resources embedded in the returned Resource representation in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the \"methods\" string. For example, GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods." } ] }, "docs": "Lists information about a resource." }, { "info": { "name": "UpdateResource", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/resources/:resource_id", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "resource_id", "value": "", "type": "path", "description": "The identifier of the Resource resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changes information about a Resource resource." }, { "info": { "name": "DeleteResource", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/resources/:resource_id", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "resource_id", "value": "", "type": "path", "description": "The identifier of the Resource resource." } ] }, "docs": "Deletes a Resource resource." }, { "info": { "name": "GetRestApi", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." } ] }, "docs": "Lists the RestApi resource in the collection." }, { "info": { "name": "PutRestApi", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "mode", "value": "", "type": "query", "description": "The mode query parameter to specify the update mode. Valid values are \"merge\" and \"overwrite\". By default, the update mode is \"merge\"." }, { "name": "failonwarnings", "value": "", "type": "query", "description": "A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false." }, { "name": "parameters", "value": "", "type": "query", "description": "Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "UpdateRestApi", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changes information about the specified API." }, { "info": { "name": "DeleteRestApi", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." } ] }, "docs": "Deletes the specified API." }, { "info": { "name": "GetStage", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/stages/:stage_name", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "stage_name", "value": "", "type": "path", "description": "The name of the Stage resource to get information about." } ] }, "docs": "Gets information about a Stage resource." }, { "info": { "name": "UpdateStage", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/stages/:stage_name", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "stage_name", "value": "", "type": "path", "description": "The name of the Stage resource to change information about." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changes information about a Stage resource." }, { "info": { "name": "DeleteStage", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/stages/:stage_name", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "stage_name", "value": "", "type": "path", "description": "The name of the Stage resource to delete." } ] }, "docs": "Deletes a Stage resource." }, { "info": { "name": "FlushStageAuthorizersCache", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/stages/:stage_name/cache/authorizers", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "stage_name", "value": "", "type": "path", "description": "The name of the stage to flush." } ] }, "docs": "Flushes all authorizer cache entries on a stage." }, { "info": { "name": "FlushStageCache", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/stages/:stage_name/cache/data", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "stage_name", "value": "", "type": "path", "description": "The name of the stage to flush its cache." } ] }, "docs": "Flushes a stage's cache." }, { "info": { "name": "GetExport", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/stages/:stage_name/exports/:export_type", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "stage_name", "value": "", "type": "path", "description": "The name of the Stage that will be exported." }, { "name": "export_type", "value": "", "type": "path", "description": "The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0." }, { "name": "parameters", "value": "", "type": "query", "description": "A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool" } ] }, "docs": "Exports a deployed version of a RestApi in a specified format." }, { "info": { "name": "GetGatewayResponses", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/gatewayresponses", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "position", "value": "", "type": "query", "description": "The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The GatewayResponses collection does not support pagination and the limit does not apply here." } ] }, "docs": "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." }, { "info": { "name": "GetModelTemplate", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/models/:model_name/default_template", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "model_name", "value": "", "type": "path", "description": "The name of the model for which to generate a template." } ] }, "docs": "Generates a sample mapping template that can be used to transform a payload into the structure of a model." }, { "info": { "name": "GetResources", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/resources", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "position", "value": "", "type": "query", "description": "The current pagination position in the paged result set." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500." }, { "name": "embed", "value": "", "type": "query", "description": "A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the \"methods\" string. For example, GET /restapis/{restapi_id}/resources?embed=methods." } ] }, "docs": "Lists information about a collection of Resource resources." }, { "info": { "name": "GetSdk", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/restapis/:restapi_id/stages/:stage_name/sdks/:sdk_type", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "restapi_id", "value": "", "type": "path", "description": "The string identifier of the associated RestApi." }, { "name": "stage_name", "value": "", "type": "path", "description": "The name of the Stage that the SDK will use." }, { "name": "sdk_type", "value": "", "type": "path", "description": "The language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported." }, { "name": "parameters", "value": "", "type": "query", "description": "A string-to-string key-value map of query parameters sdkType-dependent properties of the SDK. For sdkType of objectivec or swift, a parameter named classPrefix is required. For sdkType of android, parameters named groupId, artifactId, artifactVersion, and invokerPackage are required. For sdkType of java, parameters named serviceName and javaPackageName are required. " } ] }, "docs": "Generates a client SDK for a RestApi and Stage." } ] } ], "bundled": true }