Skip to content

API_ListAliases.md

Latest commit

 

History

History
110 lines (83 loc) · 5.06 KB

API_ListAliases.md

File metadata and controls

110 lines (83 loc) · 5.06 KB

ListAliases

Returns a list of aliases for a Lambda function.

Request Syntax

GET /2015-03-31/functions/FunctionName/aliases?FunctionVersion=FunctionVersion&Marker=Marker&MaxItems=MaxItems HTTP/1.1

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-_]+))?

** FunctionVersion ** Specify a function version to only list aliases that invoke that version.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: (\$LATEST|[0-9]+)

** Marker ** Specify the pagination token that's returned by a previous request to retrieve the next page of results.

** MaxItems ** Limit the number of aliases returned.
Valid Range: Minimum value of 1. Maximum value of 10000.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "[Aliases](#SSS-ListAliases-response-Aliases)": [ 
      { 
         "[AliasArn](API_AliasConfiguration.md#SSS-Type-AliasConfiguration-AliasArn)": "string",
         "[Description](API_AliasConfiguration.md#SSS-Type-AliasConfiguration-Description)": "string",
         "[FunctionVersion](API_AliasConfiguration.md#SSS-Type-AliasConfiguration-FunctionVersion)": "string",
         "[Name](API_AliasConfiguration.md#SSS-Type-AliasConfiguration-Name)": "string",
         "[RevisionId](API_AliasConfiguration.md#SSS-Type-AliasConfiguration-RevisionId)": "string",
         "[RoutingConfig](API_AliasConfiguration.md#SSS-Type-AliasConfiguration-RoutingConfig)": { 
            "[AdditionalVersionWeights](API_AliasRoutingConfiguration.md#SSS-Type-AliasRoutingConfiguration-AdditionalVersionWeights)": { 
               "string" : number 
            }
         }
      }
   ],
   "[NextMarker](#SSS-ListAliases-response-NextMarker)": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

** Aliases ** A list of aliases.
Type: Array of AliasConfiguration objects

** NextMarker ** The pagination token that's included if more results are available.
Type: String

Errors

InvalidParameterValueException
One of the parameters in the request is invalid.
HTTP Status Code: 400

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.
HTTP Status Code: 429

See Also

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