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

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

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

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 RequestValidator of a given RestApi

Deletes a Resource 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

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

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

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

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

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

Link to this function create_api_key(input \\ %{}, options \\ [])

Create an ApiKey resource.

[AWS CLI](http://docs.aws.amazon.com/cli/latest/reference/apigateway/create-api-key.html)
Link to this function create_authorizer(input \\ %{}, options \\ [])

Adds a new Authorizer resource to an existing RestApi resource.

[AWS CLI](http://docs.aws.amazon.com/cli/latest/reference/apigateway/create-authorizer.html)
Link to this function create_base_path_mapping(input \\ %{}, options \\ [])

Creates a new BasePathMapping resource.

Link to this function create_deployment(input \\ %{}, options \\ [])

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

Link to this function create_documentation_part(input \\ %{}, options \\ [])

No Documentation Availabale

Link to this function create_documentation_version(input \\ %{}, options \\ [])

No Documentation Availabale

Link to this function create_domain_name(input \\ %{}, options \\ [])

Creates a new domain name.

Link to this function create_model(input \\ %{}, options \\ [])

Adds a new Model resource to an existing RestApi resource.

Link to this function create_request_validator(input \\ %{}, options \\ [])

Creates a ReqeustValidator of a given RestApi.

Link to this function create_resource(input \\ %{}, options \\ [])

Creates a Resource resource.

Link to this function create_rest_api(input \\ %{}, options \\ [])

Creates a new RestApi resource.

Link to this function create_stage(input \\ %{}, options \\ [])

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

Link to this function create_usage_plan(input \\ %{}, options \\ [])

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

Link to this function create_usage_plan_key(input \\ %{}, options \\ [])

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

Link to this function delete_api_key(input \\ %{}, options \\ [])

Deletes the ApiKey resource.

Link to this function delete_authorizer(input \\ %{}, options \\ [])

Deletes an existing Authorizer resource.

[AWS CLI](http://docs.aws.amazon.com/cli/latest/reference/apigateway/delete-authorizer.html)
Link to this function delete_base_path_mapping(input \\ %{}, options \\ [])

Deletes the BasePathMapping resource.

Link to this function delete_client_certificate(input \\ %{}, options \\ [])

Deletes the ClientCertificate resource.

Link to this function delete_deployment(input \\ %{}, options \\ [])

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

Link to this function delete_documentation_part(input \\ %{}, options \\ [])

No Documentation Availabale

Link to this function delete_documentation_version(input \\ %{}, options \\ [])

No Documentation Availabale

Link to this function delete_domain_name(input \\ %{}, options \\ [])

Deletes the DomainName resource.

Link to this function delete_gateway_response(input \\ %{}, options \\ [])

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

Link to this function delete_integration(input \\ %{}, options \\ [])

Represents a delete integration.

Link to this function delete_integration_response(input \\ %{}, options \\ [])

Represents a delete integration response.

Link to this function delete_method(input \\ %{}, options \\ [])

Deletes an existing Method resource.

Link to this function delete_method_response(input \\ %{}, options \\ [])

Deletes an existing MethodResponse resource.

Link to this function delete_model(input \\ %{}, options \\ [])

Deletes a model.

Link to this function delete_request_validator(input \\ %{}, options \\ [])

Deletes a RequestValidator of a given RestApi.

Link to this function delete_resource(input \\ %{}, options \\ [])

Deletes a Resource resource.

Link to this function delete_rest_api(input \\ %{}, options \\ [])

Deletes the specified API.

Link to this function delete_stage(input \\ %{}, options \\ [])

Deletes a Stage resource.

Link to this function delete_usage_plan(input \\ %{}, options \\ [])

Deletes a usage plan of a given plan Id.

Link to this function delete_usage_plan_key(input \\ %{}, options \\ [])

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

Link to this function flush_stage_authorizers_cache(input \\ %{}, options \\ [])

Flushes all authorizer cache entries on a stage.

Link to this function flush_stage_cache(input \\ %{}, options \\ [])

Flushes a stage’s cache.

Link to this function generate_client_certificate(input \\ %{}, options \\ [])

Generates a ClientCertificate resource.

Link to this function get_account(input \\ %{}, options \\ [])

Gets information about the current Account resource.

Link to this function get_api_key(input \\ %{}, options \\ [])

Gets information about the current ApiKey resource.

Link to this function get_api_keys(input \\ %{}, options \\ [])

Gets information about the current ApiKeys resource.

Link to this function get_authorizer(input \\ %{}, options \\ [])

Describe an existing Authorizer resource.

[AWS CLI](http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizer.html)
Link to this function get_authorizers(input \\ %{}, options \\ [])

Describe an existing Authorizers resource.

[AWS CLI](http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizers.html)
Link to this function get_base_path_mapping(input \\ %{}, options \\ [])

Describe a BasePathMapping resource.

Link to this function get_base_path_mappings(input \\ %{}, options \\ [])

Represents a collection of BasePathMapping resources.

Link to this function get_client_certificate(input \\ %{}, options \\ [])

Gets information about the current ClientCertificate resource.

Link to this function get_client_certificates(input \\ %{}, options \\ [])

Gets a collection of ClientCertificate resources.

Link to this function get_deployment(input \\ %{}, options \\ [])

Gets information about a Deployment resource.

Link to this function get_deployments(input \\ %{}, options \\ [])

Gets information about a Deployments collection.

Link to this function get_documentation_part(input \\ %{}, options \\ [])

No Documentation Availabale

Link to this function get_documentation_parts(input \\ %{}, options \\ [])

No Documentation Availabale

Link to this function get_documentation_version(input \\ %{}, options \\ [])

No Documentation Availabale

Link to this function get_documentation_versions(input \\ %{}, options \\ [])

No Documentation Availabale

Link to this function get_domain_name(input \\ %{}, options \\ [])

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

Link to this function get_domain_names(input \\ %{}, options \\ [])

Represents a collection of DomainName resources.

Link to this function get_export(input \\ %{}, options \\ [])

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

Link to this function get_gateway_response(input \\ %{}, options \\ [])

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

Link to this function get_gateway_responses(input \\ %{}, options \\ [])

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.

Link to this function get_integration(input \\ %{}, options \\ [])

Represents a get integration.

Link to this function get_integration_response(input \\ %{}, options \\ [])

Represents a get integration response.

Link to this function get_method(input \\ %{}, options \\ [])

Describe an existing Method resource.

Link to this function get_method_response(input \\ %{}, options \\ [])

Describes a MethodResponse resource.

Link to this function get_model(input \\ %{}, options \\ [])

Describes an existing model defined for a RestApi resource.

Link to this function get_model_template(input \\ %{}, options \\ [])

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

Link to this function get_models(input \\ %{}, options \\ [])

Describes existing Models defined for a RestApi resource.

Link to this function get_request_validator(input \\ %{}, options \\ [])

Gets a RequestValidator of a given RestApi.

Link to this function get_request_validators(input \\ %{}, options \\ [])

Gets the RequestValidators collection of a given RestApi.

Link to this function get_resource(input \\ %{}, options \\ [])

Lists information about a resource.

Link to this function get_resources(input \\ %{}, options \\ [])

Lists information about a collection of Resource resources.

Link to this function get_rest_api(input \\ %{}, options \\ [])

Lists the RestApi resource in the collection.

Link to this function get_rest_apis(input \\ %{}, options \\ [])

Lists the RestApis resources for your collection.

Link to this function get_sdk(input \\ %{}, options \\ [])

Generates a client SDK for a RestApi and Stage.

Link to this function get_sdk_type(input \\ %{}, options \\ [])

No Documentation Availabale

Link to this function get_sdk_types(input \\ %{}, options \\ [])

No Documentation Availabale

Link to this function get_stage(input \\ %{}, options \\ [])

Gets information about a Stage resource.

Link to this function get_stages(input \\ %{}, options \\ [])

Gets information about one or more Stage resources.

Link to this function get_usage(input \\ %{}, options \\ [])

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

Link to this function get_usage_plan(input \\ %{}, options \\ [])

Gets a usage plan of a given plan identifier.

Link to this function get_usage_plan_key(input \\ %{}, options \\ [])

Gets a usage plan key of a given key identifier.

Link to this function get_usage_plan_keys(input \\ %{}, options \\ [])

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

Link to this function get_usage_plans(input \\ %{}, options \\ [])

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

Link to this function import_api_keys(input \\ %{}, options \\ [])

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

Link to this function import_documentation_parts(input \\ %{}, options \\ [])

No Documentation Availabale

Link to this function import_rest_api(input \\ %{}, options \\ [])

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

Link to this function put_gateway_response(input \\ %{}, options \\ [])

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

Link to this function put_integration(input \\ %{}, options \\ [])

Sets up a method’s integration.

Link to this function put_integration_response(input \\ %{}, options \\ [])

Represents a put integration.

Link to this function put_method(input \\ %{}, options \\ [])

Add a method to an existing Resource resource.

Link to this function put_method_response(input \\ %{}, options \\ [])

Adds a MethodResponse to an existing Method resource.

Link to this function put_rest_api(input \\ %{}, options \\ [])

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.

Link to this function test_invoke_authorizer(input \\ %{}, options \\ [])

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

[Enable custom authorizers](http://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html)
Link to this function test_invoke_method(input \\ %{}, options \\ [])

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

Link to this function update_account(input \\ %{}, options \\ [])

Changes information about the current Account resource.

Link to this function update_api_key(input \\ %{}, options \\ [])

Changes information about an ApiKey resource.

Link to this function update_authorizer(input \\ %{}, options \\ [])

Updates an existing Authorizer resource.

[AWS CLI](http://docs.aws.amazon.com/cli/latest/reference/apigateway/update-authorizer.html)
Link to this function update_base_path_mapping(input \\ %{}, options \\ [])

Changes information about the BasePathMapping resource.

Link to this function update_client_certificate(input \\ %{}, options \\ [])

Changes information about an ClientCertificate resource.

Link to this function update_deployment(input \\ %{}, options \\ [])

Changes information about a Deployment resource.

Link to this function update_documentation_part(input \\ %{}, options \\ [])

No Documentation Availabale

Link to this function update_documentation_version(input \\ %{}, options \\ [])

No Documentation Availabale

Link to this function update_domain_name(input \\ %{}, options \\ [])

Changes information about the DomainName resource.

Link to this function update_gateway_response(input \\ %{}, options \\ [])

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

Link to this function update_integration(input \\ %{}, options \\ [])

Represents an update integration.

Link to this function update_integration_response(input \\ %{}, options \\ [])

Represents an update integration response.

Link to this function update_method(input \\ %{}, options \\ [])

Updates an existing Method resource.

Link to this function update_method_response(input \\ %{}, options \\ [])

Updates an existing MethodResponse resource.

Link to this function update_model(input \\ %{}, options \\ [])

Changes information about a model.

Link to this function update_request_validator(input \\ %{}, options \\ [])

Updates a RequestValidator of a given RestApi.

Link to this function update_resource(input \\ %{}, options \\ [])

Changes information about a Resource resource.

Link to this function update_rest_api(input \\ %{}, options \\ [])

Changes information about the specified API.

Link to this function update_stage(input \\ %{}, options \\ [])

Changes information about a Stage resource.

Link to this function update_usage(input \\ %{}, options \\ [])

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

Link to this function update_usage_plan(input \\ %{}, options \\ [])

Updates a usage plan of a given plan Id.