package waiters
- Alphabetic
- By Inheritance
- waiters
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- final case class Acceptor(state: AcceptorState, matcher: Matcher) extends Product with Serializable
Represents an acceptor in a waiter's state machine.
Represents an acceptor in a waiter's state machine.
- state
The state the acceptor transitions to when matched.
- matcher
The matcher used to test if the resource is in a given state.
- sealed abstract class AcceptorState extends Value
The transition state of a waiter.
- type Acceptors = waiters.Acceptors.Type
- sealed trait Matcher extends Product with Serializable
Defines how an acceptor determines if it matches the current state of a resource.
- type NonEmptyString = waiters.NonEmptyString.Type
- type NonEmptyStringList = waiters.NonEmptyStringList.Type
- sealed abstract class PathComparator extends Value
Defines a comparison to perform in a PathMatcher.
- final case class PathMatcher(path: String, expected: String, comparator: PathComparator) extends Product with Serializable
Defines how to test the result of a JMESPath expression against an expected value.
Defines how to test the result of a JMESPath expression against an expected value.
- path
A JMESPath expression applied to the input or output of an operation.
- expected
The expected return value of the expression.
- comparator
The comparator used to compare the result of the expression with the expected value.
- type Waitable = waiters.Waitable.Type
Indicates that an operation has various named "waiters" that can be used to poll a resource until it enters a desired state.
- final case class Waiter(acceptors: List[Acceptor], minDelay: WaiterDelay = smithy.waiters.WaiterDelay(2), maxDelay: WaiterDelay = smithy.waiters.WaiterDelay(120), documentation: Option[String] = None, deprecated: Option[Boolean] = None, tags: Option[List[NonEmptyString]] = None) extends Product with Serializable
Defines an individual operation waiter.
Defines an individual operation waiter.
- acceptors
An ordered array of acceptors to check after executing an operation.
- 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.- 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.
- documentation
Documentation about the waiter. Can use CommonMark.
- 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).
- tags
A list of tags associated with the waiter that allow waiters to be categorized and grouped.
- type WaiterDelay = waiters.WaiterDelay.Type
- type WaiterName = waiters.WaiterName.Type
Value Members
- object Acceptor extends Companion[Acceptor] with Serializable
- object AcceptorState extends Enumeration[AcceptorState] with Companion[AcceptorState] with Serializable
- object Acceptors extends Newtype[List[Acceptor]]
- object Matcher extends Companion[Matcher] with Serializable
- object NonEmptyString extends Newtype[String]
- object NonEmptyStringList extends Newtype[List[NonEmptyString]]
- object PathComparator extends Enumeration[PathComparator] with Companion[PathComparator] with Serializable
- object PathMatcher extends Companion[PathMatcher] with Serializable
- object Waitable extends Newtype[Map[WaiterName, Waiter]]
Indicates that an operation has various named "waiters" that can be used to poll a resource until it enters a desired state.
- object Waiter extends Companion[Waiter] with Serializable
- object WaiterDelay extends Newtype[Int]
- object WaiterName extends Newtype[String]