PrometheusService / Waiter / WorkspaceActive

WorkspaceActive#

class PrometheusService.Waiter.WorkspaceActive#
waiter = client.get_waiter('workspace_active')
wait(**kwargs)#

Polls PrometheusService.Client.describe_workspace() every 2 seconds until a successful state is reached. An error is raised after 60 failed checks.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The ID of the workspace to describe.

  • WaiterConfig (dict) –

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) –

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

    • MaxAttempts (integer) –

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

Returns:

None