- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
APIGatewayClient
Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
Installation
npm install @aws-sdk/client-api-gatewayyarn add @aws-sdk/client-api-gatewaypnpm add @aws-sdk/client-api-gatewayAPIGatewayClient Operations
Command | Summary |
|---|
Command | Summary |
|---|---|
| CreateApiKeyCommand | Create an ApiKey resource. |
| CreateAuthorizerCommand | Adds a new Authorizer resource to an existing RestApi resource. |
| CreateBasePathMappingCommand | Creates a new BasePathMapping resource. |
| CreateDeploymentCommand | Creates a Deployment resource, which makes a specified RestApi callable over the internet. |
| CreateDocumentationPartCommand | Creates a documentation part. |
| CreateDocumentationVersionCommand | Creates a documentation version |
| CreateDomainNameAccessAssociationCommand | Creates a domain name access association resource between an access association source and a private custom domain name. |
| CreateDomainNameCommand | Creates a new domain name. |
| CreateModelCommand | Adds a new Model resource to an existing RestApi resource. |
| CreateRequestValidatorCommand | Creates a RequestValidator of a given RestApi. |
| CreateResourceCommand | Creates a Resource resource. |
| CreateRestApiCommand | Creates a new RestApi resource. |
| CreateStageCommand | Creates a new Stage resource that references a pre-existing Deployment for the API. |
| CreateUsagePlanCommand | Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload. |
| CreateUsagePlanKeyCommand | Creates a usage plan key for adding an existing API key to a usage plan. |
| CreateVpcLinkCommand | 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. |
| DeleteApiKeyCommand | Deletes the ApiKey resource. |
| DeleteAuthorizerCommand | Deletes an existing Authorizer resource. |
| DeleteBasePathMappingCommand | Deletes the BasePathMapping resource. |
| DeleteClientCertificateCommand | Deletes the ClientCertificate resource. |
| DeleteDeploymentCommand | Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it. |
| DeleteDocumentationPartCommand | Deletes a documentation part |
| DeleteDocumentationVersionCommand | Deletes a documentation version. |
| DeleteDomainNameAccessAssociationCommand | Deletes the DomainNameAccessAssociation resource. Only the AWS account that created the DomainNameAccessAssociation resource can delete it. To stop an access association source in another AWS account from accessing your private custom domain name, use the RejectDomainNameAccessAssociation operation. |
| DeleteDomainNameCommand | Deletes the DomainName resource. |
| DeleteGatewayResponseCommand | Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings. |
| DeleteIntegrationCommand | Represents a delete integration. |
| DeleteIntegrationResponseCommand | Represents a delete integration response. |
| DeleteMethodCommand | Deletes an existing Method resource. |
| DeleteMethodResponseCommand | Deletes an existing MethodResponse resource. |
| DeleteModelCommand | Deletes a model. |
| DeleteRequestValidatorCommand | Deletes a RequestValidator of a given RestApi. |
| DeleteResourceCommand | Deletes a Resource resource. |
| DeleteRestApiCommand | Deletes the specified API. |
| DeleteStageCommand | Deletes a Stage resource. |
| DeleteUsagePlanCommand | Deletes a usage plan of a given plan Id. |
| DeleteUsagePlanKeyCommand | Deletes a usage plan key and remove the underlying API key from the associated usage plan. |
| DeleteVpcLinkCommand | Deletes an existing VpcLink of a specified identifier. |
| FlushStageAuthorizersCacheCommand | Flushes all authorizer cache entries on a stage. |
| FlushStageCacheCommand | Flushes a stage's cache. |
| GenerateClientCertificateCommand | Generates a ClientCertificate resource. |
| GetAccountCommand | Gets information about the current Account resource. |
| GetApiKeyCommand | Gets information about the current ApiKey resource. |
| GetApiKeysCommand | Gets information about the current ApiKeys resource. |
| GetAuthorizerCommand | Describe an existing Authorizer resource. |
| GetAuthorizersCommand | Describe an existing Authorizers resource. |
| GetBasePathMappingCommand | Describe a BasePathMapping resource. |
| GetBasePathMappingsCommand | Represents a collection of BasePathMapping resources. |
| GetClientCertificateCommand | Gets information about the current ClientCertificate resource. |
| GetClientCertificatesCommand | Gets a collection of ClientCertificate resources. |
| GetDeploymentCommand | Gets information about a Deployment resource. |
| GetDeploymentsCommand | Gets information about a Deployments collection. |
| GetDocumentationPartCommand | Gets a documentation part. |
| GetDocumentationPartsCommand | Gets documentation parts. |
| GetDocumentationVersionCommand | Gets a documentation version. |
| GetDocumentationVersionsCommand | Gets documentation versions. |
| GetDomainNameAccessAssociationsCommand | Represents a collection on DomainNameAccessAssociations resources. |
| GetDomainNameCommand | Represents a domain name that is contained in a simpler, more intuitive URL that can be called. |
| GetDomainNamesCommand | Represents a collection of DomainName resources. |
| GetExportCommand | Exports a deployed version of a RestApi in a specified format. |
| GetGatewayResponseCommand | Gets a GatewayResponse of a specified response type on the given RestApi. |
| GetGatewayResponsesCommand | 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. |
| GetIntegrationCommand | Get the integration settings. |
| GetIntegrationResponseCommand | Represents a get integration response. |
| GetMethodCommand | Describe an existing Method resource. |
| GetMethodResponseCommand | Describes a MethodResponse resource. |
| GetModelCommand | Describes an existing model defined for a RestApi resource. |
| GetModelTemplateCommand | Generates a sample mapping template that can be used to transform a payload into the structure of a model. |
| GetModelsCommand | Describes existing Models defined for a RestApi resource. |
| GetRequestValidatorCommand | Gets a RequestValidator of a given RestApi. |
| GetRequestValidatorsCommand | Gets the RequestValidators collection of a given RestApi. |
| GetResourceCommand | Lists information about a resource. |
| GetResourcesCommand | Lists information about a collection of Resource resources. |
| GetRestApiCommand | Lists the RestApi resource in the collection. |
| GetRestApisCommand | Lists the RestApis resources for your collection. |
| GetSdkCommand | Generates a client SDK for a RestApi and Stage. |
| GetSdkTypeCommand | Gets an SDK type. |
| GetSdkTypesCommand | Gets SDK types |
| GetStageCommand | Gets information about a Stage resource. |
| GetStagesCommand | Gets information about one or more Stage resources. |
| GetTagsCommand | Gets the Tags collection for a given resource. |
| GetUsageCommand | Gets the usage data of a usage plan in a specified time interval. |
| GetUsagePlanCommand | Gets a usage plan of a given plan identifier. |
| GetUsagePlanKeyCommand | Gets a usage plan key of a given key identifier. |
| GetUsagePlanKeysCommand | Gets all the usage plan keys representing the API keys added to a specified usage plan. |
| GetUsagePlansCommand | Gets all the usage plans of the caller's account. |
| GetVpcLinkCommand | Gets a specified VPC link under the caller's account in a region. |
| GetVpcLinksCommand | Gets the VpcLinks collection under the caller's account in a selected region. |
| ImportApiKeysCommand | Import API keys from an external source, such as a CSV-formatted file. |
| ImportDocumentationPartsCommand | Imports documentation parts |
| ImportRestApiCommand | A feature of the API Gateway control service for creating a new API from an external API definition file. |
| PutGatewayResponseCommand | Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi. |
| PutIntegrationCommand | Sets up a method's integration. |
| PutIntegrationResponseCommand | Represents a put integration. |
| PutMethodCommand | Add a method to an existing Resource resource. |
| PutMethodResponseCommand | Adds a MethodResponse to an existing Method resource. |
| PutRestApiCommand | 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. |
| RejectDomainNameAccessAssociationCommand | Rejects a domain name access association with a private custom domain name. To reject a domain name access association with an access association source in another AWS account, use this operation. To remove a domain name access association with an access association source in your own account, use the DeleteDomainNameAccessAssociation operation. |
| TagResourceCommand | Adds or updates a tag on a given resource. |
| TestInvokeAuthorizerCommand | Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body. |
| TestInvokeMethodCommand | Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body. |
| UntagResourceCommand | Removes a tag from a given resource. |
| UpdateAccountCommand | Changes information about the current Account resource. |
| UpdateApiKeyCommand | Changes information about an ApiKey resource. |
| UpdateAuthorizerCommand | Updates an existing Authorizer resource. |
| UpdateBasePathMappingCommand | Changes information about the BasePathMapping resource. |
| UpdateClientCertificateCommand | Changes information about an ClientCertificate resource. |
| UpdateDeploymentCommand | Changes information about a Deployment resource. |
| UpdateDocumentationPartCommand | Updates a documentation part. |
| UpdateDocumentationVersionCommand | Updates a documentation version. |
| UpdateDomainNameCommand | Changes information about the DomainName resource. |
| UpdateGatewayResponseCommand | Updates a GatewayResponse of a specified response type on the given RestApi. |
| UpdateIntegrationCommand | Represents an update integration. |
| UpdateIntegrationResponseCommand | Represents an update integration response. |
| UpdateMethodCommand | Updates an existing Method resource. |
| UpdateMethodResponseCommand | Updates an existing MethodResponse resource. |
| UpdateModelCommand | Changes information about a model. The maximum size of the model is 400 KB. |
| UpdateRequestValidatorCommand | Updates a RequestValidator of a given RestApi. |
| UpdateResourceCommand | Changes information about a Resource resource. |
| UpdateRestApiCommand | Changes information about the specified API. |
| UpdateStageCommand | Changes information about a Stage resource. |
| UpdateUsageCommand | Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key. |
| UpdateUsagePlanCommand | Updates a usage plan of a given plan Id. |
| UpdateVpcLinkCommand | Updates an existing VpcLink of a specified identifier. |
APIGatewayClient Configuration
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
defaultsModeOptional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefixOptional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensionsOptional | RuntimeExtension[] | Optional extensions |
loggerOptional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttemptsOptional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profileOptional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
regionOptional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandlerOptional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryModeOptional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpointOptional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpointOptional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: APIGatewayClientConfig