smithy.waiters
Members list
Type members
Classlikes
Represents an acceptor in a waiter's state machine.
The transition state of a waiter.
The transition state of a waiter.
Attributes
- 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.
- Companion:
- object
- Graph
- Supertypes
- Known subtypes
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Sumtrait Mirrortrait Enumeration[AcceptorState]trait Companion[AcceptorState]trait Has[AcceptorState]trait ShapeTag[AcceptorState]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- AcceptorState.type
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
- Graph
- Supertypes
- Known subtypes
Attributes
- Graph
- Supertypes
- Self type
- NonEmptyString.type
Attributes
- Graph
- Supertypes
- Self type
- NonEmptyStringList.type
Defines a comparison to perform in a PathMatcher.
Defines a comparison to perform in a PathMatcher.
Attributes
- 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.
- Companion:
- object
- Graph
- Supertypes
- Known subtypes
- object ALL_STRING_EQUALS.typeobject ANY_STRING_EQUALS.typeobject BOOLEAN_EQUALS.typeobject STRING_EQUALS.type
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Sumtrait Mirrortrait Enumeration[PathComparator]trait Companion[PathComparator]trait Has[PathComparator]trait ShapeTag[PathComparator]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- PathComparator.type
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.
Attributes
- 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.
- Companion:
- object
- Graph
- Supertypes
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[PathMatcher]trait Has[PathMatcher]trait ShapeTag[PathMatcher]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- PathMatcher.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.
Attributes
- value
Defines an individual operation waiter.
- Graph
- Supertypes
- Self type
- Waitable.type
Defines an individual operation waiter.
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
Attributes
- Graph
- Supertypes
- Self type
- WaiterDelay.type
Attributes
- Graph
- Supertypes
- Self type
- WaiterName.type
Types
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.
Attributes
- value
Defines an individual operation waiter.