core/smithy.api

smithy.api

package smithy.api

Type members

Classlikes

object Auth extends Newtype[Set[AuthTraitReference]]
case class AuthDefinition(traits: Option[List[TraitShapeId]])
Companion:
object
object AuthDefinition extends Companion[AuthDefinition]
Companion:
class
object AuthTraitReference extends Newtype[String]
case class Box()
Companion:
object
object Box extends Companion[Box]
Companion:
class
case class Cors(origin: Option[NonEmptyString], maxAge: Option[Int], additionalAllowedHeaders: Option[List[NonEmptyString]], additionalExposedHeaders: Option[List[NonEmptyString]])
Companion:
object
object Cors extends Companion[Cors]
Companion:
class
case class Deprecated(message: Option[String], since: Option[String])
Companion:
object
object Deprecated extends Companion[Deprecated]
Companion:
class
object Documentation extends Newtype[String]
case class Endpoint(hostPrefix: NonEmptyString)
Companion:
object
object Endpoint extends Companion[Endpoint]
Companion:
class
object Enum extends Newtype[List[EnumDefinition]]
object EnumConstantBodyName extends Newtype[String]
case class EnumDefinition(value: NonEmptyString, name: Option[EnumConstantBodyName], documentation: Option[String], tags: Option[List[NonEmptyString]], deprecated: Option[Boolean])
Companion:
object
object EnumDefinition extends Companion[EnumDefinition]
Companion:
class
sealed abstract class Error(_value: String, _name: String, _ordinal: Int) extends Value
Companion:
object
object Error extends Enumeration[Error] with Companion[Error]
Companion:
class
case class EventHeader()
Companion:
object
object EventHeader extends Companion[EventHeader]
Companion:
class
case class EventPayload()
Companion:
object
object EventPayload extends Companion[EventPayload]
Companion:
class
case class Example(title: String, documentation: Option[String], input: Option[Document], output: Option[Document], error: Option[ExampleError])
Companion:
object
object Example extends Companion[Example]
Companion:
class
case class ExampleError(shapeId: Option[String], content: Option[Document])
Companion:
object
object ExampleError extends Companion[ExampleError]
Companion:
class
object Examples extends Newtype[List[Example]]
object ExternalDocumentation extends Newtype[Map[NonEmptyString, NonEmptyString]]
case class HostLabel()
Companion:
object
object HostLabel extends Companion[HostLabel]
Companion:
class
case class Http(method: NonEmptyString, uri: NonEmptyString, code: Option[Int])
Companion:
object
object Http extends Companion[Http]
Companion:
class
case class HttpApiKeyAuth(name: NonEmptyString, in: HttpApiKeyLocations, scheme: Option[NonEmptyString])
Companion:
object
object HttpApiKeyAuth extends Companion[HttpApiKeyAuth]
Companion:
class
sealed abstract class HttpApiKeyLocations(_value: String, _name: String, _ordinal: Int) extends Value
Companion:
object
object HttpApiKeyLocations extends Enumeration[HttpApiKeyLocations] with Companion[HttpApiKeyLocations]
Companion:
class
case class HttpBasicAuth()
Companion:
object
object HttpBasicAuth extends Companion[HttpBasicAuth]
Companion:
class
case class HttpBearerAuth()
Companion:
object
object HttpBearerAuth extends Companion[HttpBearerAuth]
Companion:
class
case class HttpChecksumRequired()
Companion:
object
object HttpChecksumRequired extends Companion[HttpChecksumRequired]
Companion:
class
case class HttpDigestAuth()
Companion:
object
object HttpDigestAuth extends Companion[HttpDigestAuth]
Companion:
class
object HttpError extends Newtype[Int]
object HttpHeader extends Newtype[String]
case class HttpLabel()
Companion:
object
object HttpLabel extends Companion[HttpLabel]
Companion:
class
case class HttpPayload()
Companion:
object
object HttpPayload extends Companion[HttpPayload]
Companion:
class
object HttpPrefixHeaders extends Newtype[String]
object HttpQuery extends Newtype[String]
case class HttpQueryParams()
Companion:
object
object HttpQueryParams extends Companion[HttpQueryParams]
Companion:
class
case class HttpResponseCode()
Companion:
object
object HttpResponseCode extends Companion[HttpResponseCode]
Companion:
class
case class IdRef(selector: Option[String], failWhenMissing: Option[Boolean], errorMessage: Option[String])
Companion:
object
object IdRef extends Companion[IdRef]
Companion:
class
case class IdempotencyToken()
Companion:
object
object IdempotencyToken extends Companion[IdempotencyToken]
Companion:
class
case class Idempotent()
Companion:
object
object Idempotent extends Companion[Idempotent]
Companion:
class
case class Input()
Companion:
object
object Input extends Companion[Input]
Companion:
class
case class Internal()
Companion:
object
object Internal extends Companion[Internal]
Companion:
class
object JsonName extends Newtype[String]
case class Length(min: Option[Long], max: Option[Long])
Companion:
object
object Length extends Companion[Length]
Companion:
class
object MediaType extends Newtype[String]
case class NoReplace()
Companion:
object
object NoReplace extends Companion[NoReplace]
Companion:
class
object NonEmptyString extends Newtype[String]
object NonEmptyStringList extends Newtype[List[NonEmptyString]]
object NonEmptyStringMap extends Newtype[Map[NonEmptyString, NonEmptyString]]
case class OptionalAuth()
Companion:
object
object OptionalAuth extends Companion[OptionalAuth]
Companion:
class
case class Output()
Companion:
object
object Output extends Companion[Output]
Companion:
class
case class Paginated(inputToken: Option[NonEmptyString], outputToken: Option[NonEmptyString], items: Option[NonEmptyString], pageSize: Option[NonEmptyString])
Companion:
object
object Paginated extends Companion[Paginated]
Companion:
class
object Pattern extends Newtype[String]
object PrimitiveShort extends Newtype[Short]
case class Private()
Companion:
object
object Private extends Companion[Private]
Companion:
class
case class ProtocolDefinition(traits: Option[List[TraitShapeId]], noInlineDocumentSupport: Option[Boolean])
Companion:
object
object ProtocolDefinition extends Companion[ProtocolDefinition]
Companion:
class
case class Range(min: Option[BigDecimal], max: Option[BigDecimal])
Companion:
object
object Range extends Companion[Range]
Companion:
class
case class Readonly()
Companion:
object
object Readonly extends Companion[Readonly]
Companion:
class
case class Recommended(reason: Option[String])
Companion:
object
object Recommended extends Companion[Recommended]
Companion:
class
case class Reference(resource: NonEmptyString, ids: Option[Map[NonEmptyString, NonEmptyString]], service: Option[NonEmptyString], rel: Option[NonEmptyString])
Companion:
object
object Reference extends Companion[Reference]
Companion:
class
object References extends Newtype[List[Reference]]
case class Required()
Companion:
object
object Required extends Companion[Required]
Companion:
class
case class RequiresLength()
Companion:
object
object RequiresLength extends Companion[RequiresLength]
Companion:
class
object ResourceIdentifier extends Newtype[String]
case class Retryable(throttling: Option[Boolean])
Companion:
object
object Retryable extends Companion[Retryable]
Companion:
class
case class Sensitive()
Companion:
object
object Sensitive extends Companion[Sensitive]
Companion:
class
object Since extends Newtype[String]
case class Sparse()
Companion:
object
object Sparse extends Companion[Sparse]
Companion:
class
case class Streaming()
Companion:
object
object Streaming extends Companion[Streaming]
Companion:
class
sealed abstract class StructurallyExclusive(_value: String, _name: String, _ordinal: Int) extends Value
Companion:
object
object StructurallyExclusive extends Enumeration[StructurallyExclusive] with Companion[StructurallyExclusive]
Companion:
class
object Suppress extends Newtype[List[String]]
object Tags extends Newtype[List[String]]
sealed abstract class TimestampFormat(_value: String, _name: String, _ordinal: Int) extends Value
Companion:
object
object TimestampFormat extends Enumeration[TimestampFormat] with Companion[TimestampFormat]
Companion:
class
object Title extends Newtype[String]
case class Trait(selector: Option[String], structurallyExclusive: Option[StructurallyExclusive], conflicts: Option[List[NonEmptyString]])
Companion:
object
object Trait extends Companion[Trait]
Companion:
class
object TraitShapeId extends Newtype[String]
object TraitShapeIdList extends Newtype[List[TraitShapeId]]
case class UniqueItems()
Companion:
object
object UniqueItems extends Companion[UniqueItems]
Companion:
class
case class Unit()
Companion:
object
object Unit extends Companion[Unit]
Companion:
class
case class UnitType()
Companion:
object
object UnitType extends Companion[UnitType]
Companion:
class
case class Unstable()
Companion:
object
object Unstable extends Companion[Unstable]
Companion:
class
case class XmlAttribute()
Companion:
object
object XmlAttribute extends Companion[XmlAttribute]
Companion:
class
case class XmlFlattened()
Companion:
object
object XmlFlattened extends Companion[XmlFlattened]
Companion:
class
object XmlName extends Newtype[String]
case class XmlNamespace(uri: NonEmptyString, prefix: Option[NonEmptyString])
Companion:
object
object XmlNamespace extends Companion[XmlNamespace]
Companion:
class

Types

type Auth = Type
type Enum = Type
type Examples = Type
type JsonName = Type
type Pattern = Type
type Since = Type
type Suppress = Type
type Tags = Type
type Title = Type
type XmlName = Type