aws apigateway

Amazon API Gateway 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 AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS

Subcommands

NameDescription
create-api-keyCreate an ApiKey resource. AWS CLI
create-authorizerAdds a new Authorizer resource to an existing RestApi resource. AWS CLI
create-base-path-mappingCreates a new BasePathMapping resource
create-deploymentCreates a Deployment resource, which makes a specified RestApi callable over the internet
create-documentation-part
create-documentation-version
create-domain-nameCreates a new domain name
create-modelAdds a new Model resource to an existing RestApi resource
create-request-validatorCreates a RequestValidator of a given RestApi
create-resourceCreates a Resource resource
create-rest-apiCreates a new RestApi resource
create-stageCreates a new Stage resource that references a pre-existing Deployment for the API
create-usage-planCreates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload
create-usage-plan-keyCreates a usage plan key for adding an existing API key to a usage plan
create-vpc-linkCreates 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
delete-api-keyDeletes the ApiKey resource
delete-authorizerDeletes an existing Authorizer resource. AWS CLI
delete-base-path-mappingDeletes the BasePathMapping resource
delete-client-certificateDeletes the ClientCertificate resource
delete-deploymentDeletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it
delete-documentation-part
delete-documentation-version
delete-domain-nameDeletes the DomainName resource
delete-gateway-responseClears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings
delete-integrationRepresents a delete integration
delete-integration-responseRepresents a delete integration response
delete-methodDeletes an existing Method resource
delete-method-responseDeletes an existing MethodResponse resource
delete-modelDeletes a model
delete-request-validatorDeletes a RequestValidator of a given RestApi
delete-resourceDeletes a Resource resource
delete-rest-apiDeletes the specified API
delete-stageDeletes a Stage resource
delete-usage-planDeletes a usage plan of a given plan Id
delete-usage-plan-keyDeletes a usage plan key and remove the underlying API key from the associated usage plan
delete-vpc-linkDeletes an existing VpcLink of a specified identifier
flush-stage-authorizers-cacheFlushes all authorizer cache entries on a stage
flush-stage-cacheFlushes a stage's cache
generate-client-certificateGenerates a ClientCertificate resource
get-accountGets information about the current Account resource
get-api-keyGets information about the current ApiKey resource
get-api-keysGets information about the current ApiKeys resource
get-authorizerDescribe an existing Authorizer resource. AWS CLI
get-authorizersDescribe an existing Authorizers resource. AWS CLI
get-base-path-mappingDescribe a BasePathMapping resource
get-base-path-mappingsRepresents a collection of BasePathMapping resources
get-client-certificateGets information about the current ClientCertificate resource
get-client-certificatesGets a collection of ClientCertificate resources
get-deploymentGets information about a Deployment resource
get-deploymentsGets information about a Deployments collection
get-documentation-part
get-documentation-parts
get-documentation-version
get-documentation-versions
get-domain-nameRepresents a domain name that is contained in a simpler, more intuitive URL that can be called
get-domain-namesRepresents a collection of DomainName resources
get-exportExports a deployed version of a RestApi in a specified format
get-gateway-responseGets a GatewayResponse of a specified response type on the given RestApi
get-gateway-responsesGets 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
get-integrationGet the integration settings
get-integration-responseRepresents a get integration response
get-methodDescribe an existing Method resource
get-method-responseDescribes a MethodResponse resource
get-modelDescribes an existing model defined for a RestApi resource
get-model-templateGenerates a sample mapping template that can be used to transform a payload into the structure of a model
get-modelsDescribes existing Models defined for a RestApi resource
get-request-validatorGets a RequestValidator of a given RestApi
get-request-validatorsGets the RequestValidators collection of a given RestApi
get-resourceLists information about a resource
get-resourcesLists information about a collection of Resource resources
get-rest-apiLists the RestApi resource in the collection
get-rest-apisLists the RestApis resources for your collection
get-sdkGenerates a client SDK for a RestApi and Stage
get-sdk-type
get-sdk-types
get-stageGets information about a Stage resource
get-stagesGets information about one or more Stage resources
get-tagsGets the Tags collection for a given resource
get-usageGets the usage data of a usage plan in a specified time interval
get-usage-planGets a usage plan of a given plan identifier
get-usage-plan-keyGets a usage plan key of a given key identifier
get-usage-plan-keysGets all the usage plan keys representing the API keys added to a specified usage plan
get-usage-plansGets all the usage plans of the caller's account
get-vpc-linkGets a specified VPC link under the caller's account in a region
get-vpc-linksGets the VpcLinks collection under the caller's account in a selected region
import-api-keysImport API keys from an external source, such as a CSV-formatted file
import-documentation-parts
import-rest-apiA feature of the API Gateway control service for creating a new API from an external API definition file
put-gateway-responseCreates a customization of a GatewayResponse of a specified response type and status code on the given RestApi
put-integrationSets up a method's integration
put-integration-responseRepresents a put integration
put-methodAdd a method to an existing Resource resource
put-method-responseAdds a MethodResponse to an existing Method resource
put-rest-apiA 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
tag-resourceAdds or updates a tag on a given resource
test-invoke-authorizerSimulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body. Use Lambda Function as Authorizer Use Cognito User Pool as Authorizer
test-invoke-methodSimulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body
untag-resourceRemoves a tag from a given resource
update-accountChanges information about the current Account resource
update-api-keyChanges information about an ApiKey resource
update-authorizerUpdates an existing Authorizer resource. AWS CLI
update-base-path-mappingChanges information about the BasePathMapping resource
update-client-certificateChanges information about an ClientCertificate resource
update-deploymentChanges information about a Deployment resource
update-documentation-part
update-documentation-version
update-domain-nameChanges information about the DomainName resource
update-gateway-responseUpdates a GatewayResponse of a specified response type on the given RestApi
update-integrationRepresents an update integration
update-integration-responseRepresents an update integration response
update-methodUpdates an existing Method resource
update-method-responseUpdates an existing MethodResponse resource
update-modelChanges information about a model
update-request-validatorUpdates a RequestValidator of a given RestApi
update-resourceChanges information about a Resource resource
update-rest-apiChanges information about the specified API
update-stageChanges information about a Stage resource
update-usageGrants a temporary extension to the remaining quota of a usage plan associated with a specified API key
update-usage-planUpdates a usage plan of a given plan Id
update-vpc-linkUpdates an existing VpcLink of a specified identifier