core
API
Generated with
core/smithy/smithy.waiters

smithy.waiters

package smithy.waiters

Members list

Type members

Classlikes

final case class Acceptor(state: AcceptorState, matcher: Matcher)

Represents an acceptor in a waiter's state machine.

Represents an acceptor in a waiter's state machine.

Value parameters

matcher

The matcher used to test if the resource is in a given state.

state

The state the acceptor transitions to when matched.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Acceptor extends Companion[Acceptor]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[Acceptor]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Acceptor.type
sealed abstract class AcceptorState(_value: String, _name: String, _intValue: Int, _hints: Hints) extends Value

The transition state of a waiter.

The transition state of a waiter.

Value parameters

FAILURE

The waiter failed to enter into the desired state. This is a terminal state that causes the waiter to stop.

RETRY

The waiter will retry the operation. This state transition is implicit if no accepter causes a state transition.

SUCCESS

The waiter successfully finished waiting. This is a terminal state that causes the waiter to stop.

Attributes

Companion
object
Supertypes
class Value
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object FAILURE.type
object RETRY.type
object SUCCESS.type
object AcceptorState extends Enumeration[AcceptorState], Companion[AcceptorState]

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
object Acceptors extends Newtype[List[Acceptor]]

Value parameters

member

Represents an acceptor in a waiter's state machine.

Attributes

Supertypes
trait HasId
class Object
trait Matchable
class Any
Self type
Acceptors.type
sealed trait Matcher extends Product, Serializable

Defines how an acceptor determines if it matches the current state of a resource.

Defines how an acceptor determines if it matches the current state of a resource.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class OutputCase
class SuccessCase
Self type
object Matcher extends Companion[Matcher]

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait Has[Matcher]
trait ShapeTag[Matcher]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Matcher.type
object NonEmptyString extends Newtype[String]

Attributes

Supertypes
class Newtype[String]
trait HasId
class Object
trait Matchable
class Any
Self type
object NonEmptyStringList extends Newtype[List[NonEmptyString]]

Attributes

Supertypes
trait HasId
class Object
trait Matchable
class Any
Self type
sealed abstract class PathComparator(_value: String, _name: String, _intValue: Int, _hints: Hints) extends Value

Defines a comparison to perform in a PathMatcher.

Defines a comparison to perform in a PathMatcher.

Value parameters

ALL_STRING_EQUALS

Matches if all values in the list matches the expected string.

ANY_STRING_EQUALS

Matches if any value in the list matches the expected string.

BOOLEAN_EQUALS

Matches if the return value is a boolean that is equal to the string literal 'true' or 'false'.

STRING_EQUALS

Matches if the return value is a string that is equal to the expected string.

Attributes

Companion
object
Supertypes
class Value
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object ALL_STRING_EQUALS.type
object ANY_STRING_EQUALS.type
object BOOLEAN_EQUALS.type
object STRING_EQUALS.type
object PathComparator extends Enumeration[PathComparator], Companion[PathComparator]

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
final case class PathMatcher(path: String, expected: String, comparator: PathComparator)

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.

Value parameters

comparator

The comparator used to compare the result of the expression with the expected value.

expected

The expected return value of the expression.

path

A JMESPath expression applied to the input or output of an operation.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PathMatcher extends Companion[PathMatcher]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[PathMatcher]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
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.

Indicates that an operation has various named "waiters" that can be used to poll a resource until it enters a desired state.

Value parameters

value

Defines an individual operation waiter.

Attributes

Supertypes
trait HasId
class Object
trait Matchable
class Any
Self type
Waitable.type
final 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.

Defines an individual operation waiter.

Value parameters

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Waiter extends Companion[Waiter]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[Waiter]
trait Has[Waiter]
trait ShapeTag[Waiter]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Waiter.type
object WaiterDelay extends Newtype[Int]

Attributes

Supertypes
class Newtype[Int]
trait HasId
class Object
trait Matchable
class Any
Self type
object WaiterName extends Newtype[String]

Attributes

Supertypes
class Newtype[String]
trait HasId
class Object
trait Matchable
class Any
Self type
WaiterName.type

Types

type Acceptors = Type

Value parameters

member

Represents an acceptor in a waiter's state machine.

Attributes

type Waitable = Type

Indicates that an operation has various named "waiters" that can be used to poll a resource until it enters a desired state.

Indicates that an operation has various named "waiters" that can be used to poll a resource until it enters a desired state.

Value parameters

value

Defines an individual operation waiter.

Attributes

type WaiterDelay = Type
type WaiterName = Type
Generated with