AWS.APIGateway (aws-elixir v0.8.0) 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

Adds a new Authorizer resource to an existing RestApi 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 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.

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

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.

Generates a ClientCertificate resource.

Gets information about the current Account resource.

Gets information about the current ApiKey resource.

Describe an existing Authorizer resource.

Gets information about the current ClientCertificate resource.

Gets a collection of ClientCertificate resources.

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

Represents a collection of DomainName resources.

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

Gets the GatewayResponses collection on the given RestApi.

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 the RequestValidators collection of a given RestApi.

Lists the RestApi resource in the collection.

Lists the RestApis resources for your collection.

Gets information about a Stage resource.

Gets information about one or more Stage resources.

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 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.

A feature of the API Gateway control service for updating an existing API with an input of external API definitions.

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.

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.

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

Link to this function

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

View Source

Create an ApiKey resource.

See also: AWS CLI

Link to this function

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

View Source

Adds a new Authorizer resource to an existing RestApi resource.

See also: AWS CLI

Link to this function

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

View Source

Creates a new BasePathMapping resource.

Link to this function

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

View Source

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

Link to this function

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

View Source
Link to this function

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

View Source
Link to this function

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

View Source

Creates a new domain name.

Link to this function

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

View Source

Adds a new Model resource to an existing RestApi resource.

Link to this function

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

View Source

Creates a ReqeustValidator of a given RestApi.

Link to this function

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

View Source

Creates a Resource resource.

Link to this function

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

View Source

Creates a new RestApi resource.

Link to this function

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

View Source

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

Link to this function

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

View Source

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(client, usage_plan_id, input, options \\ [])

View Source

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

Link to this function

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

View Source

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.

Link to this function

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

View Source

Deletes the ApiKey resource.

Link to this function

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

View Source

Deletes an existing Authorizer resource.

See also: AWS CLI

Link to this function

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

View Source

Deletes the BasePathMapping resource.

Link to this function

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

View Source

Deletes the ClientCertificate resource.

Link to this function

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

View Source

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(client, documentation_part_id, rest_api_id, input, options \\ [])

View Source
Link to this function

delete_documentation_version(client, documentation_version, rest_api_id, input, options \\ [])

View Source
Link to this function

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

View Source

Deletes the DomainName resource.

Link to this function

delete_gateway_response(client, response_type, rest_api_id, input, options \\ [])

View Source

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

View Source

Represents a delete integration.

Link to this function

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

View Source

Represents a delete integration response.

Link to this function

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

View Source

Deletes an existing Method resource.

Link to this function

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

View Source

Deletes an existing MethodResponse resource.

Link to this function

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

View Source

Deletes a model.

Link to this function

delete_request_validator(client, request_validator_id, rest_api_id, input, options \\ [])

View Source

Deletes a RequestValidator of a given RestApi.

Link to this function

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

View Source

Deletes a Resource resource.

Link to this function

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

View Source

Deletes the specified API.

Link to this function

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

View Source

Deletes a Stage resource.

Link to this function

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

View Source

Deletes a usage plan of a given plan Id.

Link to this function

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

View Source

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

Link to this function

delete_vpc_link(client, vpc_link_id, input, options \\ [])

View Source

Deletes an existing VpcLink of a specified identifier.

Link to this function

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

View Source

Flushes all authorizer cache entries on a stage.

Link to this function

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

View Source

Flushes a stage's cache.

Link to this function

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

View Source

Generates a ClientCertificate resource.

Link to this function

get_account(client, options \\ [])

View Source

Gets information about the current Account resource.

Link to this function

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

View Source

Gets information about the current ApiKey resource.

Link to this function

get_api_keys(client, customer_id \\ nil, include_values \\ nil, limit \\ nil, name_query \\ nil, position \\ nil, options \\ [])

View Source

Gets information about the current ApiKeys resource.

Link to this function

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

View Source

Describe an existing Authorizer resource.

See also: AWS CLI

Link to this function

get_authorizers(client, rest_api_id, limit \\ nil, position \\ nil, options \\ [])

View Source

Describe an existing Authorizers resource.

See also: AWS CLI

Link to this function

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

View Source

Describe a BasePathMapping resource.

Link to this function

get_base_path_mappings(client, domain_name, limit \\ nil, position \\ nil, options \\ [])

View Source

Represents a collection of BasePathMapping resources.

Link to this function

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

View Source

Gets information about the current ClientCertificate resource.

Link to this function

get_client_certificates(client, limit \\ nil, position \\ nil, options \\ [])

View Source

Gets a collection of ClientCertificate resources.

Link to this function

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

View Source

Gets information about a Deployment resource.

Link to this function

get_deployments(client, rest_api_id, limit \\ nil, position \\ nil, options \\ [])

View Source

Gets information about a Deployments collection.

Link to this function

get_documentation_part(client, documentation_part_id, rest_api_id, options \\ [])

View Source
Link to this function

get_documentation_parts(client, rest_api_id, limit \\ nil, location_status \\ nil, name_query \\ nil, path \\ nil, position \\ nil, type \\ nil, options \\ [])

View Source
Link to this function

get_documentation_version(client, documentation_version, rest_api_id, options \\ [])

View Source
Link to this function

get_documentation_versions(client, rest_api_id, limit \\ nil, position \\ nil, options \\ [])

View Source
Link to this function

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

View Source

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

Link to this function

get_domain_names(client, limit \\ nil, position \\ nil, options \\ [])

View Source

Represents a collection of DomainName resources.

Link to this function

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

View Source

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

Link to this function

get_gateway_response(client, response_type, rest_api_id, options \\ [])

View Source

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

Link to this function

get_gateway_responses(client, rest_api_id, limit \\ nil, position \\ nil, options \\ [])

View Source

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.

Link to this function

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

View Source

Get the integration settings.

Link to this function

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

View Source

Represents a get integration response.

Link to this function

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

View Source

Describe an existing Method resource.

Link to this function

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

View Source

Describes a MethodResponse resource.

Link to this function

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

View Source

Describes an existing model defined for a RestApi resource.

Link to this function

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

View Source

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(client, rest_api_id, limit \\ nil, position \\ nil, options \\ [])

View Source

Describes existing Models defined for a RestApi resource.

Link to this function

get_request_validator(client, request_validator_id, rest_api_id, options \\ [])

View Source

Gets a RequestValidator of a given RestApi.

Link to this function

get_request_validators(client, rest_api_id, limit \\ nil, position \\ nil, options \\ [])

View Source

Gets the RequestValidators collection of a given RestApi.

Link to this function

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

View Source

Lists information about a resource.

Link to this function

get_resources(client, rest_api_id, embed \\ nil, limit \\ nil, position \\ nil, options \\ [])

View Source

Lists information about a collection of Resource resources.

Link to this function

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

View Source

Lists the RestApi resource in the collection.

Link to this function

get_rest_apis(client, limit \\ nil, position \\ nil, options \\ [])

View Source

Lists the RestApis resources for your collection.

Link to this function

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

View Source

Generates a client SDK for a RestApi and Stage.

Link to this function

get_sdk_type(client, id, options \\ [])

View Source
Link to this function

get_sdk_types(client, limit \\ nil, position \\ nil, options \\ [])

View Source
Link to this function

get_stage(client, rest_api_id, stage_name, options \\ [])

View Source

Gets information about a Stage resource.

Link to this function

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

View Source

Gets information about one or more Stage resources.

Link to this function

get_tags(client, resource_arn, limit \\ nil, position \\ nil, options \\ [])

View Source

Gets the Tags collection for a given resource.

Link to this function

get_usage(client, usage_plan_id, end_date, key_id \\ nil, limit \\ nil, position \\ nil, start_date, options \\ [])

View Source

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

Link to this function

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

View Source

Gets a usage plan of a given plan identifier.

Link to this function

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

View Source

Gets a usage plan key of a given key identifier.

Link to this function

get_usage_plan_keys(client, usage_plan_id, limit \\ nil, name_query \\ nil, position \\ nil, options \\ [])

View Source

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

Link to this function

get_usage_plans(client, key_id \\ nil, limit \\ nil, position \\ nil, options \\ [])

View Source

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

Link to this function

get_vpc_link(client, vpc_link_id, options \\ [])

View Source

Gets a specified VPC link under the caller's account in a region.

Link to this function

get_vpc_links(client, limit \\ nil, position \\ nil, options \\ [])

View Source

Gets the VpcLinks collection under the caller's account in a selected region.

Link to this function

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

View Source

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

Link to this function

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

View Source
Link to this function

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

View Source

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

Link to this function

put_gateway_response(client, response_type, rest_api_id, input, options \\ [])

View Source

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

Link to this function

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

View Source

Sets up a method's integration.

Link to this function

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

View Source

Represents a put integration.

Link to this function

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

View Source

Add a method to an existing Resource resource.

Link to this function

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

View Source

Adds a MethodResponse to an existing Method resource.

Link to this function

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

View Source

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.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Adds or updates a tag on a given resource.

Link to this function

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

View Source

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

See also: Use Lambda Function as Authorizer Use Cognito User Pool as Authorizer

Link to this function

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

View Source

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

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes a tag from a given resource.

Link to this function

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

View Source

Changes information about the current Account resource.

Link to this function

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

View Source

Changes information about an ApiKey resource.

Link to this function

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

View Source

Updates an existing Authorizer resource.

See also: AWS CLI

Link to this function

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

View Source

Changes information about the BasePathMapping resource.

Link to this function

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

View Source

Changes information about an ClientCertificate resource.

Link to this function

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

View Source

Changes information about a Deployment resource.

Link to this function

update_documentation_part(client, documentation_part_id, rest_api_id, input, options \\ [])

View Source
Link to this function

update_documentation_version(client, documentation_version, rest_api_id, input, options \\ [])

View Source
Link to this function

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

View Source

Changes information about the DomainName resource.

Link to this function

update_gateway_response(client, response_type, rest_api_id, input, options \\ [])

View Source

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

Link to this function

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

View Source

Represents an update integration.

Link to this function

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

View Source

Represents an update integration response.

Link to this function

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

View Source

Updates an existing Method resource.

Link to this function

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

View Source

Updates an existing MethodResponse resource.

Link to this function

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

View Source

Changes information about a model.

Link to this function

update_request_validator(client, request_validator_id, rest_api_id, input, options \\ [])

View Source

Updates a RequestValidator of a given RestApi.

Link to this function

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

View Source

Changes information about a Resource resource.

Link to this function

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

View Source

Changes information about the specified API.

Link to this function

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

View Source

Changes information about a Stage resource.

Link to this function

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

View Source

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(client, usage_plan_id, input, options \\ [])

View Source

Updates a usage plan of a given plan Id.

Link to this function

update_vpc_link(client, vpc_link_id, input, options \\ [])

View Source

Updates an existing VpcLink of a specified identifier.