[ aws . lambda ]

update-alias

Description

Updates the configuration of a Lambda function alias .

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 | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--function-name (string)

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.

--name (string)

The name of the alias.

--function-version (string)

The function version that the alias invokes.

--description (string)

A description of the alias.

--routing-config (structure)

The routing configuration of the alias.

AdditionalVersionWeights -> (map)

The second version, and the percentage of traffic that’s routed to it.

key -> (string)

value -> (double)

Shorthand Syntax:

AdditionalVersionWeights={KeyName1=double,KeyName2=double}

JSON Syntax:

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

--revision-id (string)

Only update the alias if the revision ID matches the ID that’s specified. Use this option to avoid modifying an alias that has changed since you last read it.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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.

Examples

To update a function alias

The following update-alias example updates the alias named LIVE to point to version 3 of the my-function Lambda function.

aws lambda update-alias \
    --function-name my-function \
    --function-version 3 \
    --name LIVE

Output:

{
    "FunctionVersion": "3",
    "Name": "LIVE",
    "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:LIVE",
    "RevisionId": "594f41fb-b85f-4c20-95c7-6ca5f2a92c93",
    "Description": "alias for live version of function"
}

For more information, see Configuring AWS Lambda Function Aliases in the AWS Lambda Developer Guide.

Output

AliasArn -> (string)

The Amazon Resource Name (ARN) of the alias.

Name -> (string)

The name of the alias.

FunctionVersion -> (string)

The function version that the alias invokes.

Description -> (string)

A description of the alias.

RoutingConfig -> (structure)

The routing configuration of the alias.

AdditionalVersionWeights -> (map)

The second version, and the percentage of traffic that’s routed to it.

key -> (string)

value -> (double)

RevisionId -> (string)

A unique identifier that changes when you update the alias.