FunctionActive - Boto3 1.38.13 documentation (original) (raw)

Back to top

Toggle table of contents sidebar

Lambda / Waiter / FunctionActive

class Lambda.Waiter.FunctionActive¶

waiter = client.get_waiter('function_active')

wait(**kwargs)¶

Polls Lambda.Client.get_function_configuration() every 5 seconds until a successful state is reached. An error is raised after 60 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait( FunctionName='string', Qualifier='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } )

Parameters:

• FunctionName (string) –
  [REQUIRED]
  The name or ARN of the Lambda function, version, or alias.

Name formats

• Function name – my-function (name-only), my-function:v1 (with alias).
• Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
• Partial ARN – 123456789012:function:my-function.
  You can append a version number or alias to any of the formats. 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) – Specify a version or alias to get details about a published version of the function.
• WaiterConfig (dict) –
  A dictionary that provides parameters to control waiting behavior.
  • Delay (integer) –
    The amount of time in seconds to wait between attempts. Default: 5
  • MaxAttempts (integer) –
    The maximum number of attempts to be made. Default: 60

Returns:

None