get-provisioned-concurrency-config¶

Description¶

Retrieves the provisioned concurrency configuration for a function’s alias or version.

Synopsis¶

  get-provisioned-concurrency-config
--function-name <value>
--qualifier <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 - my-function .

Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function .

Partial ARN - 123456789012:function:my-function .

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

--qualifier (string)

The version number or alias name.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To view a provisioned concurrency configuration

The following get-provisioned-concurrency-config example displays details for the provisioned concurrency configuration for the BLUE alias of the specified function.

aws lambda get-provisioned-concurrency-config \
    --function-name my-function \
    --qualifier BLUE

Output:

{
    "RequestedProvisionedConcurrentExecutions": 100,
    "AvailableProvisionedConcurrentExecutions": 100,
    "AllocatedProvisionedConcurrentExecutions": 100,
    "Status": "READY",
    "LastModified": "2019-12-31T20:28:49+0000"
}

Output¶

RequestedProvisionedConcurrentExecutions -> (integer)

The amount of provisioned concurrency requested.

AvailableProvisionedConcurrentExecutions -> (integer)

The amount of provisioned concurrency available.

AllocatedProvisionedConcurrentExecutions -> (integer)

The amount of provisioned concurrency allocated.

Status -> (string)

The status of the allocation process.

StatusReason -> (string)

For failed allocations, the reason that provisioned concurrency could not be allocated.

LastModified -> (string)

The date and time that a user last updated the configuration, in ISO 8601 format .

Table of Contents

Feedback

User Guide