imagebuilder / Waiter / ImageAvailable

ImageAvailable

class imagebuilder.Waiter.ImageAvailable
waiter = client.get_waiter('image_available')
wait(**kwargs)

Polls imagebuilder.Client.get_image() every 60 seconds until a successful state is reached. An error is raised after 360 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    imageBuildVersionArn='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters:
  • imageBuildVersionArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the image that you want to get. You can specify a full build version ARN, or a version ARN with or without wildcards ( x.x.x, 1.x.x, or 1.0.x). A version or wildcard ARN resolves to the latest matching build version that has reached AVAILABLE status. Builds that were later deprecated, disabled, or deleted don’t resolve. To get an image in any other state, such as a failed or in-progress build, specify the full build version ARN.

  • WaiterConfig (dict) –

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) –

      The amount of time in seconds to wait between attempts. Default: 60

    • MaxAttempts (integer) –

      The maximum number of attempts to be made. Default: 360

Returns:

None