EndUserMessaging / Waiter / JobSuccess

JobSuccess

class EndUserMessaging.Waiter.JobSuccess
waiter = client.get_waiter('job_success')
wait(**kwargs)

Polls EndUserMessaging.Client.get_job() every 30 seconds until a successful state is reached. An error is raised after 5 failed checks.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.

  • WaiterConfig (dict) –

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) –

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

    • MaxAttempts (integer) –

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

Returns:

None