Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AWS Lambda Aliases API

Create named pointers to function versions with routing configuration

AWS Lambda Aliases API is one of 12 APIs that AWS Lambda publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Aliases. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, a JSON-LD context, an API reference, pricing, and 1 JSON Schema.

This API exposes 5 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 2015-03-31.

Requests are made against a single base URL, https://lambda.{region}.amazonaws.com.

5 operations 2 paths 6 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2015-03-31
Base URL
https://lambda.{region}.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

AWS Lambda Aliases API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (sigv4). By default, every request must be authenticated.

  • sigv4 — AWS Signature Version 4 authentication. Requests must be signed with valid AWS credentials that have the appropriate Lambda IAM permissions.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Aliases 5

Create named pointers to function versions with routing configuration

GET
/2015-03-31/functions/{FunctionName}/aliases
Aws Lambda List Aliases
listAliases 4 params → 200404
POST
/2015-03-31/functions/{FunctionName}/aliases
Aws Lambda Create an Alias
createAlias 1 param body → 201404409
GET
/2015-03-31/functions/{FunctionName}/aliases/{AliasName}
Aws Lambda Get an Alias
getAlias 2 params → 200404
PUT
/2015-03-31/functions/{FunctionName}/aliases/{AliasName}
Aws Lambda Update an Alias
updateAlias 2 params body → 200404409
DELETE
/2015-03-31/functions/{FunctionName}/aliases/{AliasName}
Aws Lambda Delete an Alias
deleteAlias 2 params → 204404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are AliasConfiguration (6 properties), UpdateAliasRequest (4 properties), CreateAliasRequest (4 properties), ErrorResponse (3 properties). Each schema is shown below with its type and property counts.

CreateAliasRequest
object
Request body for creating a function alias
4 properties 2 required
AliasConfiguration
object
Configuration of a Lambda function alias
6 properties
UpdateAliasRequest
object
Request body for updating a function alias
4 properties
AliasRoutingConfiguration
object
The traffic-shifting configuration of a Lambda function alias. Used for weighted alias routing to enable canary deployments.
1 property
ErrorResponse
object
Error response from the Lambda API
3 properties
ListAliasesResponse
object
Paginated list of aliases
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aws-lambda-aliases-api-openapi.yml Raw ↑

Other APIs AWS Lambda publishes across the network.

AWS Lambda Extensions API
AWS Lambda Telemetry API
AWS Lambda Runtime API
AWS Lambda Logs API
AWS Lambda Concurrency API
AWS Lambda Event Source Mappings API
AWS Lambda Function URL API
AWS Lambda Functions API
AWS Lambda Layers API
AWS Lambda Tags API
AWS Lambda Versions API