Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . lambda ]

update-alias

Description

Using this API you can update the function version to which the alias points and the alias description. For more information, see Introduction to AWS Lambda Aliases .

This requires permission for the lambda:UpdateAlias action.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-alias
--function-name <value>
--name <value>
[--function-version <value>]
[--description <value>]
[--routing-config <value>]
[--revision-id <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--function-name (string)

The function name for which the alias is created. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

--name (string)

The alias name.

--function-version (string)

Using this parameter you can change the Lambda function version to which the alias points.

--description (string)

You can change the description of the alias using this parameter.

--routing-config (structure)

Specifies an additional version your alias can point to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see lambda-traffic-shifting-using-aliases .

Shorthand Syntax:

AdditionalVersionWeights={KeyName1=double,KeyName2=double}

JSON Syntax:

{
  "AdditionalVersionWeights": {"string": double
    ...}
}

--revision-id (string)

An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID you pass doesn't match the latest RevisionId of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID using either or .

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

AliasArn -> (string)

Lambda function ARN that is qualified using the alias name as the suffix. For example, if you create an alias called BETA that points to a helloworld function version, the ARN is arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA .

Name -> (string)

name name.

FunctionVersion -> (string)

Function version to which the alias points.

Description -> (string)

name description.

RoutingConfig -> (structure)

Specifies an additional function versions the alias points to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see lambda-traffic-shifting-using-aliases .

AdditionalVersionWeights -> (map)

Set this value to dictate what percentage of traffic will invoke the updated function version. If set to an empty string, 100 percent of traffic will invoke function-version . For more information, see lambda-traffic-shifting-using-aliases .

key -> (string)

value -> (double)

RevisionId -> (string)

Represents the latest updated revision of the function or alias.