2. Prelude model

All Smithy models automatically include a prelude. The prelude defines various simple shapes and every trait defined in the core specification. When using the IDL, shapes defined in the prelude can be referenced from within any namespace using a relative shape ID.

Tip

Prelude shapes SHOULD be used when possible to minimize duplication in models.

2.1. Prelude shapes

Smithy prelude

$version: "1.0"

namespace smithy.api

string String

blob Blob

bigInteger BigInteger

bigDecimal BigDecimal

timestamp Timestamp

document Document

@box
boolean Boolean

boolean PrimitiveBoolean

@box
byte Byte

byte PrimitiveByte

@box
short Short

short PrimitiveShort

@box
integer Integer

integer PrimitiveInteger

@box
long Long

long PrimitiveLong

@box
float Float

float PrimitiveFloat

@box
double Double

double PrimitiveDouble

/// The single unit type shape, similar to Void and None in other
/// languages, used to represent no meaningful value.
@unitType
structure Unit {}