core
core
API
smithy4s
capability
Contravariant
Contravariant
Covariant
Covariant
PartiallyAppliedLiftK
EncoderK
EncoderK
Invariant
Invariant
MonadThrowLike
MonadThrowLike
Zipper
Zipper
client
UnaryClientCodecs
UnaryClientCodecs
UnaryClientCompiler
UnaryClientEndpoint
UnaryLowLevelClient
codecs
BlobDecoder
BlobEncoder
PayloadError
PayloadError
PayloadPath
PayloadPath
Segment
Index
Label
Segment
PayloadReader
PayloadWriter
Reader
Reader
PartiallyAppliedReaderBuilder
PartiallyAppliedReaderBuilderF
StringAndBlobCodecs
readers
writers
Writer
Writer
PartiallyAppliedWriterBuilder
http
internals
HttpResponseCodeSchemaVisitor
HttpResponseCodeSchemaVisitor
NoResponseCode
OptionalResponseCode
RequiredResponseCode
ResponseCodeExtractor
MetaEncode
MetaEncode
EmptyMetaEncode
StringListMapMetaEncode
StringListMetaEncode
StringMapMetaEncode
StringValueMetaEncode
StructureMetaEncode
PathEncode
PathEncode
SchemaVisitorHeaderMerge
SchemaVisitorHeaderSplit
SchemaVisitorMetadataWriter
SchemaVisitorPathEncoder
CaseInsensitive
CaseInsensitive
HttpBinding
HttpBinding
HeaderBinding
HeaderBinding
HeaderPrefixBinding
HeaderPrefixBinding
PathBinding
PathBinding
QueryBinding
QueryBinding
QueryParamsBinding
StatusCodeBinding
Type
HeaderType
PathType
QueryType
StatusCodeType
Type
HttpContractError
HttpContractError
HttpDiscriminator
HttpDiscriminator
FullId
NameOnly
StatusCode
Undetermined
HttpEndpoint
HttpEndpoint
HttpEndpointError
HttpErrorSelector
HttpMediaType
HttpMediaTyped
HttpMediaTyped
HttpMethod
HttpMethod
DELETE
GET
OTHER
PATCH
POST
PUT
HttpPayloadError
HttpPayloadError
HttpRequest
HttpRequest
Decoder
HttpResponse
HttpResponse
HttpRestSchema
HttpRestSchema
Empty
MetadataAndBody
OnlyBody
OnlyMetadata
HttpStatusCode
HttpStatusCode
HttpUnaryClientCodecs
Builder
HttpUnaryServerCodecs
Builder
HttpUnaryServerRouter
HttpUri
HttpUriScheme
HttpUriScheme
Http
Https
Metadata
Metadata
Access
Decoder
Decoder
Encoder
Encoder
MetadataError
MetadataError
ArityError
ArityError
FailedConstraint
FailedConstraint
ImpossibleDecoding
ImpossibleDecoding
NotFound
NotFound
WrongType
WrongType
PathSegment
PathSegment
GreedySegment
LabelSegment
StaticSegment
UnknownErrorResponse
matchPath
internals
DiscriminatedUnionMember
DiscriminatedUnionMember
DocumentDecoder
DocumentDecoder
DocumentDecoderSchemaVisitor
FlexibleNumber
KeyValueObj
DocumentEncoder
DocumentEncoder
DocumentEncoderSchemaVisitor
DocumentKeyDecoder
DocumentKeyDecoder
DecodeError
FlexibleNumber
DocumentKeyEncoder
DocumentKeyEncoder
InputOutput
InputOutput
Input
Output
SchemaDescription
StructurePatternRefinementProvider
maps
kinds
FunctorK
FunctorK
FunctorK2
FunctorK2
FunctorK5
FunctorK5
Kind1
Kind2
Kind5
PolyFunction
PolyFunction
PolyFunction2
PolyFunction2
PolyFunction5
PolyFunction5
PolyFunctions
stubs
toPolyFunction5
optics
Lens
Lens
Optional
Prism
Prism
schema
Alt
Alt
Dispatcher
Dispatcher
Precompiler
CachedSchemaCompiler
CachedSchemaCompiler
DerivingImpl
Impl
Optional
Impl
Uncached
CollectionTag
CollectionTag
IndexedSeqTag
ListTag
SetTag
VectorTag
CompilationCache
CompilationCache
EnumTag
EnumTag
ClosedIntEnum
ClosedStringEnum
IntEnum
OpenIntEnum
OpenStringEnum
StringEnum
EnumValue
Field
Field
PartiallyAppliedStruct
PartiallyAppliedTuple
PartiallyAppliedUnion
Primitive
Primitive
PBigDecimal
PBigInt
PBlob
PBoolean
PByte
PDocument
PDouble
PFloat
PInt
PLong
PShort
PString
PTimestamp
PUUID
Schema
Schema
BijectionSchema
CollectionSchema
EnumerationSchema
LazySchema
MapSchema
OptionSchema
PrimitiveSchema
RefinementSchema
StructSchema
UnionSchema
SchemaPartition
SchemaPartition
NoMatch
SplittingMatch
TotalMatch
SchemaVisitor
SchemaVisitor
Cached
Default
Optional
server
UnaryServerCodecs
UnaryServerCodecs
UnaryServerEndpoint
Bijection
Bijection
Blob
Blob
Decoder
Encoder
ConstraintError
Document
Document
DArray
DBoolean
DNull
DNumber
DObject
DString
Decoder
Decoder
Encoder
Encoder
Endpoint
Error
Endpoint
Base
Builder
Builder
Middleware
Simple
Middleware
Enumeration
Enumeration
Value
Value
Errorable
Errorable
HasId
HintMask
HintMask
Hints
Hints
Binding
DynamicBinding
StaticBinding
Binding
Lazy
Lazy
Newtype
hint
Newtype
NumericCompat
PartialData
PartialData
Partial
Total
Protocol
Refinement
Refinement
PartiallyApplyRefinementProvider
RefinementProvider
RefinementProvider
Service
Service
Builder
Builder
Mixin
Reflective
ServiceProduct
ServiceProduct
Mirror
Mirror
ShapeId
ShapeId
Member
ShapeTag
ShapeTag
Companion
hint
Has
StreamingSchema
StreamingSchema
NoStream
Streamed
Surjection
Surjection
Timestamp
Timestamp
Transformation
Transformation
AbsorbError
PartiallyApplied
SurfaceError
UnsupportedProtocolError
smithy
api
AddedDefault
AddedDefault
Auth
AuthDefinition
AuthDefinition
AuthTraitReference
Box
Box
ClientOptional
ClientOptional
Cors
Cors
Default
Deprecated
Deprecated
Documentation
Endpoint
Endpoint
Enum
EnumConstantBodyName
EnumDefinition
EnumDefinition
EnumValue
Error
Error
CLIENT
SERVER
EventHeader
EventHeader
EventPayload
EventPayload
Example
Example
ExampleError
ExampleError
Examples
ExternalDocumentation
HostLabel
HostLabel
Http
Http
HttpApiKeyAuth
HttpApiKeyAuth
HttpApiKeyLocations
HttpApiKeyLocations
HEADER
QUERY
HttpBasicAuth
HttpBasicAuth
HttpBearerAuth
HttpBearerAuth
HttpChecksumRequired
HttpChecksumRequired
HttpDigestAuth
HttpDigestAuth
HttpError
HttpHeader
HttpLabel
HttpLabel
HttpPayload
HttpPayload
HttpPrefixHeaders
HttpQuery
HttpQueryParams
HttpQueryParams
HttpResponseCode
HttpResponseCode
IdRef
IdRef
IdempotencyToken
IdempotencyToken
Idempotent
Idempotent
Input
Input
Internal
Internal
JsonName
Length
Length
LocalMixinTrait
LocalMixinTraitList
MediaType
Mixin
Mixin
NestedProperties
NestedProperties
NoReplace
NoReplace
NonEmptyString
NonEmptyStringList
NonEmptyStringMap
NotProperty
NotProperty
OptionalAuth
OptionalAuth
Output
Output
Paginated
Paginated
Pattern
PrimitiveShort
Private
Private
Property
Property
ProtocolDefinition
ProtocolDefinition
Range
Range
Readonly
Readonly
Recommended
Recommended
Reference
Reference
References
RequestCompression
RequestCompression
RequestCompressionEncodingsList
Required
Required
RequiresLength
RequiresLength
ResourceIdentifier
Retryable
Retryable
Sensitive
Sensitive
Since
Sparse
Sparse
Streaming
Streaming
StructurallyExclusive
StructurallyExclusive
MEMBER
TARGET
Suppress
Tags
TimestampFormat
TimestampFormat
DATE_TIME
EPOCH_SECONDS
HTTP_DATE
Title
Trait
Trait
TraitChangeSeverity
TraitChangeSeverity
DANGER
ERROR
NOTE
WARNING
TraitChangeType
TraitChangeType
ADD
ANY
PRESENCE
REMOVE
UPDATE
TraitDiffRule
TraitDiffRule
TraitDiffRules
TraitShapeId
TraitShapeIdList
UniqueItems
UniqueItems
Unit
Unit
UnitType
UnitType
Unstable
Unstable
XmlAttribute
XmlAttribute
XmlFlattened
XmlFlattened
XmlName
XmlNamespace
XmlNamespace
waiters
Acceptor
Acceptor
AcceptorState
AcceptorState
FAILURE
RETRY
SUCCESS
Acceptors
Matcher
project
Matcher
ErrorTypeCase
ErrorTypeCase
InputOutputCase
InputOutputCase
OutputCase
OutputCase
SuccessCase
SuccessCase
Visitor
Default
Visitor
NonEmptyString
NonEmptyStringList
PathComparator
PathComparator
ALL_STRING_EQUALS
ANY_STRING_EQUALS
BOOLEAN_EQUALS
STRING_EQUALS
PathMatcher
PathMatcher
Waitable
Waiter
Waiter
WaiterDelay
WaiterName
alloy
common
CountryCodeFormat
CountryCodeFormat
EmailFormat
EmailFormat
HexColorCodeFormat
HexColorCodeFormat
LanguageCodeFormat
LanguageCodeFormat
LanguageTagFormat
LanguageTagFormat
DataExample
project
DataExample
JsonCase
JsonCase
SmithyCase
SmithyCase
StringCase
StringCase
Visitor
Default
Visitor
DataExamples
DateFormat
DateFormat
DefaultValue
Discriminated
Nullable
Nullable
OpenEnum
OpenEnum
SimpleRestJson
SimpleRestJson
StructurePattern
StructurePattern
UncheckedExample
UncheckedExample
UncheckedExamples
Untagged
Untagged
UrlFormFlattened
UrlFormFlattened
UrlFormName
UuidFormat
UuidFormat
core
/
smithy
/
smithy.api
/
IdRef
IdRef
smithy.api.IdRef$
See the
IdRef
companion class
object
IdRef
extends
Companion
[
IdRef
]
Attributes
Companion
class
Graph
Reset zoom
Hide graph
Show graph
Supertypes
trait
Product
trait
Mirror
trait
Companion
[
IdRef
]
trait
Has
[
IdRef
]
trait
ShapeTag
[
IdRef
]
trait
HasId
class
Object
trait
Matchable
class
Any
Show all
Self type
IdRef
.type
Members list
Clear all
Type members
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
Inherited methods
final override
def
getTag
:
ShapeTag
[
A
]
Attributes
Definition Classes
Companion
->
Has
Inherited from:
Companion
Concrete fields
val
hints
:
Hints
val
id
:
ShapeId
Implicits
Implicits
implicit
val
schema
:
Schema
[
IdRef
]
Inherited implicits
implicit
val
tagInstance
:
ShapeTag
[
IdRef
]
Attributes
Inherited from:
Companion
In this article
Attributes
Members list
Type members
Inherited classlikes
Inherited types
Value members
Inherited methods
Concrete fields
Implicits
Implicits
Inherited implicits