aws-elixir v0.6.0 AWS.APIGateway View Source
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.
Link to this section Summary
Functions
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.
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.
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.
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 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.
Deletes an existing VpcLink
of a specified identifier.
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.
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 API Gateway-generated default GatewayResponses
collection for
the supported response types.
Get the integration settings.
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
.
Gets information about a Stage
resource.
Gets information about one or more Stage
resources.
Gets the Tags
collection for a given resource.
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.
Gets a specified VPC link under the caller's account in a region.
Gets the VpcLinks
collection under the caller's account in a selected
region.
Import API keys from an external source, such as a CSV-formatted file.
A feature of the 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 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.
Adds or updates a tag on a given resource.
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.
Removes a tag from a given resource.
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.
Updates an existing VpcLink
of a specified identifier.
Link to this section Functions
Create an ApiKey
resource.
Adds a new Authorizer
resource to an existing RestApi
resource.
create_base_path_mapping(client, domain_name, input, options \\ [])
View SourceCreates a new BasePathMapping
resource.
Creates a Deployment
resource, which makes a specified RestApi
callable
over the internet.
create_documentation_part(client, rest_api_id, input, options \\ [])
View Sourcecreate_documentation_version(client, rest_api_id, input, options \\ [])
View SourceCreates a new domain name.
Adds a new Model
resource to an existing RestApi
resource.
create_request_validator(client, rest_api_id, input, options \\ [])
View SourceCreates a ReqeustValidator
of a given RestApi
.
create_resource(client, parent_id, rest_api_id, input, options \\ [])
View SourceCreates 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.
create_usage_plan_key(client, usage_plan_id, input, options \\ [])
View SourceCreates a usage plan key for adding an existing API key to a usage plan.
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.
Deletes the ApiKey
resource.
delete_authorizer(client, authorizer_id, rest_api_id, input, options \\ [])
View SourceDeletes an existing Authorizer
resource.
delete_base_path_mapping(client, base_path, domain_name, input, options \\ [])
View SourceDeletes the BasePathMapping
resource.
delete_client_certificate(client, client_certificate_id, input, options \\ [])
View SourceDeletes the ClientCertificate
resource.
delete_deployment(client, deployment_id, rest_api_id, input, options \\ [])
View SourceDeletes a Deployment
resource. Deleting a deployment will only succeed if
there are no Stage
resources associated with it.
delete_documentation_part(client, documentation_part_id, rest_api_id, input, options \\ [])
View Sourcedelete_documentation_version(client, documentation_version, rest_api_id, input, options \\ [])
View SourceDeletes the DomainName
resource.
delete_gateway_response(client, response_type, rest_api_id, input, options \\ [])
View SourceClears any customization of a GatewayResponse
of a specified response
type on the given RestApi
and resets it with the default settings.
delete_integration(client, http_method, resource_id, rest_api_id, input, options \\ [])
View SourceRepresents a delete integration.
delete_integration_response(client, http_method, resource_id, rest_api_id, status_code, input, options \\ [])
View SourceRepresents a delete integration response.
delete_method(client, http_method, resource_id, rest_api_id, input, options \\ [])
View SourceDeletes an existing Method
resource.
delete_method_response(client, http_method, resource_id, rest_api_id, status_code, input, options \\ [])
View SourceDeletes an existing MethodResponse
resource.
delete_model(client, model_name, rest_api_id, input, options \\ [])
View SourceDeletes a model.
delete_request_validator(client, request_validator_id, rest_api_id, input, options \\ [])
View SourceDeletes a RequestValidator
of a given RestApi
.
delete_resource(client, resource_id, rest_api_id, input, options \\ [])
View SourceDeletes a Resource
resource.
Deletes the specified API.
delete_stage(client, rest_api_id, stage_name, input, options \\ [])
View SourceDeletes a Stage
resource.
Deletes a usage plan of a given plan Id.
delete_usage_plan_key(client, key_id, usage_plan_id, input, options \\ [])
View SourceDeletes a usage plan key and remove the underlying API key from the associated usage plan.
Deletes an existing VpcLink
of a specified identifier.
flush_stage_authorizers_cache(client, rest_api_id, stage_name, input, options \\ [])
View SourceFlushes all authorizer cache entries on a stage.
flush_stage_cache(client, rest_api_id, stage_name, input, options \\ [])
View SourceFlushes 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.
get_base_path_mapping(client, base_path, domain_name, options \\ [])
View SourceDescribe a BasePathMapping
resource.
Represents a collection of BasePathMapping
resources.
get_client_certificate(client, client_certificate_id, options \\ [])
View SourceGets information about the current ClientCertificate
resource.
Gets a collection of ClientCertificate
resources.
Gets information about a Deployment
resource.
Gets information about a Deployments
collection.
get_documentation_part(client, documentation_part_id, rest_api_id, options \\ [])
View Sourceget_documentation_version(client, documentation_version, rest_api_id, options \\ [])
View SourceRepresents a domain name that is contained in a simpler, more intuitive URL that can be called.
Represents a collection of DomainName
resources.
get_export(client, export_type, rest_api_id, stage_name, accepts, options \\ [])
View SourceExports a deployed version of a RestApi
in a specified format.
get_gateway_response(client, response_type, rest_api_id, options \\ [])
View SourceGets 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 API Gateway-generated default GatewayResponses
collection for
the supported response types.
get_integration(client, http_method, resource_id, rest_api_id, options \\ [])
View SourceGet the integration settings.
get_integration_response(client, http_method, resource_id, rest_api_id, status_code, options \\ [])
View SourceRepresents a get integration response.
get_method(client, http_method, resource_id, rest_api_id, options \\ [])
View SourceDescribe an existing Method
resource.
get_method_response(client, http_method, resource_id, rest_api_id, status_code, options \\ [])
View SourceDescribes a MethodResponse
resource.
Describes an existing model defined for a RestApi
resource.
get_model_template(client, model_name, rest_api_id, options \\ [])
View SourceGenerates 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.
get_request_validator(client, request_validator_id, rest_api_id, options \\ [])
View SourceGets 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
.
Gets information about a Stage
resource.
Gets information about one or more Stage
resources.
Gets the Tags
collection for a given resource.
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.
Gets a specified VPC link under the caller's account in a region.
Gets the VpcLinks
collection under the caller's account in a selected
region.
Import API keys from an external source, such as a CSV-formatted file.
import_documentation_parts(client, rest_api_id, input, options \\ [])
View SourceA feature of the API Gateway control service for creating a new API from an external API definition file.
put_gateway_response(client, response_type, rest_api_id, input, options \\ [])
View SourceCreates a customization of a GatewayResponse
of a specified response type
and status code on the given RestApi
.
put_integration(client, http_method, resource_id, rest_api_id, input, options \\ [])
View SourceSets up a method's integration.
put_integration_response(client, http_method, resource_id, rest_api_id, status_code, input, options \\ [])
View SourceRepresents a put integration.
put_method(client, http_method, resource_id, rest_api_id, input, options \\ [])
View SourceAdd a method to an existing Resource
resource.
put_method_response(client, http_method, resource_id, rest_api_id, status_code, input, options \\ [])
View SourceAdds a MethodResponse
to an existing Method
resource.
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.
Adds or updates a tag on a given resource.
test_invoke_authorizer(client, authorizer_id, rest_api_id, input, options \\ [])
View SourceSimulate the execution of an Authorizer
in your RestApi
with headers,
parameters, and an incoming request body.
test_invoke_method(client, http_method, resource_id, rest_api_id, input, options \\ [])
View SourceSimulate the execution of a Method
in your RestApi
with headers,
parameters, and an incoming request body.
Removes a tag from a given resource.
Changes information about the current Account
resource.
Changes information about an ApiKey
resource.
update_authorizer(client, authorizer_id, rest_api_id, input, options \\ [])
View SourceUpdates an existing Authorizer
resource.
update_base_path_mapping(client, base_path, domain_name, input, options \\ [])
View SourceChanges information about the BasePathMapping
resource.
update_client_certificate(client, client_certificate_id, input, options \\ [])
View SourceChanges information about an ClientCertificate
resource.
update_deployment(client, deployment_id, rest_api_id, input, options \\ [])
View SourceChanges information about a Deployment
resource.
update_documentation_part(client, documentation_part_id, rest_api_id, input, options \\ [])
View Sourceupdate_documentation_version(client, documentation_version, rest_api_id, input, options \\ [])
View SourceChanges information about the DomainName
resource.
update_gateway_response(client, response_type, rest_api_id, input, options \\ [])
View SourceUpdates a GatewayResponse
of a specified response type on the given
RestApi
.
update_integration(client, http_method, resource_id, rest_api_id, input, options \\ [])
View SourceRepresents an update integration.
update_integration_response(client, http_method, resource_id, rest_api_id, status_code, input, options \\ [])
View SourceRepresents an update integration response.
update_method(client, http_method, resource_id, rest_api_id, input, options \\ [])
View SourceUpdates an existing Method
resource.
update_method_response(client, http_method, resource_id, rest_api_id, status_code, input, options \\ [])
View SourceUpdates an existing MethodResponse
resource.
update_model(client, model_name, rest_api_id, input, options \\ [])
View SourceChanges information about a model.
update_request_validator(client, request_validator_id, rest_api_id, input, options \\ [])
View SourceUpdates a RequestValidator
of a given RestApi
.
update_resource(client, resource_id, rest_api_id, input, options \\ [])
View SourceChanges information about a Resource
resource.
Changes information about the specified API.
update_stage(client, rest_api_id, stage_name, input, options \\ [])
View SourceChanges 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.
Updates an existing VpcLink
of a specified identifier.