AWS.APIGateway — AWS SDK for JavaScript (original) (raw)

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createApiKey(params = {}, callback) ⇒ AWS.Request

Create an ApiKey resource.

Adds a new Authorizer resource to an existing RestApi resource.

createBasePathMapping(params = {}, callback) ⇒ AWS.Request

Creates a new BasePathMapping resource.

createDeployment(params = {}, callback) ⇒ AWS.Request

Creates a Deployment resource, which makes a specified RestApi callable over the internet.

createDocumentationPart(params = {}, callback) ⇒ AWS.Request

Creates a documentation part.

createDocumentationVersion(params = {}, callback) ⇒ AWS.Request

Creates a documentation version

createDomainName(params = {}, callback) ⇒ AWS.Request

Creates a new domain name.

createModel(params = {}, callback) ⇒ AWS.Request

Adds a new Model resource to an existing RestApi resource.

createRequestValidator(params = {}, callback) ⇒ AWS.Request

Creates a RequestValidator of a given RestApi.

createResource(params = {}, callback) ⇒ AWS.Request

Creates a Resource resource.

createRestApi(params = {}, callback) ⇒ AWS.Request

Creates a new RestApi resource.

createStage(params = {}, callback) ⇒ AWS.Request

Creates a new Stage resource that references a pre-existing Deployment for the API.

createUsagePlan(params = {}, callback) ⇒ AWS.Request

Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.

createUsagePlanKey(params = {}, callback) ⇒ AWS.Request

Creates a usage plan key for adding an existing API key to a usage plan.

createVpcLink(params = {}, callback) ⇒ AWS.Request

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.

deleteApiKey(params = {}, callback) ⇒ AWS.Request

Deletes the ApiKey resource.

deleteAuthorizer(params = {}, callback) ⇒ AWS.Request

Deletes an existing Authorizer resource.

deleteBasePathMapping(params = {}, callback) ⇒ AWS.Request

Deletes the BasePathMapping resource.

deleteClientCertificate(params = {}, callback) ⇒ AWS.Request

Deletes the ClientCertificate resource.

deleteDeployment(params = {}, callback) ⇒ AWS.Request

Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.

deleteDocumentationPart(params = {}, callback) ⇒ AWS.Request

Deletes a documentation part

deleteDocumentationVersion(params = {}, callback) ⇒ AWS.Request

Deletes a documentation version.

deleteDomainName(params = {}, callback) ⇒ AWS.Request

Deletes the DomainName resource.

deleteGatewayResponse(params = {}, callback) ⇒ AWS.Request

Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.

deleteIntegration(params = {}, callback) ⇒ AWS.Request

Represents a delete integration.

deleteIntegrationResponse(params = {}, callback) ⇒ AWS.Request

Represents a delete integration response.

deleteMethod(params = {}, callback) ⇒ AWS.Request

Deletes an existing Method resource.

deleteMethodResponse(params = {}, callback) ⇒ AWS.Request

Deletes an existing MethodResponse resource.

deleteRequestValidator(params = {}, callback) ⇒ AWS.Request

Deletes a RequestValidator of a given RestApi.

deleteResource(params = {}, callback) ⇒ AWS.Request

Deletes a Resource resource.

deleteRestApi(params = {}, callback) ⇒ AWS.Request

Deletes the specified API.

deleteStage(params = {}, callback) ⇒ AWS.Request

Deletes a Stage resource.

deleteUsagePlan(params = {}, callback) ⇒ AWS.Request

Deletes a usage plan of a given plan Id.

deleteUsagePlanKey(params = {}, callback) ⇒ AWS.Request

Deletes a usage plan key and remove the underlying API key from the associated usage plan.

deleteVpcLink(params = {}, callback) ⇒ AWS.Request

Deletes an existing VpcLink of a specified identifier.

flushStageAuthorizersCache(params = {}, callback) ⇒ AWS.Request

Flushes all authorizer cache entries on a stage.

flushStageCache(params = {}, callback) ⇒ AWS.Request

generateClientCertificate(params = {}, callback) ⇒ AWS.Request

Generates a ClientCertificate resource.

getAccount(params = {}, callback) ⇒ AWS.Request

Gets information about the current Account resource.

getApiKey(params = {}, callback) ⇒ AWS.Request

Gets information about the current ApiKey resource.

getApiKeys(params = {}, callback) ⇒ AWS.Request

Gets information about the current ApiKeys resource.

getAuthorizer(params = {}, callback) ⇒ AWS.Request

Describe an existing Authorizer resource.

getAuthorizers(params = {}, callback) ⇒ AWS.Request

Describe an existing Authorizers resource.

getBasePathMapping(params = {}, callback) ⇒ AWS.Request

Describe a BasePathMapping resource.

getBasePathMappings(params = {}, callback) ⇒ AWS.Request

Represents a collection of BasePathMapping resources.

getClientCertificate(params = {}, callback) ⇒ AWS.Request

Gets information about the current ClientCertificate resource.

getClientCertificates(params = {}, callback) ⇒ AWS.Request

Gets a collection of ClientCertificate resources.

getDeployment(params = {}, callback) ⇒ AWS.Request

Gets information about a Deployment resource.

getDeployments(params = {}, callback) ⇒ AWS.Request

Gets information about a Deployments collection.

getDocumentationPart(params = {}, callback) ⇒ AWS.Request

Gets a documentation part.

getDocumentationParts(params = {}, callback) ⇒ AWS.Request

Gets documentation parts.

getDocumentationVersion(params = {}, callback) ⇒ AWS.Request

Gets a documentation version.

getDocumentationVersions(params = {}, callback) ⇒ AWS.Request

Gets documentation versions.

getDomainName(params = {}, callback) ⇒ AWS.Request

Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

getDomainNames(params = {}, callback) ⇒ AWS.Request

Represents a collection of DomainName resources.

getExport(params = {}, callback) ⇒ AWS.Request

Exports a deployed version of a RestApi in a specified format.

getGatewayResponse(params = {}, callback) ⇒ AWS.Request

Gets a GatewayResponse of a specified response type on the given RestApi.

getGatewayResponses(params = {}, callback) ⇒ AWS.Request

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.

getIntegration(params = {}, callback) ⇒ AWS.Request

Get the integration settings.

getIntegrationResponse(params = {}, callback) ⇒ AWS.Request

Represents a get integration response.

getMethod(params = {}, callback) ⇒ AWS.Request

Describe an existing Method resource.

getMethodResponse(params = {}, callback) ⇒ AWS.Request

Describes a MethodResponse resource.

getModel(params = {}, callback) ⇒ AWS.Request

Describes an existing model defined for a RestApi resource.

getModels(params = {}, callback) ⇒ AWS.Request

Describes existing Models defined for a RestApi resource.

getModelTemplate(params = {}, callback) ⇒ AWS.Request

Generates a sample mapping template that can be used to transform a payload into the structure of a model.

getRequestValidator(params = {}, callback) ⇒ AWS.Request

Gets a RequestValidator of a given RestApi.

getRequestValidators(params = {}, callback) ⇒ AWS.Request

Gets the RequestValidators collection of a given RestApi.

getResource(params = {}, callback) ⇒ AWS.Request

Lists information about a resource.

getResources(params = {}, callback) ⇒ AWS.Request

Lists information about a collection of Resource resources.

getRestApi(params = {}, callback) ⇒ AWS.Request

Lists the RestApi resource in the collection.

getRestApis(params = {}, callback) ⇒ AWS.Request

Lists the RestApis resources for your collection.

getSdk(params = {}, callback) ⇒ AWS.Request

Generates a client SDK for a RestApi and Stage.

getStage(params = {}, callback) ⇒ AWS.Request

Gets information about a Stage resource.

getStages(params = {}, callback) ⇒ AWS.Request

Gets information about one or more Stage resources.

getTags(params = {}, callback) ⇒ AWS.Request

Gets the Tags collection for a given resource.

getUsage(params = {}, callback) ⇒ AWS.Request

Gets the usage data of a usage plan in a specified time interval.

getUsagePlan(params = {}, callback) ⇒ AWS.Request

Gets a usage plan of a given plan identifier.

getUsagePlanKey(params = {}, callback) ⇒ AWS.Request

Gets a usage plan key of a given key identifier.

getUsagePlanKeys(params = {}, callback) ⇒ AWS.Request

Gets all the usage plan keys representing the API keys added to a specified usage plan.

getUsagePlans(params = {}, callback) ⇒ AWS.Request

Gets all the usage plans of the caller's account.

getVpcLink(params = {}, callback) ⇒ AWS.Request

Gets a specified VPC link under the caller's account in a region.

getVpcLinks(params = {}, callback) ⇒ AWS.Request

Gets the VpcLinks collection under the caller's account in a selected region.

importApiKeys(params = {}, callback) ⇒ AWS.Request

Import API keys from an external source, such as a CSV-formatted file.

importDocumentationParts(params = {}, callback) ⇒ AWS.Request

Imports documentation parts

importRestApi(params = {}, callback) ⇒ AWS.Request

A feature of the API Gateway control service for creating a new API from an external API definition file.

putGatewayResponse(params = {}, callback) ⇒ AWS.Request

Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

putIntegration(params = {}, callback) ⇒ AWS.Request

Sets up a method's integration.

putIntegrationResponse(params = {}, callback) ⇒ AWS.Request

Represents a put integration.

putMethod(params = {}, callback) ⇒ AWS.Request

Add a method to an existing Resource resource.

putMethodResponse(params = {}, callback) ⇒ AWS.Request

Adds a MethodResponse to an existing Method resource.

putRestApi(params = {}, callback) ⇒ AWS.Request

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.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds or updates a tag on a given resource.

testInvokeAuthorizer(params = {}, callback) ⇒ AWS.Request

Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.

testInvokeMethod(params = {}, callback) ⇒ AWS.Request

Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes a tag from a given resource.

updateAccount(params = {}, callback) ⇒ AWS.Request

Changes information about the current Account resource.

updateApiKey(params = {}, callback) ⇒ AWS.Request

Changes information about an ApiKey resource.

updateAuthorizer(params = {}, callback) ⇒ AWS.Request

Updates an existing Authorizer resource.

updateBasePathMapping(params = {}, callback) ⇒ AWS.Request

Changes information about the BasePathMapping resource.

updateClientCertificate(params = {}, callback) ⇒ AWS.Request

Changes information about an ClientCertificate resource.

updateDeployment(params = {}, callback) ⇒ AWS.Request

Changes information about a Deployment resource.

updateDocumentationPart(params = {}, callback) ⇒ AWS.Request

Updates a documentation part.

updateDocumentationVersion(params = {}, callback) ⇒ AWS.Request

Updates a documentation version.

updateDomainName(params = {}, callback) ⇒ AWS.Request

Changes information about the DomainName resource.

updateGatewayResponse(params = {}, callback) ⇒ AWS.Request

Updates a GatewayResponse of a specified response type on the given RestApi.

updateIntegration(params = {}, callback) ⇒ AWS.Request

Represents an update integration.

updateIntegrationResponse(params = {}, callback) ⇒ AWS.Request

Represents an update integration response.

updateMethod(params = {}, callback) ⇒ AWS.Request

Updates an existing Method resource.

updateMethodResponse(params = {}, callback) ⇒ AWS.Request

Updates an existing MethodResponse resource.

updateModel(params = {}, callback) ⇒ AWS.Request

Changes information about a model. The maximum size of the model is 400 KB.

updateRequestValidator(params = {}, callback) ⇒ AWS.Request

Updates a RequestValidator of a given RestApi.

updateResource(params = {}, callback) ⇒ AWS.Request

Changes information about a Resource resource.

updateRestApi(params = {}, callback) ⇒ AWS.Request

Changes information about the specified API.

updateStage(params = {}, callback) ⇒ AWS.Request

Changes information about a Stage resource.

updateUsage(params = {}, callback) ⇒ AWS.Request

Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.

updateUsagePlan(params = {}, callback) ⇒ AWS.Request

Updates a usage plan of a given plan Id.

updateVpcLink(params = {}, callback) ⇒ AWS.Request

Updates an existing VpcLink of a specified identifier.