| CARVIEW |
CreateAlias
Creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version.
You can also map an alias to split invocation requests between two versions. Use the
RoutingConfig parameter to specify a second version and the percentage of invocation requests that
it receives.
Request Syntax
POST /2015-03-31/functions/FunctionName/aliases HTTP/1.1
Content-type: application/json
{
"Description": "string",
"FunctionVersion": "string",
"Name": "string",
"RoutingConfig": {
"AdditionalVersionWeights": {
"string" : number
}
}
}URI Request Parameters
The request uses the following URI parameters.
- FunctionName
-
The name or ARN of the Lambda function.
Name formats
-
Function name -
MyFunction. -
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:MyFunction. -
Partial ARN -
123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
Length Constraints: Minimum length of 1. Maximum length of 140.
Pattern:
(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?Required: Yes
-
Request Body
The request accepts the following data in JSON format.
- Description
-
A description of the alias.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
- FunctionVersion
-
The function version that the alias invokes.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
(\$LATEST|[0-9]+)Required: Yes
- Name
-
The name of the alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
(?!^[0-9]+$)([a-zA-Z0-9-_]+)Required: Yes
- RoutingConfig
-
The routing configuration of the alias.
Type: AliasRoutingConfiguration object
Required: No
Response Syntax
HTTP/1.1 201
Content-type: application/json
{
"AliasArn": "string",
"Description": "string",
"FunctionVersion": "string",
"Name": "string",
"RevisionId": "string",
"RoutingConfig": {
"AdditionalVersionWeights": {
"string" : number
}
}
}Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
- AliasArn
-
The Amazon Resource Name (ARN) of the alias.
Type: String
Pattern:
arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))? - Description
-
A description of the alias.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
- FunctionVersion
-
The function version that the alias invokes.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
(\$LATEST|[0-9]+) - Name
-
The name of the alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
(?!^[0-9]+$)([a-zA-Z0-9-_]+) - RevisionId
-
A unique identifier that changes when you update the alias.
Type: String
- RoutingConfig
-
The routing configuration of the alias.
Type: AliasRoutingConfiguration object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterValueException
-
One of the parameters in the request is not valid.
HTTP Status Code: 400
- ResourceConflictException
-
The resource already exists, or another operation is in progress.
HTTP Status Code: 409
- ResourceNotFoundException
-
The resource specified in the request does not exist.
HTTP Status Code: 404
- ServiceException
-
The AWS Lambda service encountered an internal error.
HTTP Status Code: 500
- TooManyRequestsException
-
The request throughput limit was exceeded. For more information, see Lambda quotas.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
Thanks for letting us know we're doing a good job!
If you've got a moment, please tell us what we did right so we can do more of it.
Thanks for letting us know this page needs work. We're sorry we let you down.
If you've got a moment, please tell us how we can make the documentation better.