Lambda / Client / get_alias

get_alias#

Lambda.Client.get_alias(**kwargs)#

Returns details about a Lambda function alias.

See also: AWS API Documentation

Request Syntax

response = client.get_alias(
    FunctionName='string',
    Name='string'
)
Parameters:

  • FunctionName (string) –

    [REQUIRED]

    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.

  • Name (string) –

    [REQUIRED]

    The name of the alias.

Return type:

dict

Returns:

Response Syntax

{
    'AliasArn': 'string',
    'Name': 'string',
    'FunctionVersion': 'string',
    'Description': 'string',
    'RoutingConfig': {
        'AdditionalVersionWeights': {
            'string': 123.0
        }
    },
    'RevisionId': 'string'
}

Response Structure

  • (dict) –

    Provides configuration information about a Lambda function alias.

    • 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 (dict) –

      The routing configuration of the alias.

      • AdditionalVersionWeights (dict) –

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

        • (string) –

          • (float) –

    • RevisionId (string) –

      A unique identifier that changes when you update the alias.

Exceptions

Examples

The following example returns details about an alias named BLUE for a function named my-function

response = client.get_alias(
    FunctionName='my-function',
    Name='BLUE',
)

print(response)

Expected Output:

{
    'AliasArn': 'arn:aws:lambda:us-west-2:123456789012:function:my-function:BLUE',
    'Description': 'Production environment BLUE.',
    'FunctionVersion': '3',
    'Name': 'BLUE',
    'RevisionId': '594f41fb-xmpl-4c20-95c7-6ca5f2a92c93',
    'ResponseMetadata': {
        '...': '...',
    },
}