Matcher

smithy.waiters.Matcher
See theMatcher companion trait
object Matcher extends Companion[Matcher]

Attributes

Companion
trait
Graph
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

Members list

Type members

Classlikes

final case class ErrorTypeCase(errorType: String) extends Matcher

Matches if an operation returns an error and the error matches the expected error type. If an absolute shape ID is provided, the error is matched exactly on the shape ID. A shape name can be provided to match an error in any namespace with the given name.

Matches if an operation returns an error and the error matches the expected error type. If an absolute shape ID is provided, the error is matched exactly on the shape ID. A shape name can be provided to match an error in any namespace with the given name.

Attributes

Companion
object
Supertypes
trait Matcher
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ErrorTypeCase

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class InputOutputCase(inputOutput: PathMatcher) extends Matcher

Matches on both the input and output of an operation using a JMESPath expression. Input parameters are available through the top-level input field, and output data is available through the top-level output field. This matcher can only be used on operations that define both input and output. This matcher is checked only if an operation completes successfully.

Matches on both the input and output of an operation using a JMESPath expression. Input parameters are available through the top-level input field, and output data is available through the top-level output field. This matcher can only be used on operations that define both input and output. This matcher is checked only if an operation completes successfully.

Attributes

Companion
object
Supertypes
trait Matcher
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class OutputCase(output: PathMatcher) extends Matcher

Matches on the successful output of an operation using a JMESPath expression.

Matches on the successful output of an operation using a JMESPath expression.

Attributes

Companion
object
Supertypes
trait Matcher
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object OutputCase

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
OutputCase.type
final case class SuccessCase(success: Boolean) extends Matcher

When set to true, matches when an operation returns a successful response. When set to false, matches when an operation fails with any error.

When set to true, matches when an operation returns a successful response. When set to false, matches when an operation fails with any error.

Attributes

Companion
object
Supertypes
trait Matcher
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object SuccessCase

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object Visitor

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Visitor.type
trait Visitor[A]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Default[A]

Inherited classlikes

object hint

Attributes

Inherited from:
Companion
Supertypes
class Object
trait Matchable
class Any

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def errorType(errorType: String): Matcher

Matches if an operation returns an error and the error matches the expected error type. If an absolute shape ID is provided, the error is matched exactly on the shape ID. A shape name can be provided to match an error in any namespace with the given name.

Matches if an operation returns an error and the error matches the expected error type. If an absolute shape ID is provided, the error is matched exactly on the shape ID. A shape name can be provided to match an error in any namespace with the given name.

Attributes

def inputOutput(inputOutput: PathMatcher): Matcher

Matches on both the input and output of an operation using a JMESPath expression. Input parameters are available through the top-level input field, and output data is available through the top-level output field. This matcher can only be used on operations that define both input and output. This matcher is checked only if an operation completes successfully.

Matches on both the input and output of an operation using a JMESPath expression. Input parameters are available through the top-level input field, and output data is available through the top-level output field. This matcher can only be used on operations that define both input and output. This matcher is checked only if an operation completes successfully.

Attributes

def output(output: PathMatcher): Matcher

Matches on the successful output of an operation using a JMESPath expression.

Matches on the successful output of an operation using a JMESPath expression.

Attributes

def success(success: Boolean): Matcher

When set to true, matches when an operation returns a successful response. When set to false, matches when an operation fails with any error.

When set to true, matches when an operation returns a successful response. When set to false, matches when an operation fails with any error.

Attributes

Inherited methods

final override def getTag: ShapeTag[A]

Attributes

Definition Classes
Inherited from:
Companion

Concrete fields

val hints: Hints
val id: ShapeId

Implicits

Implicits

implicit val schema: Schema[Matcher]

Inherited implicits

implicit val tagInstance: ShapeTag[Matcher]

Attributes

Inherited from:
Companion