Lambda / Client / list_provisioned_concurrency_configs

list_provisioned_concurrency_configs

Lambda.Client.list_provisioned_concurrency_configs(**kwargs)

Retrieves a list of provisioned concurrency configurations for a function.

See also: AWS API Documentation

Request Syntax

response = client.list_provisioned_concurrency_configs(
    FunctionName='string',
    Marker='string',
    MaxItems=123
)

Parameters:

• FunctionName (string) –

  [REQUIRED]

  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.

• Marker (string) – Specify the pagination token that’s returned by a previous request to retrieve the next page of results.

• MaxItems (integer) – Specify a number to limit the number of configurations returned.

Return type:

dict

Returns:

Response Syntax

{
    'ProvisionedConcurrencyConfigs': [
        {
            'FunctionArn': 'string',
            'RequestedProvisionedConcurrentExecutions': 123,
            'AvailableProvisionedConcurrentExecutions': 123,
            'AllocatedProvisionedConcurrentExecutions': 123,
            'Status': 'IN_PROGRESS'|'READY'|'FAILED',
            'StatusReason': 'string',
            'LastModified': 'string'
        },
    ],
    'NextMarker': 'string'
}

Response Structure

• (dict) –

  • ProvisionedConcurrencyConfigs (list) –

    A list of provisioned concurrency configurations.

    • (dict) –

      Details about the provisioned concurrency configuration for a function alias or version.

      • FunctionArn (string) –

        The Amazon Resource Name (ARN) of the alias or version.

      • RequestedProvisionedConcurrentExecutions (integer) –

        The amount of provisioned concurrency requested.

      • AvailableProvisionedConcurrentExecutions (integer) –

        The amount of provisioned concurrency available.

      • AllocatedProvisionedConcurrentExecutions (integer) –

        The amount of provisioned concurrency allocated. When a weighted alias is used during linear and canary deployments, this value fluctuates depending on the amount of concurrency that is provisioned for the function versions.

      • 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.

  • NextMarker (string) –

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

Exceptions

• Lambda.Client.exceptions.InvalidParameterValueException

• Lambda.Client.exceptions.ResourceNotFoundException

• Lambda.Client.exceptions.TooManyRequestsException

• Lambda.Client.exceptions.ServiceException

Examples

The following example returns a list of provisioned concurrency configurations for a function named my-function.

response = client.list_provisioned_concurrency_configs(
    FunctionName='my-function',
)

print(response)

Expected Output:

{
    'ProvisionedConcurrencyConfigs': [
        {
            'AllocatedProvisionedConcurrentExecutions': 100,
            'AvailableProvisionedConcurrentExecutions': 100,
            'FunctionArn': 'arn:aws:lambda:us-east-2:123456789012:function:my-function:GREEN',
            'LastModified': '2019-12-31T20:29:00+0000',
            'RequestedProvisionedConcurrentExecutions': 100,
            'Status': 'READY',
        },
        {
            'AllocatedProvisionedConcurrentExecutions': 100,
            'AvailableProvisionedConcurrentExecutions': 100,
            'FunctionArn': 'arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE',
            'LastModified': '2019-12-31T20:28:49+0000',
            'RequestedProvisionedConcurrentExecutions': 100,
            'Status': 'READY',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}