baiji v0.6.0 Baiji.ApiGateway
Amazon API Gateway
Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. Amazon 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.
Link to this section Summary
Functions
Returns a map containing the input/output shapes for this endpoint
Outputs values common to all actions
Create an ApiKey
resource
Adds a new Authorizer
resource to an existing RestApi
resource
Creates a new BasePathMapping
resource
Creates a Deployment
resource, which makes a specified RestApi
callable
over the internet
No Documentation Availabale
No Documentation Availabale
Creates a new domain name
Adds a new Model
resource to an existing RestApi
resource
Creates a ReqeustValidator
of a given RestApi
Creates a Resource
resource
Creates a new RestApi
resource
Creates a new Stage
resource that references a pre-existing Deployment
for the API
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload
Creates a usage plan key for adding an existing API key to a usage plan
Deletes the ApiKey
resource
Deletes an existing Authorizer
resource
Deletes the BasePathMapping
resource
Deletes the ClientCertificate
resource
Deletes a Deployment
resource. Deleting a deployment will only succeed if
there are no Stage
resources associated with it
No Documentation Availabale
No Documentation Availabale
Deletes the DomainName
resource
Clears any customization of a GatewayResponse
of a specified response
type on the given RestApi
and resets it with the default settings
Represents a delete integration
Represents a delete integration response
Deletes an existing Method
resource
Deletes an existing MethodResponse
resource
Deletes a model
Deletes a RequestValidator
of a given RestApi
Deletes a Resource
resource
Deletes the specified API
Deletes a Stage
resource
Deletes a usage plan of a given plan Id
Deletes a usage plan key and remove the underlying API key from the associated usage plan
Flushes all authorizer cache entries on a stage
Flushes a stage’s cache
Generates a ClientCertificate
resource
Gets information about the current Account
resource
Gets information about the current ApiKey
resource
Gets information about the current ApiKeys
resource
Describe an existing Authorizer
resource
Describe an existing Authorizers
resource
Describe a BasePathMapping
resource
Represents a collection of BasePathMapping
resources
Gets information about the current ClientCertificate
resource
Gets a collection of ClientCertificate
resources
Gets information about a Deployment
resource
Gets information about a Deployments
collection
No Documentation Availabale
No Documentation Availabale
No Documentation Availabale
No Documentation Availabale
Represents a domain name that is contained in a simpler, more intuitive URL that can be called
Represents a collection of DomainName
resources
Exports a deployed version of a RestApi
in a specified format
Gets a GatewayResponse
of a specified response type on the given
RestApi
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 Amazon API Gateway-generated default GatewayResponses
collection for the supported response types
Represents a get integration
Represents a get integration response
Describe an existing Method
resource
Describes a MethodResponse
resource
Describes an existing model defined for a RestApi
resource
Generates a sample mapping template that can be used to transform a payload into the structure of a model
Describes existing Models
defined for a RestApi
resource
Gets a RequestValidator
of a given RestApi
Gets the RequestValidators
collection of a given RestApi
Lists information about a resource
Lists information about a collection of Resource
resources
Lists the RestApi
resource in the collection
Lists the RestApis
resources for your collection
Generates a client SDK for a RestApi
and Stage
No Documentation Availabale
No Documentation Availabale
Gets information about a Stage
resource
Gets information about one or more Stage
resources
Gets the usage data of a usage plan in a specified time interval
Gets a usage plan of a given plan identifier
Gets a usage plan key of a given key identifier
Gets all the usage plan keys representing the API keys added to a specified usage plan
Gets all the usage plans of the caller’s account
Import API keys from an external source, such as a CSV-formatted file
No Documentation Availabale
A feature of the Amazon API Gateway control service for creating a new API from an external API definition file
Creates a customization of a GatewayResponse
of a specified response type
and status code on the given RestApi
Sets up a method’s integration
Represents a put integration
Add a method to an existing Resource
resource
Adds a MethodResponse
to an existing Method
resource
A feature of the Amazon 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
Simulate the execution of an Authorizer
in your RestApi
with headers,
parameters, and an incoming request body
Simulate the execution of a Method
in your RestApi
with headers,
parameters, and an incoming request body
Changes information about the current Account
resource
Changes information about an ApiKey
resource
Updates an existing Authorizer
resource
Changes information about the BasePathMapping
resource
Changes information about an ClientCertificate
resource
Changes information about a Deployment
resource
No Documentation Availabale
No Documentation Availabale
Changes information about the DomainName
resource
Updates a GatewayResponse
of a specified response type on the given
RestApi
Represents an update integration
Represents an update integration response
Updates an existing Method
resource
Updates an existing MethodResponse
resource
Changes information about a model
Updates a RequestValidator
of a given RestApi
Changes information about a Resource
resource
Changes information about the specified API
Changes information about a Stage
resource
Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key
Updates a usage plan of a given plan Id
Link to this section Functions
Returns a map containing the input/output shapes for this endpoint
Outputs values common to all actions
Create an ApiKey
resource.
Adds a new Authorizer
resource to an existing RestApi
resource.
Creates a new BasePathMapping
resource.
Creates a Deployment
resource, which makes a specified RestApi
callable
over the internet.
No Documentation Availabale
No Documentation Availabale
Creates a new domain name.
Adds a new Model
resource to an existing RestApi
resource.
Creates a ReqeustValidator
of a given RestApi
.
Creates a Resource
resource.
Creates a new RestApi
resource.
Creates a new Stage
resource that references a pre-existing Deployment
for the API.
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
Creates a usage plan key for adding an existing API key to a usage plan.
Deletes the ApiKey
resource.
Deletes an existing Authorizer
resource.
Deletes the BasePathMapping
resource.
Deletes the ClientCertificate
resource.
Deletes a Deployment
resource. Deleting a deployment will only succeed if
there are no Stage
resources associated with it.
No Documentation Availabale
No Documentation Availabale
Deletes the DomainName
resource.
Clears any customization of a GatewayResponse
of a specified response
type on the given RestApi
and resets it with the default settings.
Represents a delete integration.
Represents a delete integration response.
Deletes an existing Method
resource.
Deletes an existing MethodResponse
resource.
Deletes a model.
Deletes a RequestValidator
of a given RestApi
.
Deletes a Resource
resource.
Deletes the specified API.
Deletes a Stage
resource.
Deletes a usage plan of a given plan Id.
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
Flushes all authorizer cache entries on a stage.
Flushes a stage’s cache.
Generates a ClientCertificate
resource.
Gets information about the current Account
resource.
Gets information about the current ApiKey
resource.
Gets information about the current ApiKeys
resource.
Describe an existing Authorizer
resource.
Describe an existing Authorizers
resource.
Describe a BasePathMapping
resource.
Represents a collection of BasePathMapping
resources.
Gets information about the current ClientCertificate
resource.
Gets a collection of ClientCertificate
resources.
Gets information about a Deployment
resource.
Gets information about a Deployments
collection.
No Documentation Availabale
No Documentation Availabale
No Documentation Availabale
No Documentation Availabale
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
Represents a collection of DomainName
resources.
Exports a deployed version of a RestApi
in a specified format.
Gets a GatewayResponse
of a specified response type on the given
RestApi
.
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 Amazon API Gateway-generated default GatewayResponses
collection for the supported response types.
Represents a get integration.
Represents a get integration response.
Describe an existing Method
resource.
Describes a MethodResponse
resource.
Describes an existing model defined for a RestApi
resource.
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
Describes existing Models
defined for a RestApi
resource.
Gets a RequestValidator
of a given RestApi
.
Gets the RequestValidators
collection of a given RestApi
.
Lists information about a resource.
Lists information about a collection of Resource
resources.
Lists the RestApi
resource in the collection.
Lists the RestApis
resources for your collection.
Generates a client SDK for a RestApi
and Stage
.
No Documentation Availabale
No Documentation Availabale
Gets information about a Stage
resource.
Gets information about one or more Stage
resources.
Gets the usage data of a usage plan in a specified time interval.
Gets a usage plan of a given plan identifier.
Gets a usage plan key of a given key identifier.
Gets all the usage plan keys representing the API keys added to a specified usage plan.
Gets all the usage plans of the caller’s account.
Import API keys from an external source, such as a CSV-formatted file.
No Documentation Availabale
A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.
Creates a customization of a GatewayResponse
of a specified response type
and status code on the given RestApi
.
Sets up a method’s integration.
Represents a put integration.
Add a method to an existing Resource
resource.
Adds a MethodResponse
to an existing Method
resource.
A feature of the Amazon 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.
Simulate the execution of an Authorizer
in your RestApi
with headers,
parameters, and an incoming request body.
Simulate the execution of a Method
in your RestApi
with headers,
parameters, and an incoming request body.
Changes information about the current Account
resource.
Changes information about an ApiKey
resource.
Updates an existing Authorizer
resource.
Changes information about the BasePathMapping
resource.
Changes information about an ClientCertificate
resource.
Changes information about a Deployment
resource.
No Documentation Availabale
No Documentation Availabale
Changes information about the DomainName
resource.
Updates a GatewayResponse
of a specified response type on the given
RestApi
.
Represents an update integration.
Represents an update integration response.
Updates an existing Method
resource.
Updates an existing MethodResponse
resource.
Changes information about a model.
Updates a RequestValidator
of a given RestApi
.
Changes information about a Resource
resource.
Changes information about the specified API.
Changes information about a Stage
resource.
Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
Updates a usage plan of a given plan Id.