Skip to content

API_CreateAlias.md

Latest commit

 

History

History
159 lines (124 loc) · 7.4 KB

API_CreateAlias.md

File metadata and controls

159 lines (124 loc) · 7.4 KB

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](#SSS-CreateAlias-request-Description)": "string",
   "[FunctionVersion](#SSS-CreateAlias-request-FunctionVersion)": "string",
   "[Name](#SSS-CreateAlias-request-Name)": "string",
   "[RoutingConfig](#SSS-CreateAlias-request-RoutingConfig)": { 
      "[AdditionalVersionWeights](API_AliasRoutingConfiguration.md#SSS-Type-AliasRoutingConfiguration-AdditionalVersionWeights)": { 
         "string" : number 
      }
   }
}

URI Request Parameters

The request requires the following URI parameters.

** FunctionName ** The name 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-_]+))?

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](#SSS-CreateAlias-response-AliasArn)": "string",
   "[Description](#SSS-CreateAlias-response-Description)": "string",
   "[FunctionVersion](#SSS-CreateAlias-response-FunctionVersion)": "string",
   "[Name](#SSS-CreateAlias-response-Name)": "string",
   "[RevisionId](#SSS-CreateAlias-response-RevisionId)": "string",
   "[RoutingConfig](#SSS-CreateAlias-response-RoutingConfig)": { 
      "[AdditionalVersionWeights](API_AliasRoutingConfiguration.md#SSS-Type-AliasRoutingConfiguration-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

InvalidParameterValueException
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
HTTP Status Code: 400

ResourceConflictException
The resource already exists.
HTTP Status Code: 409

ResourceNotFoundException
The resource (for example, a Lambda function or access policy statement) 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
Request throughput limit exceeded.
HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: