aws-elixir

v0.5.0

aws-elixir v0.5.0 AWS.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.

Summary

Functions

create_api_key(client, input, options \\ [])

Create an ApiKey resource

create_authorizer(client, rest_api_id, input, options \\ [])

Adds a new Authorizer resource to an existing RestApi resource

create_base_path_mapping(client, domain_name, input, options \\ [])

Creates a new BasePathMapping resource

create_deployment(client, rest_api_id, input, options \\ [])

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

create_documentation_part(client, rest_api_id, input, options \\ [])
create_documentation_version(client, rest_api_id, input, options \\ [])
create_domain_name(client, input, options \\ [])

Creates a new domain name

create_model(client, rest_api_id, input, options \\ [])

Adds a new Model resource to an existing RestApi resource

create_resource(client, parent_id, rest_api_id, input, options \\ [])

Creates a Resource resource

create_rest_api(client, input, options \\ [])

Creates a new RestApi resource

create_stage(client, rest_api_id, input, options \\ [])

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

create_usage_plan(client, input, options \\ [])

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 \\ [])

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

delete_api_key(client, api_key, input, options \\ [])

Deletes the ApiKey resource

delete_authorizer(client, authorizer_id, rest_api_id, input, options \\ [])

Deletes an existing Authorizer resource

delete_base_path_mapping(client, base_path, domain_name, input, options \\ [])

Deletes the BasePathMapping resource

delete_client_certificate(client, client_certificate_id, input, options \\ [])

Deletes the ClientCertificate resource

delete_deployment(client, deployment_id, rest_api_id, input, options \\ [])

Deletes 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 \\ [])
delete_documentation_version(client, documentation_version, rest_api_id, input, options \\ [])
delete_domain_name(client, domain_name, input, options \\ [])

Deletes the DomainName resource

delete_integration(client, http_method, resource_id, rest_api_id, input, options \\ [])

Represents a delete integration

delete_integration_response(client, http_method, resource_id, rest_api_id, status_code, input, options \\ [])

Represents a delete integration response

delete_method(client, http_method, resource_id, rest_api_id, input, options \\ [])

Deletes an existing Method resource

delete_method_response(client, http_method, resource_id, rest_api_id, status_code, input, options \\ [])

Deletes an existing MethodResponse resource

delete_model(client, model_name, rest_api_id, input, options \\ [])

Deletes a model

delete_resource(client, resource_id, rest_api_id, input, options \\ [])

Deletes a Resource resource

delete_rest_api(client, rest_api_id, input, options \\ [])

Deletes the specified API

delete_stage(client, rest_api_id, stage_name, input, options \\ [])

Deletes a Stage resource

delete_usage_plan(client, usage_plan_id, input, options \\ [])

Deletes a usage plan of a given plan Id

delete_usage_plan_key(client, key_id, usage_plan_id, input, options \\ [])

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

flush_stage_authorizers_cache(client, rest_api_id, stage_name, input, options \\ [])

Flushes all authorizer cache entries on a stage

flush_stage_cache(client, rest_api_id, stage_name, input, options \\ [])

Flushes a stage’s cache

generate_client_certificate(client, input, options \\ [])

Generates a ClientCertificate resource

get_account(client, options \\ [])

Gets information about the current Account resource

get_api_key(client, api_key, options \\ [])

Gets information about the current ApiKey resource

get_api_keys(client, options \\ [])

Gets information about the current ApiKeys resource

get_authorizer(client, authorizer_id, rest_api_id, options \\ [])

Describe an existing Authorizer resource

get_authorizers(client, rest_api_id, options \\ [])

Describe an existing Authorizers resource

get_base_path_mapping(client, base_path, domain_name, options \\ [])

Describe a BasePathMapping resource

get_base_path_mappings(client, domain_name, options \\ [])

Represents a collection of BasePathMapping resources

get_client_certificate(client, client_certificate_id, options \\ [])

Gets information about the current ClientCertificate resource

get_client_certificates(client, options \\ [])

Gets a collection of ClientCertificate resources

get_deployment(client, deployment_id, rest_api_id, options \\ [])

Gets information about a Deployment resource

get_deployments(client, rest_api_id, options \\ [])

Gets information about a Deployments collection

get_documentation_part(client, documentation_part_id, rest_api_id, options \\ [])
get_documentation_parts(client, rest_api_id, options \\ [])
get_documentation_version(client, documentation_version, rest_api_id, options \\ [])
get_documentation_versions(client, rest_api_id, options \\ [])
get_domain_name(client, domain_name, options \\ [])

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

get_domain_names(client, options \\ [])

Represents a collection of DomainName resources

get_export(client, export_type, rest_api_id, stage_name, accepts \\ nil, options \\ [])

Exports a deployed version of a RestApi in a specified format

get_integration(client, http_method, resource_id, rest_api_id, options \\ [])

Represents a get integration

get_integration_response(client, http_method, resource_id, rest_api_id, status_code, options \\ [])

Represents a get integration response

get_method(client, http_method, resource_id, rest_api_id, options \\ [])

Describe an existing Method resource

get_method_response(client, http_method, resource_id, rest_api_id, status_code, options \\ [])

Describes a MethodResponse resource

get_model(client, model_name, rest_api_id, options \\ [])

Describes an existing model defined for a RestApi resource

get_model_template(client, model_name, rest_api_id, options \\ [])

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

get_models(client, rest_api_id, options \\ [])

Describes existing Models defined for a RestApi resource

get_resource(client, resource_id, rest_api_id, options \\ [])

Lists information about a resource

get_resources(client, rest_api_id, options \\ [])

Lists information about a collection of Resource resources

get_rest_api(client, rest_api_id, options \\ [])

Lists the RestApi resource in the collection

get_rest_apis(client, options \\ [])

Lists the RestApis resources for your collection

get_sdk(client, rest_api_id, sdk_type, stage_name, options \\ [])

Generates a client SDK for a RestApi and Stage

get_sdk_type(client, id, options \\ [])
get_sdk_types(client, options \\ [])
get_stage(client, rest_api_id, stage_name, options \\ [])

Gets information about a Stage resource

get_stages(client, rest_api_id, options \\ [])

Gets information about one or more Stage resources

get_usage(client, usage_plan_id, options \\ [])

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

get_usage_plan(client, usage_plan_id, options \\ [])

Gets a usage plan of a given plan identifier

get_usage_plan_key(client, key_id, usage_plan_id, options \\ [])

Gets a usage plan key of a given key identifier

get_usage_plan_keys(client, usage_plan_id, options \\ [])

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

get_usage_plans(client, options \\ [])

Gets all the usage plans of the caller’s account

import_api_keys(client, input, options \\ [])

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

import_documentation_parts(client, rest_api_id, input, options \\ [])
import_rest_api(client, input, options \\ [])

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

put_integration(client, http_method, resource_id, rest_api_id, input, options \\ [])

Represents a put integration

put_integration_response(client, http_method, resource_id, rest_api_id, status_code, input, options \\ [])

Represents a put integration

put_method(client, http_method, resource_id, rest_api_id, input, options \\ [])

Add a method to an existing Resource resource

put_method_response(client, http_method, resource_id, rest_api_id, status_code, input, options \\ [])

Adds a MethodResponse to an existing Method resource

put_rest_api(client, rest_api_id, 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

test_invoke_authorizer(client, authorizer_id, rest_api_id, input, options \\ [])

Simulate 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 \\ [])

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

update_account(client, input, options \\ [])

Changes information about the current Account resource

update_api_key(client, api_key, input, options \\ [])

Changes information about an ApiKey resource

update_authorizer(client, authorizer_id, rest_api_id, input, options \\ [])

Updates an existing Authorizer resource

update_base_path_mapping(client, base_path, domain_name, input, options \\ [])

Changes information about the BasePathMapping resource

update_client_certificate(client, client_certificate_id, input, options \\ [])

Changes information about an ClientCertificate resource

update_deployment(client, deployment_id, rest_api_id, input, options \\ [])

Changes information about a Deployment resource

update_documentation_part(client, documentation_part_id, rest_api_id, input, options \\ [])
update_documentation_version(client, documentation_version, rest_api_id, input, options \\ [])
update_domain_name(client, domain_name, input, options \\ [])

Changes information about the DomainName resource

update_integration(client, http_method, resource_id, rest_api_id, input, options \\ [])

Represents an update integration

update_integration_response(client, http_method, resource_id, rest_api_id, status_code, input, options \\ [])

Represents an update integration response

update_method(client, http_method, resource_id, rest_api_id, input, options \\ [])

Updates an existing Method resource

update_method_response(client, http_method, resource_id, rest_api_id, status_code, input, options \\ [])

Updates an existing MethodResponse resource

update_model(client, model_name, rest_api_id, input, options \\ [])

Changes information about a model

update_resource(client, resource_id, rest_api_id, input, options \\ [])

Changes information about a Resource resource

update_rest_api(client, rest_api_id, input, options \\ [])

Changes information about the specified API

update_stage(client, rest_api_id, stage_name, input, options \\ [])

Changes information about a Stage resource

update_usage(client, key_id, usage_plan_id, input, options \\ [])

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

update_usage_plan(client, usage_plan_id, input, options \\ [])

Updates a usage plan of a given plan Id

Functions

create_api_key(client, input, options \\ [])

Create an ApiKey resource.

[AWS CLI](http://docs.aws.amazon.com/cli/latest/reference/apigateway/create-api-key.html)
create_authorizer(client, rest_api_id, 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)
create_base_path_mapping(client, domain_name, input, options \\ [])

Creates a new BasePathMapping resource.

create_deployment(client, rest_api_id, input, options \\ [])

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

create_documentation_part(client, rest_api_id, input, options \\ [])
create_documentation_version(client, rest_api_id, input, options \\ [])
create_domain_name(client, input, options \\ [])

Creates a new domain name.

create_model(client, rest_api_id, input, options \\ [])

Adds a new Model resource to an existing RestApi resource.

create_resource(client, parent_id, rest_api_id, input, options \\ [])

Creates a Resource resource.

create_rest_api(client, input, options \\ [])

Creates a new RestApi resource.

create_stage(client, rest_api_id, input, options \\ [])

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

create_usage_plan(client, input, options \\ [])

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 \\ [])

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

delete_api_key(client, api_key, input, options \\ [])

Deletes the ApiKey resource.

delete_authorizer(client, authorizer_id, rest_api_id, input, options \\ [])

Deletes an existing Authorizer resource.

[AWS CLI](http://docs.aws.amazon.com/cli/latest/reference/apigateway/delete-authorizer.html)
delete_base_path_mapping(client, base_path, domain_name, input, options \\ [])

Deletes the BasePathMapping resource.

delete_client_certificate(client, client_certificate_id, input, options \\ [])

Deletes the ClientCertificate resource.

delete_deployment(client, deployment_id, rest_api_id, input, options \\ [])

Deletes 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 \\ [])
delete_documentation_version(client, documentation_version, rest_api_id, input, options \\ [])
delete_domain_name(client, domain_name, input, options \\ [])

Deletes the DomainName resource.

delete_integration(client, http_method, resource_id, rest_api_id, input, options \\ [])

Represents a delete integration.

delete_integration_response(client, http_method, resource_id, rest_api_id, status_code, input, options \\ [])

Represents a delete integration response.

delete_method(client, http_method, resource_id, rest_api_id, input, options \\ [])

Deletes an existing Method resource.

delete_method_response(client, http_method, resource_id, rest_api_id, status_code, input, options \\ [])

Deletes an existing MethodResponse resource.

delete_model(client, model_name, rest_api_id, input, options \\ [])

Deletes a model.

delete_resource(client, resource_id, rest_api_id, input, options \\ [])

Deletes a Resource resource.

delete_rest_api(client, rest_api_id, input, options \\ [])

Deletes the specified API.

delete_stage(client, rest_api_id, stage_name, input, options \\ [])

Deletes a Stage resource.

delete_usage_plan(client, usage_plan_id, input, options \\ [])

Deletes a usage plan of a given plan Id.

delete_usage_plan_key(client, key_id, usage_plan_id, input, options \\ [])

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

flush_stage_authorizers_cache(client, rest_api_id, stage_name, input, options \\ [])

Flushes all authorizer cache entries on a stage.

flush_stage_cache(client, rest_api_id, stage_name, input, options \\ [])

Flushes a stage’s cache.

generate_client_certificate(client, input, options \\ [])

Generates a ClientCertificate resource.

get_account(client, options \\ [])

Gets information about the current Account resource.

get_api_key(client, api_key, options \\ [])

Gets information about the current ApiKey resource.

get_api_keys(client, options \\ [])

Gets information about the current ApiKeys resource.

get_authorizer(client, authorizer_id, rest_api_id, options \\ [])

Describe an existing Authorizer resource.

[AWS CLI](http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizer.html)
get_authorizers(client, rest_api_id, options \\ [])

Describe an existing Authorizers resource.

[AWS CLI](http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizers.html)
get_base_path_mapping(client, base_path, domain_name, options \\ [])

Describe a BasePathMapping resource.

get_base_path_mappings(client, domain_name, options \\ [])

Represents a collection of BasePathMapping resources.

get_client_certificate(client, client_certificate_id, options \\ [])

Gets information about the current ClientCertificate resource.

get_client_certificates(client, options \\ [])

Gets a collection of ClientCertificate resources.

get_deployment(client, deployment_id, rest_api_id, options \\ [])

Gets information about a Deployment resource.

get_deployments(client, rest_api_id, options \\ [])

Gets information about a Deployments collection.

get_documentation_part(client, documentation_part_id, rest_api_id, options \\ [])
get_documentation_parts(client, rest_api_id, options \\ [])
get_documentation_version(client, documentation_version, rest_api_id, options \\ [])
get_documentation_versions(client, rest_api_id, options \\ [])
get_domain_name(client, domain_name, options \\ [])

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

get_domain_names(client, options \\ [])

Represents a collection of DomainName resources.

get_export(client, export_type, rest_api_id, stage_name, accepts \\ nil, options \\ [])

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

get_integration(client, http_method, resource_id, rest_api_id, options \\ [])

Represents a get integration.

get_integration_response(client, http_method, resource_id, rest_api_id, status_code, options \\ [])

Represents a get integration response.

get_method(client, http_method, resource_id, rest_api_id, options \\ [])

Describe an existing Method resource.

get_method_response(client, http_method, resource_id, rest_api_id, status_code, options \\ [])

Describes a MethodResponse resource.

get_model(client, model_name, rest_api_id, options \\ [])

Describes an existing model defined for a RestApi resource.

get_model_template(client, model_name, rest_api_id, options \\ [])

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

get_models(client, rest_api_id, options \\ [])

Describes existing Models defined for a RestApi resource.

get_resource(client, resource_id, rest_api_id, options \\ [])

Lists information about a resource.

get_resources(client, rest_api_id, options \\ [])

Lists information about a collection of Resource resources.

get_rest_api(client, rest_api_id, options \\ [])

Lists the RestApi resource in the collection.

get_rest_apis(client, options \\ [])

Lists the RestApis resources for your collection.

get_sdk(client, rest_api_id, sdk_type, stage_name, options \\ [])

Generates a client SDK for a RestApi and Stage.

get_sdk_type(client, id, options \\ [])
get_sdk_types(client, options \\ [])
get_stage(client, rest_api_id, stage_name, options \\ [])

Gets information about a Stage resource.

get_stages(client, rest_api_id, options \\ [])

Gets information about one or more Stage resources.

get_usage(client, usage_plan_id, options \\ [])

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

get_usage_plan(client, usage_plan_id, options \\ [])

Gets a usage plan of a given plan identifier.

get_usage_plan_key(client, key_id, usage_plan_id, options \\ [])

Gets a usage plan key of a given key identifier.

get_usage_plan_keys(client, usage_plan_id, options \\ [])

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

get_usage_plans(client, options \\ [])

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

import_api_keys(client, input, options \\ [])

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

import_documentation_parts(client, rest_api_id, input, options \\ [])
import_rest_api(client, input, options \\ [])

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

put_integration(client, http_method, resource_id, rest_api_id, input, options \\ [])

Represents a put integration.

put_integration_response(client, http_method, resource_id, rest_api_id, status_code, input, options \\ [])

Represents a put integration.

put_method(client, http_method, resource_id, rest_api_id, input, options \\ [])

Add a method to an existing Resource resource.

put_method_response(client, http_method, resource_id, rest_api_id, status_code, input, options \\ [])

Adds a MethodResponse to an existing Method resource.

put_rest_api(client, rest_api_id, 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.

test_invoke_authorizer(client, authorizer_id, rest_api_id, 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)
test_invoke_method(client, http_method, resource_id, rest_api_id, input, options \\ [])

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

update_account(client, input, options \\ [])

Changes information about the current Account resource.

update_api_key(client, api_key, input, options \\ [])

Changes information about an ApiKey resource.

update_authorizer(client, authorizer_id, rest_api_id, input, options \\ [])

Updates an existing Authorizer resource.

[AWS CLI](http://docs.aws.amazon.com/cli/latest/reference/apigateway/update-authorizer.html)
update_base_path_mapping(client, base_path, domain_name, input, options \\ [])

Changes information about the BasePathMapping resource.

update_client_certificate(client, client_certificate_id, input, options \\ [])

Changes information about an ClientCertificate resource.

update_deployment(client, deployment_id, rest_api_id, input, options \\ [])

Changes information about a Deployment resource.

update_documentation_part(client, documentation_part_id, rest_api_id, input, options \\ [])
update_documentation_version(client, documentation_version, rest_api_id, input, options \\ [])
update_domain_name(client, domain_name, input, options \\ [])

Changes information about the DomainName resource.

update_integration(client, http_method, resource_id, rest_api_id, input, options \\ [])

Represents an update integration.

update_integration_response(client, http_method, resource_id, rest_api_id, status_code, input, options \\ [])

Represents an update integration response.

update_method(client, http_method, resource_id, rest_api_id, input, options \\ [])

Updates an existing Method resource.

update_method_response(client, http_method, resource_id, rest_api_id, status_code, input, options \\ [])

Updates an existing MethodResponse resource.

update_model(client, model_name, rest_api_id, input, options \\ [])

Changes information about a model.

update_resource(client, resource_id, rest_api_id, input, options \\ [])

Changes information about a Resource resource.

update_rest_api(client, rest_api_id, input, options \\ [])

Changes information about the specified API.

update_stage(client, rest_api_id, stage_name, input, options \\ [])

Changes information about a Stage resource.

update_usage(client, key_id, usage_plan_id, input, options \\ [])

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

update_usage_plan(client, usage_plan_id, input, options \\ [])

Updates a usage plan of a given plan Id.