Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

APIGateway

import { APIGateway } from "https://aws-api.deno.dev/v0.2/services/apigateway.ts?docs=full";
class APIGateway {
constructor(apiFactory: client.ApiFactory);
async createApiKey(params?: CreateApiKeyRequest, opts?: client.RequestOptions): Promise<ApiKey>;
async createAuthorizer(params: CreateAuthorizerRequest, opts?: client.RequestOptions): Promise<Authorizer>;
async createBasePathMapping(params: CreateBasePathMappingRequest, opts?: client.RequestOptions): Promise<BasePathMapping>;
async createDeployment(params: CreateDeploymentRequest, opts?: client.RequestOptions): Promise<Deployment>;
async createDocumentationPart(params: CreateDocumentationPartRequest, opts?: client.RequestOptions): Promise<DocumentationPart>;
async createDocumentationVersion(params: CreateDocumentationVersionRequest, opts?: client.RequestOptions): Promise<DocumentationVersion>;
async createDomainName(params: CreateDomainNameRequest, opts?: client.RequestOptions): Promise<DomainName>;
async createModel(params: CreateModelRequest, opts?: client.RequestOptions): Promise<Model>;
async createRequestValidator(params: CreateRequestValidatorRequest, opts?: client.RequestOptions): Promise<RequestValidator>;
async createResource(params: CreateResourceRequest, opts?: client.RequestOptions): Promise<Resource>;
async createRestApi(params: CreateRestApiRequest, opts?: client.RequestOptions): Promise<RestApi>;
async createStage(params: CreateStageRequest, opts?: client.RequestOptions): Promise<Stage>;
async createUsagePlan(params: CreateUsagePlanRequest, opts?: client.RequestOptions): Promise<UsagePlan>;
async createUsagePlanKey(params: CreateUsagePlanKeyRequest, opts?: client.RequestOptions): Promise<UsagePlanKey>;
async createVpcLink(params: CreateVpcLinkRequest, opts?: client.RequestOptions): Promise<VpcLink>;
async deleteApiKey(params: DeleteApiKeyRequest, opts?: client.RequestOptions): Promise<void>;
async deleteAuthorizer(params: DeleteAuthorizerRequest, opts?: client.RequestOptions): Promise<void>;
async deleteBasePathMapping(params: DeleteBasePathMappingRequest, opts?: client.RequestOptions): Promise<void>;
async deleteClientCertificate(params: DeleteClientCertificateRequest, opts?: client.RequestOptions): Promise<void>;
async deleteDeployment(params: DeleteDeploymentRequest, opts?: client.RequestOptions): Promise<void>;
async deleteDocumentationPart(params: DeleteDocumentationPartRequest, opts?: client.RequestOptions): Promise<void>;
async deleteDocumentationVersion(params: DeleteDocumentationVersionRequest, opts?: client.RequestOptions): Promise<void>;
async deleteDomainName(params: DeleteDomainNameRequest, opts?: client.RequestOptions): Promise<void>;
async deleteGatewayResponse(params: DeleteGatewayResponseRequest, opts?: client.RequestOptions): Promise<void>;
async deleteIntegration(params: DeleteIntegrationRequest, opts?: client.RequestOptions): Promise<void>;
async deleteIntegrationResponse(params: DeleteIntegrationResponseRequest, opts?: client.RequestOptions): Promise<void>;
async deleteMethod(params: DeleteMethodRequest, opts?: client.RequestOptions): Promise<void>;
async deleteMethodResponse(params: DeleteMethodResponseRequest, opts?: client.RequestOptions): Promise<void>;
async deleteModel(params: DeleteModelRequest, opts?: client.RequestOptions): Promise<void>;
async deleteRequestValidator(params: DeleteRequestValidatorRequest, opts?: client.RequestOptions): Promise<void>;
async deleteResource(params: DeleteResourceRequest, opts?: client.RequestOptions): Promise<void>;
async deleteRestApi(params: DeleteRestApiRequest, opts?: client.RequestOptions): Promise<void>;
async deleteStage(params: DeleteStageRequest, opts?: client.RequestOptions): Promise<void>;
async deleteUsagePlan(params: DeleteUsagePlanRequest, opts?: client.RequestOptions): Promise<void>;
async deleteUsagePlanKey(params: DeleteUsagePlanKeyRequest, opts?: client.RequestOptions): Promise<void>;
async deleteVpcLink(params: DeleteVpcLinkRequest, opts?: client.RequestOptions): Promise<void>;
async flushStageAuthorizersCache(params: FlushStageAuthorizersCacheRequest, opts?: client.RequestOptions): Promise<void>;
async flushStageCache(params: FlushStageCacheRequest, opts?: client.RequestOptions): Promise<void>;
async generateClientCertificate(params?: GenerateClientCertificateRequest, opts?: client.RequestOptions): Promise<ClientCertificate>;
async getAccount(opts?: client.RequestOptions): Promise<Account>;
async getApiKey(params: GetApiKeyRequest, opts?: client.RequestOptions): Promise<ApiKey>;
async getApiKeys(params?: GetApiKeysRequest, opts?: client.RequestOptions): Promise<ApiKeys>;
async getAuthorizer(params: GetAuthorizerRequest, opts?: client.RequestOptions): Promise<Authorizer>;
async getAuthorizers(params: GetAuthorizersRequest, opts?: client.RequestOptions): Promise<Authorizers>;
async getBasePathMapping(params: GetBasePathMappingRequest, opts?: client.RequestOptions): Promise<BasePathMapping>;
async getBasePathMappings(params: GetBasePathMappingsRequest, opts?: client.RequestOptions): Promise<BasePathMappings>;
async getClientCertificate(params: GetClientCertificateRequest, opts?: client.RequestOptions): Promise<ClientCertificate>;
async getClientCertificates(params?: GetClientCertificatesRequest, opts?: client.RequestOptions): Promise<ClientCertificates>;
async getDeployment(params: GetDeploymentRequest, opts?: client.RequestOptions): Promise<Deployment>;
async getDeployments(params: GetDeploymentsRequest, opts?: client.RequestOptions): Promise<Deployments>;
async getDocumentationPart(params: GetDocumentationPartRequest, opts?: client.RequestOptions): Promise<DocumentationPart>;
async getDocumentationParts(params: GetDocumentationPartsRequest, opts?: client.RequestOptions): Promise<DocumentationParts>;
async getDocumentationVersion(params: GetDocumentationVersionRequest, opts?: client.RequestOptions): Promise<DocumentationVersion>;
async getDocumentationVersions(params: GetDocumentationVersionsRequest, opts?: client.RequestOptions): Promise<DocumentationVersions>;
async getDomainName(params: GetDomainNameRequest, opts?: client.RequestOptions): Promise<DomainName>;
async getDomainNames(params?: GetDomainNamesRequest, opts?: client.RequestOptions): Promise<DomainNames>;
async getExport(params: GetExportRequest, opts?: client.RequestOptions): Promise<ExportResponse>;
async getGatewayResponse(params: GetGatewayResponseRequest, opts?: client.RequestOptions): Promise<GatewayResponse>;
async getGatewayResponses(params: GetGatewayResponsesRequest, opts?: client.RequestOptions): Promise<GatewayResponses>;
async getIntegration(params: GetIntegrationRequest, opts?: client.RequestOptions): Promise<Integration>;
async getIntegrationResponse(params: GetIntegrationResponseRequest, opts?: client.RequestOptions): Promise<IntegrationResponse>;
async getMethod(params: GetMethodRequest, opts?: client.RequestOptions): Promise<Method>;
async getMethodResponse(params: GetMethodResponseRequest, opts?: client.RequestOptions): Promise<MethodResponse>;
async getModel(params: GetModelRequest, opts?: client.RequestOptions): Promise<Model>;
async getModels(params: GetModelsRequest, opts?: client.RequestOptions): Promise<Models>;
async getModelTemplate(params: GetModelTemplateRequest, opts?: client.RequestOptions): Promise<Template>;
async getRequestValidator(params: GetRequestValidatorRequest, opts?: client.RequestOptions): Promise<RequestValidator>;
async getRequestValidators(params: GetRequestValidatorsRequest, opts?: client.RequestOptions): Promise<RequestValidators>;
async getResource(params: GetResourceRequest, opts?: client.RequestOptions): Promise<Resource>;
async getResources(params: GetResourcesRequest, opts?: client.RequestOptions): Promise<Resources>;
async getRestApi(params: GetRestApiRequest, opts?: client.RequestOptions): Promise<RestApi>;
async getRestApis(params?: GetRestApisRequest, opts?: client.RequestOptions): Promise<RestApis>;
async getSdk(params: GetSdkRequest, opts?: client.RequestOptions): Promise<SdkResponse>;
async getSdkType(params: GetSdkTypeRequest, opts?: client.RequestOptions): Promise<SdkType>;
async getSdkTypes(params?: GetSdkTypesRequest, opts?: client.RequestOptions): Promise<SdkTypes>;
async getStage(params: GetStageRequest, opts?: client.RequestOptions): Promise<Stage>;
async getStages(params: GetStagesRequest, opts?: client.RequestOptions): Promise<Stages>;
async getTags(params: GetTagsRequest, opts?: client.RequestOptions): Promise<Tags>;
async getUsage(params: GetUsageRequest, opts?: client.RequestOptions): Promise<Usage>;
async getUsagePlan(params: GetUsagePlanRequest, opts?: client.RequestOptions): Promise<UsagePlan>;
async getUsagePlanKey(params: GetUsagePlanKeyRequest, opts?: client.RequestOptions): Promise<UsagePlanKey>;
async getUsagePlanKeys(params: GetUsagePlanKeysRequest, opts?: client.RequestOptions): Promise<UsagePlanKeys>;
async getUsagePlans(params?: GetUsagePlansRequest, opts?: client.RequestOptions): Promise<UsagePlans>;
async getVpcLink(params: GetVpcLinkRequest, opts?: client.RequestOptions): Promise<VpcLink>;
async getVpcLinks(params?: GetVpcLinksRequest, opts?: client.RequestOptions): Promise<VpcLinks>;
async importApiKeys(params: ImportApiKeysRequest, opts?: client.RequestOptions): Promise<ApiKeyIds>;
async importDocumentationParts(params: ImportDocumentationPartsRequest, opts?: client.RequestOptions): Promise<DocumentationPartIds>;
async importRestApi(params: ImportRestApiRequest, opts?: client.RequestOptions): Promise<RestApi>;
async putGatewayResponse(params: PutGatewayResponseRequest, opts?: client.RequestOptions): Promise<GatewayResponse>;
async putIntegration(params: PutIntegrationRequest, opts?: client.RequestOptions): Promise<Integration>;
async putIntegrationResponse(params: PutIntegrationResponseRequest, opts?: client.RequestOptions): Promise<IntegrationResponse>;
async putMethod(params: PutMethodRequest, opts?: client.RequestOptions): Promise<Method>;
async putMethodResponse(params: PutMethodResponseRequest, opts?: client.RequestOptions): Promise<MethodResponse>;
async putRestApi(params: PutRestApiRequest, opts?: client.RequestOptions): Promise<RestApi>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async testInvokeAuthorizer(params: TestInvokeAuthorizerRequest, opts?: client.RequestOptions): Promise<TestInvokeAuthorizerResponse>;
async testInvokeMethod(params: TestInvokeMethodRequest, opts?: client.RequestOptions): Promise<TestInvokeMethodResponse>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async updateAccount(params?: UpdateAccountRequest, opts?: client.RequestOptions): Promise<Account>;
async updateApiKey(params: UpdateApiKeyRequest, opts?: client.RequestOptions): Promise<ApiKey>;
async updateAuthorizer(params: UpdateAuthorizerRequest, opts?: client.RequestOptions): Promise<Authorizer>;
async updateBasePathMapping(params: UpdateBasePathMappingRequest, opts?: client.RequestOptions): Promise<BasePathMapping>;
async updateClientCertificate(params: UpdateClientCertificateRequest, opts?: client.RequestOptions): Promise<ClientCertificate>;
async updateDeployment(params: UpdateDeploymentRequest, opts?: client.RequestOptions): Promise<Deployment>;
async updateDocumentationPart(params: UpdateDocumentationPartRequest, opts?: client.RequestOptions): Promise<DocumentationPart>;
async updateDocumentationVersion(params: UpdateDocumentationVersionRequest, opts?: client.RequestOptions): Promise<DocumentationVersion>;
async updateDomainName(params: UpdateDomainNameRequest, opts?: client.RequestOptions): Promise<DomainName>;
async updateGatewayResponse(params: UpdateGatewayResponseRequest, opts?: client.RequestOptions): Promise<GatewayResponse>;
async updateIntegration(params: UpdateIntegrationRequest, opts?: client.RequestOptions): Promise<Integration>;
async updateIntegrationResponse(params: UpdateIntegrationResponseRequest, opts?: client.RequestOptions): Promise<IntegrationResponse>;
async updateMethod(params: UpdateMethodRequest, opts?: client.RequestOptions): Promise<Method>;
async updateMethodResponse(params: UpdateMethodResponseRequest, opts?: client.RequestOptions): Promise<MethodResponse>;
async updateModel(params: UpdateModelRequest, opts?: client.RequestOptions): Promise<Model>;
async updateRequestValidator(params: UpdateRequestValidatorRequest, opts?: client.RequestOptions): Promise<RequestValidator>;
async updateResource(params: UpdateResourceRequest, opts?: client.RequestOptions): Promise<Resource>;
async updateRestApi(params: UpdateRestApiRequest, opts?: client.RequestOptions): Promise<RestApi>;
async updateStage(params: UpdateStageRequest, opts?: client.RequestOptions): Promise<Stage>;
async updateUsage(params: UpdateUsageRequest, opts?: client.RequestOptions): Promise<Usage>;
async updateUsagePlan(params: UpdateUsagePlanRequest, opts?: client.RequestOptions): Promise<UsagePlan>;
async updateVpcLink(params: UpdateVpcLinkRequest, opts?: client.RequestOptions): Promise<VpcLink>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new APIGateway(apiFactory: client.ApiFactory)
[src]

§Methods

§
createApiKey(params?: CreateApiKeyRequest, opts?: client.RequestOptions): Promise<ApiKey>
[src]

Create an "ApiKey" resource.

See also: AWS CLI

§
createAuthorizer(params: CreateAuthorizerRequest, opts?: client.RequestOptions): Promise<Authorizer>
[src]

Adds a new "Authorizer" resource to an existing "RestApi" resource.

See also: AWS CLI

§
createBasePathMapping(params: CreateBasePathMappingRequest, opts?: client.RequestOptions): Promise<BasePathMapping>
[src]

Creates a new "BasePathMapping" resource.

§
createDeployment(params: CreateDeploymentRequest, opts?: client.RequestOptions): Promise<Deployment>
[src]

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

§
createDocumentationPart(params: CreateDocumentationPartRequest, opts?: client.RequestOptions): Promise<DocumentationPart>
[src]
§
createDocumentationVersion(params: CreateDocumentationVersionRequest, opts?: client.RequestOptions): Promise<DocumentationVersion>
[src]
§
createDomainName(params: CreateDomainNameRequest, opts?: client.RequestOptions): Promise<DomainName>
[src]

Creates a new domain name.

§
createModel(params: CreateModelRequest, opts?: client.RequestOptions): Promise<Model>
[src]

Adds a new "Model" resource to an existing "RestApi" resource.

§
createRequestValidator(params: CreateRequestValidatorRequest, opts?: client.RequestOptions): Promise<RequestValidator>
[src]

Creates a "ReqeustValidator" of a given "RestApi".

§
createResource(params: CreateResourceRequest, opts?: client.RequestOptions): Promise<Resource>
[src]

Creates a "Resource" resource.

§
createRestApi(params: CreateRestApiRequest, opts?: client.RequestOptions): Promise<RestApi>
[src]

Creates a new "RestApi" resource.

§
createStage(params: CreateStageRequest, opts?: client.RequestOptions): Promise<Stage>
[src]

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

§
createUsagePlan(params: CreateUsagePlanRequest, opts?: client.RequestOptions): Promise<UsagePlan>
[src]

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

§
createUsagePlanKey(params: CreateUsagePlanKeyRequest, opts?: client.RequestOptions): Promise<UsagePlanKey>
[src]

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

§
deleteApiKey(params: DeleteApiKeyRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the "ApiKey" resource.

§
deleteAuthorizer(params: DeleteAuthorizerRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes an existing "Authorizer" resource.

See also: AWS CLI

§
deleteBasePathMapping(params: DeleteBasePathMappingRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the "BasePathMapping" resource.

§
deleteClientCertificate(params: DeleteClientCertificateRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the "ClientCertificate" resource.

§
deleteDeployment(params: DeleteDeploymentRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§
deleteDocumentationPart(params: DeleteDocumentationPartRequest, opts?: client.RequestOptions): Promise<void>
[src]
§
deleteDocumentationVersion(params: DeleteDocumentationVersionRequest, opts?: client.RequestOptions): Promise<void>
[src]
§
deleteDomainName(params: DeleteDomainNameRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the "DomainName" resource.

§
deleteGatewayResponse(params: DeleteGatewayResponseRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§
deleteIntegration(params: DeleteIntegrationRequest, opts?: client.RequestOptions): Promise<void>
[src]

Represents a delete integration.

§
deleteIntegrationResponse(params: DeleteIntegrationResponseRequest, opts?: client.RequestOptions): Promise<void>
[src]

Represents a delete integration response.

§
deleteMethod(params: DeleteMethodRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes an existing "Method" resource.

§
deleteMethodResponse(params: DeleteMethodResponseRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes an existing "MethodResponse" resource.

§
deleteModel(params: DeleteModelRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a model.

§
deleteRequestValidator(params: DeleteRequestValidatorRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a "RequestValidator" of a given "RestApi".

§
deleteResource(params: DeleteResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a "Resource" resource.

§
deleteRestApi(params: DeleteRestApiRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the specified API.

§
deleteStage(params: DeleteStageRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a "Stage" resource.

§
deleteUsagePlan(params: DeleteUsagePlanRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a usage plan of a given plan Id.

§
deleteUsagePlanKey(params: DeleteUsagePlanKeyRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§
flushStageAuthorizersCache(params: FlushStageAuthorizersCacheRequest, opts?: client.RequestOptions): Promise<void>
[src]

Flushes all authorizer cache entries on a stage.

§
flushStageCache(params: FlushStageCacheRequest, opts?: client.RequestOptions): Promise<void>
[src]

Flushes a stage's cache.

§
generateClientCertificate(params?: GenerateClientCertificateRequest, opts?: client.RequestOptions): Promise<ClientCertificate>
[src]

Generates a "ClientCertificate" resource.

§
getAccount(opts?: client.RequestOptions): Promise<Account>
[src]

Gets information about the current "Account" resource.

§
getApiKey(params: GetApiKeyRequest, opts?: client.RequestOptions): Promise<ApiKey>
[src]

Gets information about the current "ApiKey" resource.

§
getApiKeys(params?: GetApiKeysRequest, opts?: client.RequestOptions): Promise<ApiKeys>
[src]

Gets information about the current "ApiKeys" resource.

§
getAuthorizer(params: GetAuthorizerRequest, opts?: client.RequestOptions): Promise<Authorizer>
[src]

Describe an existing "Authorizer" resource.

See also: AWS CLI

§
getAuthorizers(params: GetAuthorizersRequest, opts?: client.RequestOptions): Promise<Authorizers>
[src]

Describe an existing "Authorizers" resource.

See also: AWS CLI

§
getBasePathMapping(params: GetBasePathMappingRequest, opts?: client.RequestOptions): Promise<BasePathMapping>
[src]

Describe a "BasePathMapping" resource.

§
getBasePathMappings(params: GetBasePathMappingsRequest, opts?: client.RequestOptions): Promise<BasePathMappings>
[src]

Represents a collection of "BasePathMapping" resources.

§
getClientCertificate(params: GetClientCertificateRequest, opts?: client.RequestOptions): Promise<ClientCertificate>
[src]

Gets information about the current "ClientCertificate" resource.

§
getClientCertificates(params?: GetClientCertificatesRequest, opts?: client.RequestOptions): Promise<ClientCertificates>
[src]

Gets a collection of "ClientCertificate" resources.

§
getDeployment(params: GetDeploymentRequest, opts?: client.RequestOptions): Promise<Deployment>
[src]

Gets information about a "Deployment" resource.

§
getDeployments(params: GetDeploymentsRequest, opts?: client.RequestOptions): Promise<Deployments>
[src]

Gets information about a "Deployments" collection.

§
getDocumentationPart(params: GetDocumentationPartRequest, opts?: client.RequestOptions): Promise<DocumentationPart>
[src]
§
getDocumentationParts(params: GetDocumentationPartsRequest, opts?: client.RequestOptions): Promise<DocumentationParts>
[src]
§
getDocumentationVersion(params: GetDocumentationVersionRequest, opts?: client.RequestOptions): Promise<DocumentationVersion>
[src]
§
getDocumentationVersions(params: GetDocumentationVersionsRequest, opts?: client.RequestOptions): Promise<DocumentationVersions>
[src]
§
getDomainName(params: GetDomainNameRequest, opts?: client.RequestOptions): Promise<DomainName>
[src]

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

§
getDomainNames(params?: GetDomainNamesRequest, opts?: client.RequestOptions): Promise<DomainNames>
[src]

Represents a collection of "DomainName" resources.

§
getExport(params: GetExportRequest, opts?: client.RequestOptions): Promise<ExportResponse>
[src]

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

§
getGatewayResponse(params: GetGatewayResponseRequest, opts?: client.RequestOptions): Promise<GatewayResponse>
[src]

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

§
getGatewayResponses(params: GetGatewayResponsesRequest, opts?: client.RequestOptions): Promise<GatewayResponses>
[src]

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: GetIntegrationRequest, opts?: client.RequestOptions): Promise<Integration>
[src]

Get the integration settings.

§
getIntegrationResponse(params: GetIntegrationResponseRequest, opts?: client.RequestOptions): Promise<IntegrationResponse>
[src]

Represents a get integration response.

§
getMethod(params: GetMethodRequest, opts?: client.RequestOptions): Promise<Method>
[src]

Describe an existing "Method" resource.

§
getMethodResponse(params: GetMethodResponseRequest, opts?: client.RequestOptions): Promise<MethodResponse>
[src]

Describes a "MethodResponse" resource.

§
getModel(params: GetModelRequest, opts?: client.RequestOptions): Promise<Model>
[src]

Describes an existing model defined for a "RestApi" resource.

§
getModels(params: GetModelsRequest, opts?: client.RequestOptions): Promise<Models>
[src]

Describes existing "Models" defined for a "RestApi" resource.

§
getModelTemplate(params: GetModelTemplateRequest, opts?: client.RequestOptions): Promise<Template>
[src]

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

§
getRequestValidator(params: GetRequestValidatorRequest, opts?: client.RequestOptions): Promise<RequestValidator>
[src]

Gets a "RequestValidator" of a given "RestApi".

§
getRequestValidators(params: GetRequestValidatorsRequest, opts?: client.RequestOptions): Promise<RequestValidators>
[src]

Gets the "RequestValidators" collection of a given "RestApi".

§
getResource(params: GetResourceRequest, opts?: client.RequestOptions): Promise<Resource>
[src]

Lists information about a resource.

§
getResources(params: GetResourcesRequest, opts?: client.RequestOptions): Promise<Resources>
[src]

Lists information about a collection of "Resource" resources.

§
getRestApi(params: GetRestApiRequest, opts?: client.RequestOptions): Promise<RestApi>
[src]

Lists the "RestApi" resource in the collection.

§
getRestApis(params?: GetRestApisRequest, opts?: client.RequestOptions): Promise<RestApis>
[src]

Lists the "RestApis" resources for your collection.

§
getSdk(params: GetSdkRequest, opts?: client.RequestOptions): Promise<SdkResponse>
[src]

Generates a client SDK for a "RestApi" and "Stage".

§
getSdkType(params: GetSdkTypeRequest, opts?: client.RequestOptions): Promise<SdkType>
[src]
§
getSdkTypes(params?: GetSdkTypesRequest, opts?: client.RequestOptions): Promise<SdkTypes>
[src]
§
getStage(params: GetStageRequest, opts?: client.RequestOptions): Promise<Stage>
[src]

Gets information about a "Stage" resource.

§
getStages(params: GetStagesRequest, opts?: client.RequestOptions): Promise<Stages>
[src]

Gets information about one or more "Stage" resources.

§
getTags(params: GetTagsRequest, opts?: client.RequestOptions): Promise<Tags>
[src]

Gets the "Tags" collection for a given resource.

§
getUsage(params: GetUsageRequest, opts?: client.RequestOptions): Promise<Usage>
[src]

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

§
getUsagePlan(params: GetUsagePlanRequest, opts?: client.RequestOptions): Promise<UsagePlan>
[src]

Gets a usage plan of a given plan identifier.

§
getUsagePlanKey(params: GetUsagePlanKeyRequest, opts?: client.RequestOptions): Promise<UsagePlanKey>
[src]

Gets a usage plan key of a given key identifier.

§
getUsagePlanKeys(params: GetUsagePlanKeysRequest, opts?: client.RequestOptions): Promise<UsagePlanKeys>
[src]

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

§
getUsagePlans(params?: GetUsagePlansRequest, opts?: client.RequestOptions): Promise<UsagePlans>
[src]

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

§
importApiKeys(params: ImportApiKeysRequest, opts?: client.RequestOptions): Promise<ApiKeyIds>
[src]

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

§
importDocumentationParts(params: ImportDocumentationPartsRequest, opts?: client.RequestOptions): Promise<DocumentationPartIds>
[src]
§
importRestApi(params: ImportRestApiRequest, opts?: client.RequestOptions): Promise<RestApi>
[src]

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

§
putGatewayResponse(params: PutGatewayResponseRequest, opts?: client.RequestOptions): Promise<GatewayResponse>
[src]

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

§
putIntegration(params: PutIntegrationRequest, opts?: client.RequestOptions): Promise<Integration>
[src]

Sets up a method's integration.

§
putIntegrationResponse(params: PutIntegrationResponseRequest, opts?: client.RequestOptions): Promise<IntegrationResponse>
[src]

Represents a put integration.

§
putMethod(params: PutMethodRequest, opts?: client.RequestOptions): Promise<Method>
[src]

Add a method to an existing "Resource" resource.

§
putMethodResponse(params: PutMethodResponseRequest, opts?: client.RequestOptions): Promise<MethodResponse>
[src]

Adds a "MethodResponse" to an existing "Method" resource.

§
putRestApi(params: PutRestApiRequest, opts?: client.RequestOptions): Promise<RestApi>
[src]

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: TagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Adds or updates a tag on a given resource.

§
testInvokeAuthorizer(params: TestInvokeAuthorizerRequest, opts?: client.RequestOptions): Promise<TestInvokeAuthorizerResponse>
[src]

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

See also: Use Lambda Function as Authorizer Use Cognito User Pool as Authorizer

§
testInvokeMethod(params: TestInvokeMethodRequest, opts?: client.RequestOptions): Promise<TestInvokeMethodResponse>
[src]

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

§
untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Removes a tag from a given resource.

§
updateAccount(params?: UpdateAccountRequest, opts?: client.RequestOptions): Promise<Account>
[src]

Changes information about the current "Account" resource.

§
updateApiKey(params: UpdateApiKeyRequest, opts?: client.RequestOptions): Promise<ApiKey>
[src]

Changes information about an "ApiKey" resource.

§
updateAuthorizer(params: UpdateAuthorizerRequest, opts?: client.RequestOptions): Promise<Authorizer>
[src]

Updates an existing "Authorizer" resource.

See also: AWS CLI

§
updateBasePathMapping(params: UpdateBasePathMappingRequest, opts?: client.RequestOptions): Promise<BasePathMapping>
[src]

Changes information about the "BasePathMapping" resource.

§
updateClientCertificate(params: UpdateClientCertificateRequest, opts?: client.RequestOptions): Promise<ClientCertificate>
[src]

Changes information about an "ClientCertificate" resource.

§
updateDeployment(params: UpdateDeploymentRequest, opts?: client.RequestOptions): Promise<Deployment>
[src]

Changes information about a "Deployment" resource.

§
updateDocumentationPart(params: UpdateDocumentationPartRequest, opts?: client.RequestOptions): Promise<DocumentationPart>
[src]
§
updateDocumentationVersion(params: UpdateDocumentationVersionRequest, opts?: client.RequestOptions): Promise<DocumentationVersion>
[src]
§
updateDomainName(params: UpdateDomainNameRequest, opts?: client.RequestOptions): Promise<DomainName>
[src]

Changes information about the "DomainName" resource.

§
updateGatewayResponse(params: UpdateGatewayResponseRequest, opts?: client.RequestOptions): Promise<GatewayResponse>
[src]

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

§
updateIntegration(params: UpdateIntegrationRequest, opts?: client.RequestOptions): Promise<Integration>
[src]

Represents an update integration.

§
updateIntegrationResponse(params: UpdateIntegrationResponseRequest, opts?: client.RequestOptions): Promise<IntegrationResponse>
[src]

Represents an update integration response.

§
updateMethod(params: UpdateMethodRequest, opts?: client.RequestOptions): Promise<Method>
[src]

Updates an existing "Method" resource.

§
updateMethodResponse(params: UpdateMethodResponseRequest, opts?: client.RequestOptions): Promise<MethodResponse>
[src]

Updates an existing "MethodResponse" resource.

§
updateModel(params: UpdateModelRequest, opts?: client.RequestOptions): Promise<Model>
[src]

Changes information about a model.

§
updateRequestValidator(params: UpdateRequestValidatorRequest, opts?: client.RequestOptions): Promise<RequestValidator>
[src]

Updates a "RequestValidator" of a given "RestApi".

§
updateResource(params: UpdateResourceRequest, opts?: client.RequestOptions): Promise<Resource>
[src]

Changes information about a "Resource" resource.

§
updateRestApi(params: UpdateRestApiRequest, opts?: client.RequestOptions): Promise<RestApi>
[src]

Changes information about the specified API.

§
updateStage(params: UpdateStageRequest, opts?: client.RequestOptions): Promise<Stage>
[src]

Changes information about a "Stage" resource.

§
updateUsage(params: UpdateUsageRequest, opts?: client.RequestOptions): Promise<Usage>
[src]

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

§
updateUsagePlan(params: UpdateUsagePlanRequest, opts?: client.RequestOptions): Promise<UsagePlan>
[src]

Updates a usage plan of a given plan Id.

§Static Properties