ListAliasesCommand

Suggest an Edit

Returns a list of aliases  for a Lambda function.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { LambdaClient, ListAliasesCommand } from "@aws-sdk/client-lambda"; // ES Modules import
// const { LambdaClient, ListAliasesCommand } = require("@aws-sdk/client-lambda"); // CommonJS import
const client = new LambdaClient(config);
const input = { // ListAliasesRequest
  FunctionName: "STRING_VALUE", // required
  FunctionVersion: "STRING_VALUE",
  Marker: "STRING_VALUE",
  MaxItems: Number("int"),
};
const command = new ListAliasesCommand(input);
const response = await client.send(command);
// { // ListAliasesResponse
//   NextMarker: "STRING_VALUE",
//   Aliases: [ // AliasList
//     { // AliasConfiguration
//       AliasArn: "STRING_VALUE",
//       Name: "STRING_VALUE",
//       FunctionVersion: "STRING_VALUE",
//       Description: "STRING_VALUE",
//       RoutingConfig: { // AliasRoutingConfiguration
//         AdditionalVersionWeights: { // AdditionalVersionWeights
//           "<keys>": Number("double"),
//         },
//       },
//       RevisionId: "STRING_VALUE",
//     },
//   ],
// };

Example Usage

// The following example returns a list of aliases for a function named my-function.
const input = {
"FunctionName": "my-function"
};
const command = new ListAliasesCommand(input);
const response = await client.send(command);
/* response ==
{
"Aliases": [
{
"AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:BETA",
"Description": "Production environment BLUE.",
"FunctionVersion": "2",
"Name": "BLUE",
"RevisionId": "a410117f-xmpl-494e-8035-7e204bb7933b",
"RoutingConfig": {
"AdditionalVersionWeights": {
"1": 0.7
}
}
},
{
"AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:LIVE",
"Description": "Production environment GREEN.",
"FunctionVersion": "1",
"Name": "GREEN",
"RevisionId": "21d40116-xmpl-40ba-9360-3ea284da1bb5"
}
]
}
*\/
// example id: to-list-a-functions-aliases-1481650199732
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
JavaScriptLn 1, Col 1
Errors: 0 Warnings: 0

ListAliasesCommand Input

See ListAliasesCommandInput for more details

Parameter
Type
Description
FunctionName
Required
string | undefined

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.

FunctionVersion
string | undefined

Specify a function version to only list aliases that invoke that version.

Marker
string | undefined

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

MaxItems
number | undefined

Limit the number of aliases returned.

ListAliasesCommand Output

See ListAliasesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Aliases
AliasConfiguration[] | undefined

A list of aliases.

NextMarker
string | undefined

The pagination token that's included if more results are available.

Throws

Name
Fault
Details
InvalidParameterValueException
client

One of the parameters in the request is not valid.

ResourceNotFoundException
client

The resource specified in the request does not exist.

ServiceException
server

The Lambda service encountered an internal error.

TooManyRequestsException
client

The request throughput limit was exceeded. For more information, see Lambda quotas .

LambdaServiceException
Base exception class for all service exceptions from Lambda service.