Waiter

smithy.waiters.Waiter
See theWaiter companion object
case class Waiter(acceptors: List[Acceptor], minDelay: WaiterDelay, maxDelay: WaiterDelay, documentation: Option[String], deprecated: Option[Boolean], tags: Option[List[NonEmptyString]])

Defines an individual operation waiter.

Attributes

acceptors

An ordered array of acceptors to check after executing an operation.

deprecated

Indicates if the waiter is considered deprecated. A waiter SHOULD be marked as deprecated if it has been replaced by another waiter or if it is no longer needed (for example, if a resource changes from eventually consistent to strongly consistent).

documentation

Documentation about the waiter. Can use CommonMark.

maxDelay

The maximum amount of time in seconds to delay between each retry. This value defaults to 120 if not specified (or, 2 minutes). If specified, this value MUST be greater than or equal to 1.

minDelay

The minimum amount of time in seconds to delay between each retry. This value defaults to 2 if not specified. If specified, this value MUST be greater than or equal to 1 and less than or equal to maxDelay.

tags

A list of tags associated with the waiter that allow waiters to be categorized and grouped.

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product