package api
- Alphabetic
- By Inheritance
- api
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- final case class AddedDefault() extends Product with Serializable
Indicates that the default trait was added to a member.
- type Auth = api.Auth.Type
Defines the ordered list of supported authentication schemes.
- final case class AuthDefinition(traits: Option[List[TraitShapeId]] = None) extends Product with Serializable
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.- traits
The list of traits that auth implementations must understand in order to successfully use the scheme.
- type AuthTraitReference = api.AuthTraitReference.Type
A string that must target an auth trait.
- final case class Box() extends Product with Serializable
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.
- final case class ClientOptional() extends Product with Serializable
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.
- final case class Cors(origin: NonEmptyString = smithy.api.NonEmptyString("*"), maxAge: Int = 600, additionalAllowedHeaders: Option[List[NonEmptyString]] = None, additionalExposedHeaders: Option[List[NonEmptyString]] = None) extends Product with Serializable
Defines how a service supports cross-origin resource sharing.
Defines how a service supports cross-origin resource sharing.
- origin
The origin from which browser script-originating requests will be allowed.
- 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.
- 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.
- type Default = api.Default.Type
Provides a structure member with a default value.
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.
- final case class Deprecated(message: Option[String] = None, since: Option[String] = None) extends Product with Serializable
Marks a shape or member as deprecated.
Marks a shape or member as deprecated.
- message
The reason for deprecation.
- since
A description of when the shape was deprecated (e.g., a date or version).
- type Documentation = api.Documentation.Type
Adds documentation to a shape or member using CommonMark syntax.
- final case class Endpoint(hostPrefix: NonEmptyString) extends Product with Serializable
Configures a custom operation endpoint.
Configures a custom operation endpoint.
- 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.
- type EnumConstantBodyName = api.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.
- final case class EnumDefinition(value: NonEmptyString, name: Option[EnumConstantBodyName] = None, documentation: Option[String] = None, tags: Option[List[NonEmptyString]] = None, deprecated: Option[Boolean] = None) extends Product with Serializable
An enum definition for the enum trait.
An enum definition for the enum trait.
- value
Defines the enum value that is sent over the wire.
- name
Defines the name that is used in code to represent this variant.
- documentation
Provides optional documentation about the enum constant value.
- tags
Applies a list of tags to the enum constant.
- deprecated
Whether the enum value should be considered deprecated.
- type EnumValue = api.EnumValue.Type
Defines the value of an enum member.
- sealed abstract class Error 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.
- final case class EventHeader() extends Product with Serializable
Marks a member as a header of an event.
- final case class EventPayload() extends Product with Serializable
Marks a member as the payload of an event.
- final case class Example(title: String, documentation: Option[String] = None, input: Option[Document] = None, output: Option[Document] = None, error: Option[ExampleError] = None, allowConstraintErrors: Option[Boolean] = None) extends Product with Serializable
- final case class ExampleError(shapeId: Option[ShapeId] = None, content: Option[Document] = None) extends Product with Serializable
- type Examples = api.Examples.Type
Provides example inputs and outputs for operations.
- type ExternalDocumentation = api.ExternalDocumentation.Type
Provides a link to additional documentation.
- final case class HostLabel() extends Product with Serializable
Binds a top-level operation input structure member to a label in the hostPrefix of an endpoint trait.
- final case class Http(method: NonEmptyString, uri: NonEmptyString, code: Int = 200) extends Product with Serializable
Configures the HTTP bindings of an operation.
Configures the HTTP bindings of an operation.
- 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.
- final case class HttpApiKeyAuth(name: NonEmptyString, in: HttpApiKeyLocations, scheme: Option[NonEmptyString] = None) extends Product with Serializable
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.
- name
Defines the name of the HTTP header or query string parameter that contains the API key.
- in
Defines the location of where the key is serialized. This value can be set to
"header"
or"query"
.- scheme
Defines the security scheme to use in the
header. This can only be set if the "in" property is set toAuthorization
.header
- sealed abstract class HttpApiKeyLocations extends Value
- final case class HttpBasicAuth() extends Product with Serializable
HTTP Basic Authentication as defined in [RFC 2617](https://tools.ietf.org/html/rfc2617.html).
- final case class HttpBearerAuth() extends Product with Serializable
HTTP Bearer Authentication as defined in [RFC 6750](https://tools.ietf.org/html/rfc6750.html).
- final case class HttpChecksumRequired() extends Product with Serializable
Marks an operation as requiring checksum in its HTTP request.
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.
- final case class HttpDigestAuth() extends Product with Serializable
HTTP Digest Authentication as defined in [RFC 2617](https://tools.ietf.org/html/rfc2617.html).
- type HttpError = api.HttpError.Type
Defines an HTTP response code for an operation error.
- type HttpHeader = api.HttpHeader.Type
Binds a structure member to an HTTP header.
- final case class HttpLabel() extends Product with Serializable
Binds an operation input structure member to an HTTP label.
- final case class HttpPayload() extends Product with Serializable
Binds a single structure member to the body of an HTTP request.
- type HttpPrefixHeaders = api.HttpPrefixHeaders.Type
Binds a map of key-value pairs to prefixed HTTP headers.
- type HttpQuery = api.HttpQuery.Type
Binds an operation input structure member to a query string parameter.
- final case class HttpQueryParams() extends Product with Serializable
Binds an operation input structure member to the HTTP query string.
- final case class HttpResponseCode() extends Product with Serializable
Indicates that the structure member represents the HTTP response status code.
Indicates that the structure member represents the HTTP response status code. The value MAY differ from the HTTP status code provided on the response.
- final case class IdRef(selector: String = "*", failWhenMissing: Option[Boolean] = None, errorMessage: Option[String] = None) extends Product with Serializable
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.
- selector
Defines the selector that the resolved shape, if found, MUST match.
- failWhenMissing
When set to
true
, the shape ID MUST target a shape that can be found in the model.- 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.
- final case class IdempotencyToken() extends Product with Serializable
Defines the input member of an operation that is used by the server to identify and discard replayed requests.
- final case class Idempotent() extends Product with Serializable
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.
- final case class Input() extends Product with Serializable
Specializes a structure for use only as the input of a single operation.
- final case class Internal() extends Product with Serializable
Shapes marked with the internal trait are meant only for internal use and must not be exposed to customers.
- type JsonName = api.JsonName.Type
Allows a serialized object property name to differ from a structure member name used in the model.
- final case class Length(min: Option[Long] = None, max: Option[Long] = None) extends Product with Serializable
Constrains a shape to minimum and maximum number of elements or size.
Constrains a shape to minimum and maximum number of elements or size.
- min
Integer value that represents the minimum inclusive length of a shape.
- max
Integer value that represents the maximum inclusive length of a shape.
- type LocalMixinTrait = api.LocalMixinTrait.Type
- type LocalMixinTraitList = api.LocalMixinTraitList.Type
- type MediaType = api.MediaType.Type
Describes the contents of a blob shape using a media type as defined by RFC 6838 (e.g., "video/quicktime").
- final case class Mixin(localTraits: Option[List[LocalMixinTrait]] = None) extends Product with Serializable
Makes a structure or union a mixin.
- final case class NestedProperties() extends Product with Serializable
Adjusts the resource property mapping of a lifecycle operation to the targeted member.
- final case class NoReplace() extends Product with Serializable
Indicates that the put lifecycle operation of a resource can only be used to create a resource and cannot replace an existing resource.
- type NonEmptyString = api.NonEmptyString.Type
- type NonEmptyStringList = api.NonEmptyStringList.Type
- type NonEmptyStringMap = api.NonEmptyStringMap.Type
- final case class NotProperty() extends Product with Serializable
Explicitly excludes a member from resource property mapping or enables another trait to carry the same implied meaning.
- final case class OptionalAuth() extends Product with Serializable
Indicates that an operation can be called without authentication.
- final case class Output() extends Product with Serializable
Specializes a structure for use only as the output of a single operation.
- final case class Paginated(inputToken: Option[NonEmptyString] = None, outputToken: Option[NonEmptyString] = None, items: Option[NonEmptyString] = None, pageSize: Option[NonEmptyString] = None) extends Product with Serializable
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.
- 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.
- 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.
- 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.
- 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.
- type Pattern = api.Pattern.Type
Restricts string shape values to a specified regular expression.
- type PrimitiveShort = api.PrimitiveShort.Type
- final case class Private() extends Product with Serializable
Prevents models defined in a different namespace from referencing the targeted shape.
- final case class Property(name: Option[String] = None) extends Product with Serializable
Configures a structure member's resource property mapping behavior.
- final case class ProtocolDefinition(traits: Option[List[TraitShapeId]] = None, noInlineDocumentSupport: Option[Boolean] = None) extends Product with Serializable
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.- traits
The list of traits that protocol implementations must understand in order to successfully use the protocol.
- noInlineDocumentSupport
Set to true if inline documents are not supported by this protocol.
- final case class Range(min: Option[BigDecimal] = None, max: Option[BigDecimal] = None) extends Product with Serializable
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.
- min
Specifies the allowed inclusive minimum value.
- max
Specifies the allowed inclusive maximum value.
- final case class Readonly() extends Product with Serializable
Indicates that an operation is effectively read-only.
- final case class Recommended(reason: Option[String] = None) extends Product with Serializable
Indicates that a structure member SHOULD be set.
Indicates that a structure member SHOULD be set.
- reason
Provides a reason why the member is recommended.
- final case class Reference(resource: NonEmptyString, ids: Option[Map[NonEmptyString, NonEmptyString]] = None, service: Option[NonEmptyString] = None, rel: Option[NonEmptyString] = None) extends Product with Serializable
- resource
The shape ID of the referenced resource.
- 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.
- 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.
- rel
Defines the semantics of the relationship. The rel property SHOULD contain a link relation as defined in RFC 5988#section-4.
- type References = api.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.
- final case class RequestCompression(encodings: List[String]) extends Product with Serializable
Indicates that an operation supports compressing requests from clients to services.
Indicates that an operation supports compressing requests from clients to services.
- encodings
Defines the priority-ordered list of compression algorithms supported by the service operation.
- type RequestCompressionEncodingsList = api.RequestCompressionEncodingsList.Type
Defines the priority-ordered list of compression algorithms supported by the service operation.
- final case class Required() extends Product with Serializable
Marks a structure member as required, meaning a value for the member MUST be present.
- final case class RequiresLength() extends Product with Serializable
Indicates that the streaming blob must be finite and has a known size.
- type ResourceIdentifier = api.ResourceIdentifier.Type
Indicates that the targeted structure member provides an identifier for a resource.
- final case class Retryable(throttling: Option[Boolean] = None) extends Product with Serializable
Indicates that an error MAY be retried by the client.
Indicates that an error MAY be retried by the client.
- throttling
Classifies the retry as throttling.
- final case class Sensitive() extends Product with Serializable
Indicates that the data stored in the shape is sensitive and MUST be handled with care.
- type Since = api.Since.Type
Defines the version or date in which a shape or member was added to the model.
- final case class Sparse() extends Product with Serializable
Marks a list or map as sparse.
- final case class Streaming() extends Product with Serializable
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.
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.
- sealed abstract class StructurallyExclusive extends Value
- type Suppress = api.Suppress.Type
Suppresses validation events by ID for a given shape.
- type Tags = api.Tags.Type
Tags a shape with arbitrary tag names that can be used to filter and group shapes in the model.
- sealed abstract class TimestampFormat extends Value
- type Title = api.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.
- final case class Trait(selector: Option[String] = None, structurallyExclusive: Option[StructurallyExclusive] = None, conflicts: Option[List[NonEmptyString]] = None, breakingChanges: Option[List[TraitDiffRule]] = None) extends Product with Serializable
Makes a shape a trait.
Makes a shape a trait.
- 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.
- conflicts
The traits that this trait conflicts with.
- breakingChanges
Defines the backward compatibility rules of the trait.
- sealed abstract class TraitChangeSeverity extends Value
- sealed abstract class TraitChangeType extends Value
- final case class TraitDiffRule(change: TraitChangeType, severity: TraitChangeSeverity = smithy.api.TraitChangeSeverity.ERROR.widen, path: Option[String] = None, message: Option[String] = None) extends Product with Serializable
- change
Defines the type of change that is not allowed.
- severity
Defines the severity of the change. Defaults to ERROR if not defined.
- path
Defines a JSON Pointer to the value to evaluate.
- message
Provides a reason why the change is potentially backward incompatible.
- type TraitDiffRules = api.TraitDiffRules.Type
- type TraitShapeId = api.TraitShapeId.Type
- type TraitShapeIdList = api.TraitShapeIdList.Type
- final case class UniqueItems() extends Product with Serializable
Indicates that the items in a list MUST be unique.
- final case class Unit() extends Product with Serializable
- final case class UnitType() extends Product with Serializable
Specializes a structure as a unit type that has no meaningful value.
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.
- final case class Unstable() extends Product with Serializable
Indicates that the shape is unstable and could change in the future.
- final case class XmlAttribute() extends Product with Serializable
Serializes an object property as an XML attribute rather than a nested XML element.
- final case class XmlFlattened() extends Product with Serializable
Unwraps the values of a list, set, or map into the containing structure/union.
- type XmlName = api.XmlName.Type
Changes the serialized element or attribute name of a structure, union, or member.
- final case class XmlNamespace(uri: NonEmptyString, prefix: Option[NonEmptyString] = None) extends Product with Serializable
Adds an xmlns namespace definition URI to an XML element.
Adds an xmlns namespace definition URI to an XML element.
- uri
The namespace URI for scoping this XML element.
- prefix
The prefix for the given namespace.
Deprecated Type Members
- type Enum = api.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.
- Annotations
- @deprecated
- Deprecated
(Since version 2.0) The enum trait is replaced by the enum shape in Smithy 2.0
Value Members
- object AddedDefault extends Companion[AddedDefault] with Serializable
- object Auth extends Newtype[Set[AuthTraitReference]]
Defines the ordered list of supported authentication schemes.
- object AuthDefinition extends Companion[AuthDefinition] with Serializable
- object AuthTraitReference extends Newtype[ShapeId]
A string that must target an auth trait.
- object Box extends Companion[Box] with Serializable
- object ClientOptional extends Companion[ClientOptional] with Serializable
- object Cors extends Companion[Cors] with Serializable
- object Default extends Newtype[Document]
Provides a structure member with a default value.
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.
- object Deprecated extends Companion[Deprecated] with Serializable
- object Documentation extends Newtype[String]
Adds documentation to a shape or member using CommonMark syntax.
- object Endpoint extends Companion[Endpoint] with Serializable
- 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.
- object EnumDefinition extends Companion[EnumDefinition] with Serializable
- object EnumValue extends Newtype[Document]
Defines the value of an enum member.
- object Error extends Enumeration[Error] with Companion[Error] with Serializable
- object EventHeader extends Companion[EventHeader] with Serializable
- object EventPayload extends Companion[EventPayload] with Serializable
- object Example extends Companion[Example] with Serializable
- object ExampleError extends Companion[ExampleError] with Serializable
- object Examples extends Newtype[List[Example]]
Provides example inputs and outputs for operations.
- object ExternalDocumentation extends Newtype[Map[NonEmptyString, NonEmptyString]]
Provides a link to additional documentation.
- object HostLabel extends Companion[HostLabel] with Serializable
- object Http extends Companion[Http] with Serializable
- object HttpApiKeyAuth extends Companion[HttpApiKeyAuth] with Serializable
- object HttpApiKeyLocations extends Enumeration[HttpApiKeyLocations] with Companion[HttpApiKeyLocations] with Serializable
- object HttpBasicAuth extends Companion[HttpBasicAuth] with Serializable
- object HttpBearerAuth extends Companion[HttpBearerAuth] with Serializable
- object HttpChecksumRequired extends Companion[HttpChecksumRequired] with Serializable
- object HttpDigestAuth extends Companion[HttpDigestAuth] with Serializable
- object HttpError extends Newtype[Int]
Defines an HTTP response code for an operation error.
- object HttpHeader extends Newtype[String]
Binds a structure member to an HTTP header.
- object HttpLabel extends Companion[HttpLabel] with Serializable
- object HttpPayload extends Companion[HttpPayload] with Serializable
- object HttpPrefixHeaders extends Newtype[String]
Binds a map of key-value pairs to prefixed HTTP headers.
- object HttpQuery extends Newtype[String]
Binds an operation input structure member to a query string parameter.
- object HttpQueryParams extends Companion[HttpQueryParams] with Serializable
- object HttpResponseCode extends Companion[HttpResponseCode] with Serializable
- object IdRef extends Companion[IdRef] with Serializable
- object IdempotencyToken extends Companion[IdempotencyToken] with Serializable
- object Idempotent extends Companion[Idempotent] with Serializable
- object Input extends Companion[Input] with Serializable
- object Internal extends Companion[Internal] with Serializable
- object JsonName extends Newtype[String]
Allows a serialized object property name to differ from a structure member name used in the model.
- object Length extends Companion[Length] with Serializable
- object LocalMixinTrait extends Newtype[ShapeId]
- object LocalMixinTraitList extends Newtype[List[LocalMixinTrait]]
- 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").
- object Mixin extends Companion[Mixin] with Serializable
- object NestedProperties extends Companion[NestedProperties] with Serializable
- object NoReplace extends Companion[NoReplace] with Serializable
- object NonEmptyString extends Newtype[String]
- object NonEmptyStringList extends Newtype[List[NonEmptyString]]
- object NonEmptyStringMap extends Newtype[Map[NonEmptyString, NonEmptyString]]
- object NotProperty extends Companion[NotProperty] with Serializable
- object OptionalAuth extends Companion[OptionalAuth] with Serializable
- object Output extends Companion[Output] with Serializable
- object Paginated extends Companion[Paginated] with Serializable
- object Pattern extends Newtype[String]
Restricts string shape values to a specified regular expression.
- object PrimitiveShort extends Newtype[Short]
- object Private extends Companion[Private] with Serializable
- object Property extends Companion[Property] with Serializable
- object ProtocolDefinition extends Companion[ProtocolDefinition] with Serializable
- object Range extends Companion[Range] with Serializable
- object Readonly extends Companion[Readonly] with Serializable
- object Recommended extends Companion[Recommended] with Serializable
- object Reference extends Companion[Reference] with Serializable
- 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.
- object RequestCompression extends Companion[RequestCompression] with Serializable
- object RequestCompressionEncodingsList extends Newtype[List[String]]
Defines the priority-ordered list of compression algorithms supported by the service operation.
- object Required extends Companion[Required] with Serializable
- object RequiresLength extends Companion[RequiresLength] with Serializable
- object ResourceIdentifier extends Newtype[String]
Indicates that the targeted structure member provides an identifier for a resource.
- object Retryable extends Companion[Retryable] with Serializable
- object Sensitive extends Companion[Sensitive] with Serializable
- object Since extends Newtype[String]
Defines the version or date in which a shape or member was added to the model.
- object Sparse extends Companion[Sparse] with Serializable
- object Streaming extends Companion[Streaming] with Serializable
- object StructurallyExclusive extends Enumeration[StructurallyExclusive] with Companion[StructurallyExclusive] with Serializable
- object Suppress extends Newtype[List[String]]
Suppresses validation events by ID for a given shape.
- 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.
- object TimestampFormat extends Enumeration[TimestampFormat] with Companion[TimestampFormat] with Serializable
- 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.
- object Trait extends Companion[Trait] with Serializable
- object TraitChangeSeverity extends Enumeration[TraitChangeSeverity] with Companion[TraitChangeSeverity] with Serializable
- object TraitChangeType extends Enumeration[TraitChangeType] with Companion[TraitChangeType] with Serializable
- object TraitDiffRule extends Companion[TraitDiffRule] with Serializable
- object TraitDiffRules extends Newtype[List[TraitDiffRule]]
- object TraitShapeId extends Newtype[ShapeId]
- object TraitShapeIdList extends Newtype[List[TraitShapeId]]
- object UniqueItems extends Companion[UniqueItems] with Serializable
- object Unit extends Companion[Unit] with Serializable
- object UnitType extends Companion[UnitType] with Serializable
- object Unstable extends Companion[Unstable] with Serializable
- object XmlAttribute extends Companion[XmlAttribute] with Serializable
- object XmlFlattened extends Companion[XmlFlattened] with Serializable
- object XmlName extends Newtype[String]
Changes the serialized element or attribute name of a structure, union, or member.
- object XmlNamespace extends Companion[XmlNamespace] with Serializable
Deprecated Value Members
- 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.
- Annotations
- @deprecated
- Deprecated
(Since version 2.0) The enum trait is replaced by the enum shape in Smithy 2.0