core
API
Generated with
core/smithy/smithy.api

smithy.api

package smithy.api

Members list

Type members

Classlikes

final case class AddedDefault()

Indicates that the default trait was added to a member.

Indicates that the default trait was added to a member.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AddedDefault extends Companion[AddedDefault]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[AddedDefault]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
object Auth extends Newtype[Set[AuthTraitReference]]

Defines the ordered list of supported authentication schemes.

Defines the ordered list of supported authentication schemes.

Value parameters

member

A string that must target an auth trait.

Attributes

Supertypes
trait HasId
class Object
trait Matchable
class Any
Self type
Auth.type
final case class AuthDefinition(traits: Option[List[TraitShapeId]])

Marks a trait as an auth scheme defining trait.

Marks a trait as an auth scheme defining trait.

The targeted trait must only be applied to service shapes or operation shapes, must be a structure, and must have the trait trait.

Value parameters

traits

The list of traits that auth implementations must understand in order to successfully use the scheme.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AuthDefinition extends Companion[AuthDefinition]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
object AuthTraitReference extends Newtype[ShapeId]

A string that must target an auth trait.

A string that must target an auth trait.

Attributes

Supertypes
class Newtype[ShapeId]
trait HasId
class Object
trait Matchable
class Any
Self type
final case class Box()

Used only in Smithy 1.0 to indicate that a shape is boxed.

Used only in Smithy 1.0 to indicate that a shape is boxed.

This trait cannot be used in Smithy 2.0 models. When a boxed shape is the target of a member, the member may or may not contain a value, and the member has no default value.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Box extends Companion[Box]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[Box]
trait Has[Box]
trait ShapeTag[Box]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Box.type
final case class ClientOptional()

Requires that non-authoritative generators like clients treat a structure member as nullable regardless of if the member is also marked with the required trait.

Requires that non-authoritative generators like clients treat a structure member as nullable regardless of if the member is also marked with the required trait.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ClientOptional extends Companion[ClientOptional]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
final case class Cors(origin: NonEmptyString, maxAge: Int, additionalAllowedHeaders: Option[List[NonEmptyString]], additionalExposedHeaders: Option[List[NonEmptyString]])

Defines how a service supports cross-origin resource sharing.

Defines how a service supports cross-origin resource sharing.

Value parameters

additionalAllowedHeaders

The names of headers that should be included in the Access-Control-Allow-Headers header in responses to preflight OPTIONS requests. This list will be used in addition to the names of all request headers bound to an input data member via the httpHeader, as well as any headers required by the protocol or authentication scheme.

additionalExposedHeaders

The names of headers that should be included in the Access-Control-Expose-Headers header in all responses sent by the service. This list will be used in addition to the names of all request headers bound to an output data member via the httpHeader, as well as any headers required by the protocol or authentication scheme.

maxAge

The maximum number of seconds for which browsers are allowed to cache the results of a preflight OPTIONS request. Defaults to 600, the maximum age permitted by several browsers. Set to -1 to disable caching entirely.

origin

The origin from which browser script-originating requests will be allowed.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Cors extends Companion[Cors]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[Cors]
trait Has[Cors]
trait ShapeTag[Cors]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Cors.type
object Default extends Newtype[Document]

Provides a structure member with a default value. When added to root level shapes, requires that every targeting structure member defines the same default value on the member or sets a default of null.

Provides a structure member with a default value. When added to root level shapes, requires that every targeting structure member defines the same default value on the member or sets a default of null.

This trait can currently only be used in Smithy 2.0 models.

Attributes

Supertypes
class Newtype[Document]
trait HasId
class Object
trait Matchable
class Any
Self type
Default.type
final case class Deprecated(message: Option[String], since: Option[String])

Marks a shape or member as deprecated.

Marks a shape or member as deprecated.

Value parameters

message

The reason for deprecation.

since

A description of when the shape was deprecated (e.g., a date or version).

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Deprecated extends Companion[Deprecated]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[Deprecated]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Deprecated.type
object Documentation extends Newtype[String]

Adds documentation to a shape or member using CommonMark syntax.

Adds documentation to a shape or member using CommonMark syntax.

Attributes

Supertypes
class Newtype[String]
trait HasId
class Object
trait Matchable
class Any
Self type
final case class Endpoint(hostPrefix: NonEmptyString)

Configures a custom operation endpoint.

Configures a custom operation endpoint.

Value parameters

hostPrefix

A host prefix pattern for the operation. Labels defined in the host pattern are used to bind top-level operation input members to the host.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Endpoint extends Companion[Endpoint]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[Endpoint]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Endpoint.type
object EnumConstantBodyName extends Newtype[String]

The optional name or label of the enum constant value.

The optional name or label of the enum constant value.

This property is used in code generation to provide a label for each enum value. No two enums can have the same 'name' value.

Attributes

Supertypes
class Newtype[String]
trait HasId
class Object
trait Matchable
class Any
Self type
final case class EnumDefinition(value: NonEmptyString, name: Option[EnumConstantBodyName], documentation: Option[String], tags: Option[List[NonEmptyString]], deprecated: Option[Boolean])

An enum definition for the enum trait.

An enum definition for the enum trait.

Value parameters

deprecated

Whether the enum value should be considered deprecated.

documentation

Provides optional documentation about the enum constant value.

name

Defines the name that is used in code to represent this variant.

tags

Applies a list of tags to the enum constant.

value

Defines the enum value that is sent over the wire.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object EnumDefinition extends Companion[EnumDefinition]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
object EnumValue extends Newtype[Document]

Defines the value of an enum member.

Defines the value of an enum member.

Attributes

Supertypes
class Newtype[Document]
trait HasId
class Object
trait Matchable
class Any
Self type
EnumValue.type
sealed abstract class Error(_value: String, _name: String, _intValue: Int, _hints: Hints) extends Value

Indicates that a structure shape represents an error.

Indicates that a structure shape represents an error.

All shapes referenced by the errors list of an operation MUST be targeted with this trait.

Attributes

Companion
object
Supertypes
class Value
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object CLIENT.type
object SERVER.type
object Error extends Enumeration[Error], Companion[Error]

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
trait Companion[Error]
trait Has[Error]
trait ShapeTag[Error]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Error.type
final case class EventHeader()

Marks a member as a header of an event.

Marks a member as a header of an event.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object EventHeader extends Companion[EventHeader]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[EventHeader]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
final case class EventPayload()

Marks a member as the payload of an event.

Marks a member as the payload of an event.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object EventPayload extends Companion[EventPayload]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[EventPayload]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
final case class Example(title: String, documentation: Option[String], input: Option[Document], output: Option[Document], error: Option[ExampleError], allowConstraintErrors: Option[Boolean])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Example extends Companion[Example]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[Example]
trait ShapeTag[Example]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Example.type
final case class ExampleError(shapeId: Option[ShapeId], content: Option[Document])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ExampleError extends Companion[ExampleError]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[ExampleError]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
object Examples extends Newtype[List[Example]]

Provides example inputs and outputs for operations.

Provides example inputs and outputs for operations.

Attributes

Supertypes
class Newtype[List[Example]]
trait HasId
class Object
trait Matchable
class Any
Self type
Examples.type
object ExternalDocumentation extends Newtype[Map[NonEmptyString, NonEmptyString]]

Provides a link to additional documentation.

Provides a link to additional documentation.

Attributes

Supertypes
trait HasId
class Object
trait Matchable
class Any
Self type
final case class HostLabel()

Binds a top-level operation input structure member to a label in the hostPrefix of an endpoint trait.

Binds a top-level operation input structure member to a label in the hostPrefix of an endpoint trait.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HostLabel extends Companion[HostLabel]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[HostLabel]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
HostLabel.type
final case class Http(method: NonEmptyString, uri: NonEmptyString, code: Int)

Configures the HTTP bindings of an operation.

Configures the HTTP bindings of an operation.

Value parameters

method

The HTTP method of the operation.

uri

The URI pattern of the operation. Labels defined in the URI pattern are used to bind operation input members to the URI.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Http extends Companion[Http]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[Http]
trait Has[Http]
trait ShapeTag[Http]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Http.type
final case class HttpApiKeyAuth(name: NonEmptyString, in: HttpApiKeyLocations, scheme: Option[NonEmptyString])

An HTTP-specific authentication scheme that sends an arbitrary API key in a header or query string parameter.

An HTTP-specific authentication scheme that sends an arbitrary API key in a header or query string parameter.

Value parameters

in

Defines the location of where the key is serialized. This value can be set to "header" or "query".

name

Defines the name of the HTTP header or query string parameter that contains the API key.

scheme

Defines the security scheme to use in the Authorization header. This can only be set if the "in" property is set to header.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HttpApiKeyAuth extends Companion[HttpApiKeyAuth]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
sealed abstract class HttpApiKeyLocations(_value: String, _name: String, _intValue: Int, _hints: Hints) extends Value

Attributes

Companion
object
Supertypes
class Value
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object HEADER.type
object QUERY.type
object HttpApiKeyLocations extends Enumeration[HttpApiKeyLocations], Companion[HttpApiKeyLocations]

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
final case class HttpBasicAuth()

Enables HTTP Basic Authentication as defined in RFC 2617 on a service or operation.

Enables HTTP Basic Authentication as defined in RFC 2617 on a service or operation.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HttpBasicAuth extends Companion[HttpBasicAuth]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
final case class HttpBearerAuth()

Enables HTTP Bearer Authentication as defined in RFC 6750 on a service or operation.

Enables HTTP Bearer Authentication as defined in RFC 6750 on a service or operation.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HttpBearerAuth extends Companion[HttpBearerAuth]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
final case class HttpChecksumRequired()

Marks an operation as requiring checksum in its HTTP request. By default, the checksum used for a service is a MD5 checksum passed in the Content-MD5 header.

Marks an operation as requiring checksum in its HTTP request. By default, the checksum used for a service is a MD5 checksum passed in the Content-MD5 header.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HttpChecksumRequired extends Companion[HttpChecksumRequired]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
final case class HttpDigestAuth()

Enables HTTP Digest Authentication as defined in RFC 2617 on a service or operation.

Enables HTTP Digest Authentication as defined in RFC 2617 on a service or operation.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HttpDigestAuth extends Companion[HttpDigestAuth]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
object HttpError extends Newtype[Int]

Defines an HTTP response code for an operation error.

Defines an HTTP response code for an operation error.

Attributes

Supertypes
class Newtype[Int]
trait HasId
class Object
trait Matchable
class Any
Self type
HttpError.type
object HttpHeader extends Newtype[String]

Binds a structure member to an HTTP header.

Binds a structure member to an HTTP header.

Attributes

Supertypes
class Newtype[String]
trait HasId
class Object
trait Matchable
class Any
Self type
HttpHeader.type
final case class HttpLabel()

Binds an operation input structure member to an HTTP label.

Binds an operation input structure member to an HTTP label.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HttpLabel extends Companion[HttpLabel]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[HttpLabel]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
HttpLabel.type
final case class HttpPayload()

Binds a single structure member to the body of an HTTP request.

Binds a single structure member to the body of an HTTP request.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HttpPayload extends Companion[HttpPayload]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[HttpPayload]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
object HttpPrefixHeaders extends Newtype[String]

Binds a map of key-value pairs to prefixed HTTP headers.

Binds a map of key-value pairs to prefixed HTTP headers.

Attributes

Supertypes
class Newtype[String]
trait HasId
class Object
trait Matchable
class Any
Self type
object HttpQuery extends Newtype[String]

Binds an operation input structure member to a query string parameter.

Binds an operation input structure member to a query string parameter.

Attributes

Supertypes
class Newtype[String]
trait HasId
class Object
trait Matchable
class Any
Self type
HttpQuery.type
final case class HttpQueryParams()

Binds an operation input structure member to the HTTP query string.

Binds an operation input structure member to the HTTP query string.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HttpQueryParams extends Companion[HttpQueryParams]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
final case class HttpResponseCode()

Indicates that the structure member represents the HTTP response status code. The value MAY differ from the HTTP status code provided on the response.

Indicates that the structure member represents the HTTP response status code. The value MAY differ from the HTTP status code provided on the response.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HttpResponseCode extends Companion[HttpResponseCode]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
final case class IdRef(selector: String, failWhenMissing: Option[Boolean], errorMessage: Option[String])

Indicates that a string value MUST contain a valid shape ID.

Indicates that a string value MUST contain a valid shape ID.

The provided shape ID MAY be absolute or relative to the shape to which the trait is applied. A relative shape ID that does not resolve to a shape defined in the same namespace resolves to a shape defined in the prelude if the prelude shape is not marked with the private trait.

Value parameters

errorMessage

Defines a custom error message to use when the shape ID cannot be found or does not match the selector. A default message is generated when errorMessage is not defined.

failWhenMissing

When set to true, the shape ID MUST target a shape that can be found in the model.

selector

Defines the selector that the resolved shape, if found, MUST match.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object IdRef extends Companion[IdRef]

Attributes

Companion
class
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
final case class IdempotencyToken()

Defines the input member of an operation that is used by the server to identify and discard replayed requests.

Defines the input member of an operation that is used by the server to identify and discard replayed requests.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object IdempotencyToken extends Companion[IdempotencyToken]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
final case class Idempotent()

Indicates that the intended effect on the server of multiple identical requests with an operation is the same as the effect for a single such request.

Indicates that the intended effect on the server of multiple identical requests with an operation is the same as the effect for a single such request.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Idempotent extends Companion[Idempotent]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[Idempotent]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Idempotent.type
final case class Input()

Specializes a structure for use only as the input of a single operation.

Specializes a structure for use only as the input of a single operation.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Input extends Companion[Input]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[Input]
trait Has[Input]
trait ShapeTag[Input]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Input.type
final case class Internal()

Shapes marked with the internal trait are meant only for internal use and must not be exposed to customers.

Shapes marked with the internal trait are meant only for internal use and must not be exposed to customers.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Internal extends Companion[Internal]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[Internal]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Internal.type
object JsonName extends Newtype[String]

Allows a serialized object property name to differ from a structure member name used in the model.

Allows a serialized object property name to differ from a structure member name used in the model.

Attributes

Supertypes
class Newtype[String]
trait HasId
class Object
trait Matchable
class Any
Self type
JsonName.type
final case class Length(min: Option[Long], max: Option[Long])

Constrains a shape to minimum and maximum number of elements or size.

Constrains a shape to minimum and maximum number of elements or size.

Value parameters

max

Integer value that represents the maximum inclusive length of a shape.

min

Integer value that represents the minimum inclusive length of a shape.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Length extends Companion[Length]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[Length]
trait Has[Length]
trait ShapeTag[Length]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Length.type
object LocalMixinTrait extends Newtype[ShapeId]

Attributes

Supertypes
class Newtype[ShapeId]
trait HasId
class Object
trait Matchable
class Any
Self type
object LocalMixinTraitList extends Newtype[List[LocalMixinTrait]]

Attributes

Supertypes
trait HasId
class Object
trait Matchable
class Any
Self type
object MediaType extends Newtype[String]

Describes the contents of a blob shape using a media type as defined by RFC 6838 (e.g., "video/quicktime").

Describes the contents of a blob shape using a media type as defined by RFC 6838 (e.g., "video/quicktime").

Attributes

Supertypes
class Newtype[String]
trait HasId
class Object
trait Matchable
class Any
Self type
MediaType.type
final case class Mixin(localTraits: Option[List[LocalMixinTrait]])

Makes a structure or union a mixin.

Makes a structure or union a mixin.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Mixin extends Companion[Mixin]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[Mixin]
trait Has[Mixin]
trait ShapeTag[Mixin]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Mixin.type
final case class NestedProperties()

Adjusts the resource property mapping of a lifecycle operation to the targeted member.

Adjusts the resource property mapping of a lifecycle operation to the targeted member.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object NestedProperties extends Companion[NestedProperties]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
final case class NoReplace()

Indicates that the put lifecycle operation of a resource can only be used to create a resource and cannot replace an existing resource.

Indicates that the put lifecycle operation of a resource can only be used to create a resource and cannot replace an existing resource.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object NoReplace extends Companion[NoReplace]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[NoReplace]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
NoReplace.type
object NonEmptyString extends Newtype[String]

Attributes

Supertypes
class Newtype[String]
trait HasId
class Object
trait Matchable
class Any
Self type
object NonEmptyStringList extends Newtype[List[NonEmptyString]]

Attributes

Supertypes
trait HasId
class Object
trait Matchable
class Any
Self type
object NonEmptyStringMap extends Newtype[Map[NonEmptyString, NonEmptyString]]

Attributes

Supertypes
trait HasId
class Object
trait Matchable
class Any
Self type
final case class NotProperty()

Explicitly excludes a member from resource property mapping or enables another trait to carry the same implied meaning.

Explicitly excludes a member from resource property mapping or enables another trait to carry the same implied meaning.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object NotProperty extends Companion[NotProperty]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[NotProperty]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
final case class OptionalAuth()

Indicates that an operation can be called without authentication.

Indicates that an operation can be called without authentication.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object OptionalAuth extends Companion[OptionalAuth]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[OptionalAuth]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
final case class Output()

Specializes a structure for use only as the output of a single operation.

Specializes a structure for use only as the output of a single operation.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Output extends Companion[Output]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[Output]
trait Has[Output]
trait ShapeTag[Output]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Output.type
final case class Paginated(inputToken: Option[NonEmptyString], outputToken: Option[NonEmptyString], items: Option[NonEmptyString], pageSize: Option[NonEmptyString])

The paginated trait indicates that an operation intentionally limits the number of results returned in a single response and that multiple invocations might be necessary to retrieve all results.

The paginated trait indicates that an operation intentionally limits the number of results returned in a single response and that multiple invocations might be necessary to retrieve all results.

Value parameters

inputToken

The name of the operation input member that represents the continuation token. When this value is provided as operation input, the service returns results from where the previous response left off. This input member MUST NOT be required and MUST target a string shape.

items

The name of a top-level output member of the operation that is the data that is being paginated across many responses. The named output member, if specified, MUST target a list or map.

outputToken

The name of the operation output member that represents the continuation token. When this value is present in operation output, it indicates that there are more results to retrieve. To get the next page of results, the client uses the output token as the input token of the next request. This output member MUST NOT be required and MUST target a string shape.

pageSize

The name of an operation input member that limits the maximum number of results to include in the operation output. This input member MUST NOT be required and MUST target an integer shape.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Paginated extends Companion[Paginated]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[Paginated]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Paginated.type
object Pattern extends Newtype[String]

Restricts string shape values to a specified regular expression.

Restricts string shape values to a specified regular expression.

Attributes

Supertypes
class Newtype[String]
trait HasId
class Object
trait Matchable
class Any
Self type
Pattern.type
object PrimitiveShort extends Newtype[Short]

Attributes

Supertypes
class Newtype[Short]
trait HasId
class Object
trait Matchable
class Any
Self type
final case class Private()

Prevents models defined in a different namespace from referencing the targeted shape.

Prevents models defined in a different namespace from referencing the targeted shape.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Private extends Companion[Private]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[Private]
trait ShapeTag[Private]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Private.type
final case class Property(name: Option[String])

Configures a structure member's resource property mapping behavior.

Configures a structure member's resource property mapping behavior.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Property extends Companion[Property]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[Property]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Property.type
final case class ProtocolDefinition(traits: Option[List[TraitShapeId]], noInlineDocumentSupport: Option[Boolean])

Marks a trait as a protocol defining trait.

Marks a trait as a protocol defining trait.

The targeted trait must only be applied to service shapes, must be a structure, and must have the trait trait.

Value parameters

noInlineDocumentSupport

Set to true if inline documents are not supported by this protocol.

traits

The list of traits that protocol implementations must understand in order to successfully use the protocol.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ProtocolDefinition extends Companion[ProtocolDefinition]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
final case class Range(min: Option[BigDecimal], max: Option[BigDecimal])

Restricts allowed values of byte, short, integer, long, float, double, bigDecimal, and bigInteger shapes within an acceptable lower and upper bound.

Restricts allowed values of byte, short, integer, long, float, double, bigDecimal, and bigInteger shapes within an acceptable lower and upper bound.

Value parameters

max

Specifies the allowed inclusive maximum value.

min

Specifies the allowed inclusive minimum value.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Range extends Companion[Range]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[Range]
trait Has[Range]
trait ShapeTag[Range]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Range.type
final case class Readonly()

Indicates that an operation is effectively read-only.

Indicates that an operation is effectively read-only.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Readonly extends Companion[Readonly]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[Readonly]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Readonly.type
final case class Recommended(reason: Option[String])

Indicates that a structure member SHOULD be set.

Indicates that a structure member SHOULD be set.

Value parameters

reason

Provides a reason why the member is recommended.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Recommended extends Companion[Recommended]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[Recommended]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
final case class Reference(resource: NonEmptyString, ids: Option[Map[NonEmptyString, NonEmptyString]], service: Option[NonEmptyString], rel: Option[NonEmptyString])

Value parameters

ids

Defines a mapping of each resource identifier name to a structure member name that provides its value. Each key in the map MUST refer to one of the identifier names in the identifiers property of the resource, and each value in the map MUST refer to a valid structure member name that targets a string shape.

rel

Defines the semantics of the relationship. The rel property SHOULD contain a link relation as defined in RFC 5988#section-4.

resource

The shape ID of the referenced resource.

service

Providing a service makes the reference specific to a particular binding of the resource to a service. When omitted, the reference is late-bound to a service, meaning the reference is assumed to be a reference to the resource bound to the service currently in use by the client or server.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Reference extends Companion[Reference]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[Reference]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Reference.type
object References extends Newtype[List[Reference]]

Defines the resource shapes that are referenced by a string shape or a structure shape and the members of the structure that provide values for the identifiers of the resource.

Defines the resource shapes that are referenced by a string shape or a structure shape and the members of the structure that provide values for the identifiers of the resource.

Attributes

Supertypes
trait HasId
class Object
trait Matchable
class Any
Self type
References.type
final case class RequestCompression(encodings: List[String])

Indicates that an operation supports compressing requests from clients to services.

Indicates that an operation supports compressing requests from clients to services.

Value parameters

encodings

Defines the priority-ordered list of compression algorithms supported by the service operation.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RequestCompression extends Companion[RequestCompression]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
object RequestCompressionEncodingsList extends Newtype[List[String]]

Defines the priority-ordered list of compression algorithms supported by the service operation.

Defines the priority-ordered list of compression algorithms supported by the service operation.

Attributes

Supertypes
class Newtype[List[String]]
trait HasId
class Object
trait Matchable
class Any
Self type
final case class Required()

Marks a structure member as required, meaning a value for the member MUST be present.

Marks a structure member as required, meaning a value for the member MUST be present.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Required extends Companion[Required]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[Required]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Required.type
final case class RequiresLength()

Indicates that the streaming blob must be finite and has a known size.

Indicates that the streaming blob must be finite and has a known size.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RequiresLength extends Companion[RequiresLength]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
object ResourceIdentifier extends Newtype[String]

Indicates that the targeted structure member provides an identifier for a resource.

Indicates that the targeted structure member provides an identifier for a resource.

Attributes

Supertypes
class Newtype[String]
trait HasId
class Object
trait Matchable
class Any
Self type
final case class Retryable(throttling: Option[Boolean])

Indicates that an error MAY be retried by the client.

Indicates that an error MAY be retried by the client.

Value parameters

throttling

Classifies the retry as throttling.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Retryable extends Companion[Retryable]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[Retryable]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Retryable.type
final case class Sensitive()

Indicates that the data stored in the shape is sensitive and MUST be handled with care.

Indicates that the data stored in the shape is sensitive and MUST be handled with care.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Sensitive extends Companion[Sensitive]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[Sensitive]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Sensitive.type
object Since extends Newtype[String]

Defines the version or date in which a shape or member was added to the model.

Defines the version or date in which a shape or member was added to the model.

Attributes

Supertypes
class Newtype[String]
trait HasId
class Object
trait Matchable
class Any
Self type
Since.type
final case class Sparse()

Marks a list or map as sparse.

Marks a list or map as sparse.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Sparse extends Companion[Sparse]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[Sparse]
trait Has[Sparse]
trait ShapeTag[Sparse]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Sparse.type
final case class Streaming()

Indicates that the data stored in the shape is very large and should not be stored in memory, or that the size of the data stored in the shape is unknown at the start of a request. If the target is a union then the shape represents a stream of events.

Indicates that the data stored in the shape is very large and should not be stored in memory, or that the size of the data stored in the shape is unknown at the start of a request. If the target is a union then the shape represents a stream of events.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Streaming extends Companion[Streaming]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[Streaming]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Streaming.type
sealed abstract class StructurallyExclusive(_value: String, _name: String, _intValue: Int, _hints: Hints) extends Value

Value parameters

MEMBER

Only a single member of a shape can be marked with the trait.

TARGET

Only a single member of a shape can target a shape marked with this trait.

Attributes

Companion
object
Supertypes
class Value
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object MEMBER.type
object TARGET.type
object StructurallyExclusive extends Enumeration[StructurallyExclusive], Companion[StructurallyExclusive]

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
object Suppress extends Newtype[List[String]]

Suppresses validation events by ID for a given shape.

Suppresses validation events by ID for a given shape.

Attributes

Supertypes
class Newtype[List[String]]
trait HasId
class Object
trait Matchable
class Any
Self type
Suppress.type
object Tags extends Newtype[List[String]]

Tags a shape with arbitrary tag names that can be used to filter and group shapes in the model.

Tags a shape with arbitrary tag names that can be used to filter and group shapes in the model.

Attributes

Supertypes
class Newtype[List[String]]
trait HasId
class Object
trait Matchable
class Any
Self type
Tags.type
sealed abstract class TimestampFormat(_value: String, _name: String, _intValue: Int, _hints: Hints) extends Value

Value parameters

DATE_TIME

Date time as defined by the date-time production in RFC3339 section 5.6 with no UTC offset (for example, 1985-04-12T23:20:50.52Z).

EPOCH_SECONDS

Also known as Unix time, the number of seconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970, with decimal precision (for example, 1515531081.1234).

HTTP_DATE

An HTTP date as defined by the IMF-fixdate production in RFC 7231#section-7.1.1.1 (for example, Tue, 29 Apr 2014 18:30:38 GMT).

Attributes

Companion
object
Supertypes
class Value
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object DATE_TIME.type
object EPOCH_SECONDS.type
object HTTP_DATE.type
object TimestampFormat extends Enumeration[TimestampFormat], Companion[TimestampFormat]

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
object Title extends Newtype[String]

Defines a proper name for a service or resource shape.

Defines a proper name for a service or resource shape.

This title can be used in automatically generated documentation and other contexts to provide a user friendly name for services and resources.

Attributes

Supertypes
class Newtype[String]
trait HasId
class Object
trait Matchable
class Any
Self type
Title.type
final case class Trait(selector: Option[String], structurallyExclusive: Option[StructurallyExclusive], conflicts: Option[List[NonEmptyString]], breakingChanges: Option[List[TraitDiffRule]])

Makes a shape a trait.

Makes a shape a trait.

Value parameters

breakingChanges

Defines the backward compatibility rules of the trait.

conflicts

The traits that this trait conflicts with.

selector

The valid places in a model that the trait can be applied.

structurallyExclusive

Whether or not only a single member in a shape can have this trait.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Trait extends Companion[Trait]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[Trait]
trait Has[Trait]
trait ShapeTag[Trait]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Trait.type
sealed abstract class TraitChangeSeverity(_value: String, _name: String, _intValue: Int, _hints: Hints) extends Value

Value parameters

DANGER

An infraction occurred that must be resolved.

ERROR

An unrecoverable infraction occurred.

NOTE

A minor infraction occurred.

WARNING

An infraction occurred that needs attention.

Attributes

Companion
object
Supertypes
class Value
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object DANGER.type
object ERROR.type
object NOTE.type
object WARNING.type
object TraitChangeSeverity extends Enumeration[TraitChangeSeverity], Companion[TraitChangeSeverity]

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
sealed abstract class TraitChangeType(_value: String, _name: String, _intValue: Int, _hints: Hints) extends Value

Value parameters

ADD

Emit when a trait or value is added that previously did not exist.

ANY

Emit when any change occurs.

PRESENCE

Emit when a trait is added or removed.

REMOVE

Emit when a trait or value is removed.

UPDATE

Emit when a trait is modified.

Attributes

Companion
object
Supertypes
class Value
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object ADD.type
object ANY.type
object PRESENCE.type
object REMOVE.type
object UPDATE.type
object TraitChangeType extends Enumeration[TraitChangeType], Companion[TraitChangeType]

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
final case class TraitDiffRule(change: TraitChangeType, severity: TraitChangeSeverity, path: Option[String], message: Option[String])

Value parameters

change

Defines the type of change that is not allowed.

message

Provides a reason why the change is potentially backward incompatible.

path

Defines a JSON Pointer to the value to evaluate.

severity

Defines the severity of the change. Defaults to ERROR if not defined.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TraitDiffRule extends Companion[TraitDiffRule]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
object TraitDiffRules extends Newtype[List[TraitDiffRule]]

Attributes

Supertypes
trait HasId
class Object
trait Matchable
class Any
Self type
object TraitShapeId extends Newtype[ShapeId]

Attributes

Supertypes
class Newtype[ShapeId]
trait HasId
class Object
trait Matchable
class Any
Self type
object TraitShapeIdList extends Newtype[List[TraitShapeId]]

Attributes

Supertypes
trait HasId
class Object
trait Matchable
class Any
Self type
final case class UniqueItems()

Indicates that the items in a list MUST be unique.

Indicates that the items in a list MUST be unique.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object UniqueItems extends Companion[UniqueItems]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[UniqueItems]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
final case class Unit()

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Unit extends Companion[Unit]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Companion[Unit]
trait Has[Unit]
trait ShapeTag[Unit]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Unit.type
final case class UnitType()

Specializes a structure as a unit type that has no meaningful value. This trait can only be applied to smithy.api#Unit, which ensures that only a single Unit shape can be created.

Specializes a structure as a unit type that has no meaningful value. This trait can only be applied to smithy.api#Unit, which ensures that only a single Unit shape can be created.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object UnitType extends Companion[UnitType]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[UnitType]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
UnitType.type
final case class Unstable()

Indicates that the shape is unstable and could change in the future.

Indicates that the shape is unstable and could change in the future.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Unstable extends Companion[Unstable]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[Unstable]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
Unstable.type
final case class XmlAttribute()

Serializes an object property as an XML attribute rather than a nested XML element.

Serializes an object property as an XML attribute rather than a nested XML element.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object XmlAttribute extends Companion[XmlAttribute]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[XmlAttribute]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
final case class XmlFlattened()

Unwraps the values of a list, set, or map into the containing structure/union.

Unwraps the values of a list, set, or map into the containing structure/union.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object XmlFlattened extends Companion[XmlFlattened]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[XmlFlattened]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type
object XmlName extends Newtype[String]

Changes the serialized element or attribute name of a structure, union, or member.

Changes the serialized element or attribute name of a structure, union, or member.

Attributes

Supertypes
class Newtype[String]
trait HasId
class Object
trait Matchable
class Any
Self type
XmlName.type
final case class XmlNamespace(uri: NonEmptyString, prefix: Option[NonEmptyString])

Adds an xmlns namespace definition URI to an XML element.

Adds an xmlns namespace definition URI to an XML element.

Value parameters

prefix

The prefix for the given namespace.

uri

The namespace URI for scoping this XML element.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object XmlNamespace extends Companion[XmlNamespace]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Has[XmlNamespace]
trait HasId
class Object
trait Matchable
class Any
Show all
Self type

Deprecated classlikes

object Enum extends Newtype[List[EnumDefinition]]

Constrains the acceptable values of a string to a fixed set of constant values.

Constrains the acceptable values of a string to a fixed set of constant values.

Value parameters

member

An enum definition for the enum trait.

Attributes

Deprecated
[Since version 2.0] The enum trait is replaced by the enum shape in Smithy 2.0
Supertypes
trait HasId
class Object
trait Matchable
class Any
Self type
Enum.type

Types

type Auth = Type

Defines the ordered list of supported authentication schemes.

Defines the ordered list of supported authentication schemes.

Value parameters

member

A string that must target an auth trait.

Attributes

type AuthTraitReference = Type

A string that must target an auth trait.

A string that must target an auth trait.

Attributes

type Default = Type

Provides a structure member with a default value. When added to root level shapes, requires that every targeting structure member defines the same default value on the member or sets a default of null.

Provides a structure member with a default value. When added to root level shapes, requires that every targeting structure member defines the same default value on the member or sets a default of null.

This trait can currently only be used in Smithy 2.0 models.

Attributes

type Documentation = Type

Adds documentation to a shape or member using CommonMark syntax.

Adds documentation to a shape or member using CommonMark syntax.

Attributes

type EnumConstantBodyName = Type

The optional name or label of the enum constant value.

The optional name or label of the enum constant value.

This property is used in code generation to provide a label for each enum value. No two enums can have the same 'name' value.

Attributes

type EnumValue = Type

Defines the value of an enum member.

Defines the value of an enum member.

Attributes

type Examples = Type

Provides example inputs and outputs for operations.

Provides example inputs and outputs for operations.

Attributes

type ExternalDocumentation = Type

Provides a link to additional documentation.

Provides a link to additional documentation.

Attributes

type HttpError = Type

Defines an HTTP response code for an operation error.

Defines an HTTP response code for an operation error.

Attributes

type HttpHeader = Type

Binds a structure member to an HTTP header.

Binds a structure member to an HTTP header.

Attributes

type HttpPrefixHeaders = Type

Binds a map of key-value pairs to prefixed HTTP headers.

Binds a map of key-value pairs to prefixed HTTP headers.

Attributes

type HttpQuery = Type

Binds an operation input structure member to a query string parameter.

Binds an operation input structure member to a query string parameter.

Attributes

type JsonName = Type

Allows a serialized object property name to differ from a structure member name used in the model.

Allows a serialized object property name to differ from a structure member name used in the model.

Attributes

type MediaType = Type

Describes the contents of a blob shape using a media type as defined by RFC 6838 (e.g., "video/quicktime").

Describes the contents of a blob shape using a media type as defined by RFC 6838 (e.g., "video/quicktime").

Attributes

type Pattern = Type

Restricts string shape values to a specified regular expression.

Restricts string shape values to a specified regular expression.

Attributes

type References = Type

Defines the resource shapes that are referenced by a string shape or a structure shape and the members of the structure that provide values for the identifiers of the resource.

Defines the resource shapes that are referenced by a string shape or a structure shape and the members of the structure that provide values for the identifiers of the resource.

Attributes

type RequestCompressionEncodingsList = Type

Defines the priority-ordered list of compression algorithms supported by the service operation.

Defines the priority-ordered list of compression algorithms supported by the service operation.

Attributes

type ResourceIdentifier = Type

Indicates that the targeted structure member provides an identifier for a resource.

Indicates that the targeted structure member provides an identifier for a resource.

Attributes

type Since = Type

Defines the version or date in which a shape or member was added to the model.

Defines the version or date in which a shape or member was added to the model.

Attributes

type Suppress = Type

Suppresses validation events by ID for a given shape.

Suppresses validation events by ID for a given shape.

Attributes

type Tags = Type

Tags a shape with arbitrary tag names that can be used to filter and group shapes in the model.

Tags a shape with arbitrary tag names that can be used to filter and group shapes in the model.

Attributes

type Title = Type

Defines a proper name for a service or resource shape.

Defines a proper name for a service or resource shape.

This title can be used in automatically generated documentation and other contexts to provide a user friendly name for services and resources.

Attributes

type XmlName = Type

Changes the serialized element or attribute name of a structure, union, or member.

Changes the serialized element or attribute name of a structure, union, or member.

Attributes

Deprecated types

type Enum = Type

Constrains the acceptable values of a string to a fixed set of constant values.

Constrains the acceptable values of a string to a fixed set of constant values.

Value parameters

member

An enum definition for the enum trait.

Attributes

Deprecated
[Since version 2.0] The enum trait is replaced by the enum shape in Smithy 2.0
Generated with