smithy.api
Members list
Type members
Classlikes
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[AddedDefault]trait Has[AddedDefault]trait ShapeTag[AddedDefault]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- AddedDefault.type
Defines the list of authentication schemes supported by a service or operation.
Defines the list of authentication schemes supported by a service or operation.
Attributes
- member
A string that must target an auth trait.
- Graph
- Supertypes
- Self type
- Auth.type
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.
Attributes
- traits
Defines a list of traits that auth implementations must understand in order to successfully use the scheme.
- Companion:
- object
- Graph
- Supertypes
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[AuthDefinition]trait Has[AuthDefinition]trait ShapeTag[AuthDefinition]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- AuthDefinition.type
A string that must target an auth trait.
Used only in Smithy 1.0 to indicate that a shape is boxed. This trait cannot be used in Smithy 2.0 models.
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
- Graph
- Supertypes
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:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[ClientOptional]trait Has[ClientOptional]trait ShapeTag[ClientOptional]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- ClientOptional.type
Defines how a service supports cross-origin resource sharing.
Defines how a service supports cross-origin resource sharing.
Attributes
- 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.
- Companion:
- object
- Graph
- Supertypes
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
- Graph
- Supertypes
- Self type
- Default.type
Marks a shape or member as deprecated.
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[Deprecated]trait Has[Deprecated]trait ShapeTag[Deprecated]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- Deprecated.type
Adds documentation to a shape or member using CommonMark syntax.
Adds documentation to a shape or member using CommonMark syntax.
Attributes
- Graph
- Supertypes
- Self type
- Documentation.type
Configures a custom operation endpoint.
Configures a custom operation endpoint.
Attributes
- 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.
- Companion:
- object
- Graph
- Supertypes
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
- Graph
- Supertypes
- Self type
- EnumConstantBodyName.type
An enum definition for the enum trait.
An enum definition for the enum trait.
Attributes
- deprecated
Whether the enum value should be considered deprecated.
- documentation
Provides optional documentation about the enum constant value.
- name
Defines the name, or label, 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.
- Companion:
- object
- Graph
- Supertypes
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[EnumDefinition]trait Has[EnumDefinition]trait ShapeTag[EnumDefinition]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- EnumDefinition.type
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
- Graph
- Supertypes
- Known subtypes
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[EventHeader]trait Has[EventHeader]trait ShapeTag[EventHeader]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- EventHeader.type
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[EventPayload]trait Has[EventPayload]trait ShapeTag[EventPayload]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- EventPayload.type
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[ExampleError]trait Has[ExampleError]trait ShapeTag[ExampleError]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- ExampleError.type
Provides a link to additional documentation.
Provides a link to additional documentation.
Attributes
- Graph
- Supertypes
- Self type
Binds a top-level operation input structure member to a label in the hostPrefix of an endpoint trait.
Configures the HTTP bindings of an operation.
Configures the HTTP bindings of an operation.
Attributes
- code
The HTTP status code of a successful response.
- 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.
- Companion:
- object
- Graph
- Supertypes
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.
Attributes
- 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 on the
Authorization
header value This can only be set if the "in" property is set toheader
.- Companion:
- object
- Graph
- Supertypes
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[HttpApiKeyAuth]trait Has[HttpApiKeyAuth]trait ShapeTag[HttpApiKeyAuth]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- HttpApiKeyAuth.type
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Sumtrait Mirrortrait Enumeration[HttpApiKeyLocations]trait Companion[HttpApiKeyLocations]trait Has[HttpApiKeyLocations]trait ShapeTag[HttpApiKeyLocations]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- HttpApiKeyLocations.type
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[HttpBasicAuth]trait Has[HttpBasicAuth]trait ShapeTag[HttpBasicAuth]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- HttpBasicAuth.type
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[HttpBearerAuth]trait Has[HttpBearerAuth]trait ShapeTag[HttpBearerAuth]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- HttpBearerAuth.type
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:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[HttpChecksumRequired]trait Has[HttpChecksumRequired]trait ShapeTag[HttpChecksumRequired]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- HttpChecksumRequired.type
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[HttpDigestAuth]trait Has[HttpDigestAuth]trait ShapeTag[HttpDigestAuth]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- HttpDigestAuth.type
Binds a structure member to an HTTP header.
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[HttpPayload]trait Has[HttpPayload]trait ShapeTag[HttpPayload]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- HttpPayload.type
Binds a map of key-value pairs to prefixed HTTP headers.
Binds a map of key-value pairs to prefixed HTTP headers.
Attributes
- Graph
- Supertypes
- Self type
- HttpPrefixHeaders.type
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[HttpQueryParams]trait Has[HttpQueryParams]trait ShapeTag[HttpQueryParams]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- HttpQueryParams.type
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:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[HttpResponseCode]trait Has[HttpResponseCode]trait ShapeTag[HttpResponseCode]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- HttpResponseCode.type
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.
Attributes
- 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.
- Companion:
- object
- Graph
- Supertypes
Defines the input member of an operation that is used by the server to identify and discard replayed requests.
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[IdempotencyToken]trait Has[IdempotencyToken]trait ShapeTag[IdempotencyToken]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- IdempotencyToken.type
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:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[Idempotent]trait Has[Idempotent]trait ShapeTag[Idempotent]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- Idempotent.type
Shapes marked with the internal trait are meant only for internal use and must not be exposed to customers.
The jsonName trait allows a serialized object property name to differ from a structure member name used in the model.
Constrains a shape to minimum and maximum number of elements or size.
Constrains a shape to minimum and maximum number of elements or size.
Attributes
- max
Integer value that represents the maximum inclusive length of a shape.
- min
Integer value that represents the minimum inclusive length of a shape.
- Companion:
- object
- Graph
- Supertypes
Attributes
- Graph
- Supertypes
- Self type
- LocalMixinTrait.type
Attributes
- Graph
- Supertypes
- Self type
- LocalMixinTraitList.type
Describes the contents of a blob shape using a media type as defined by RFC 6838 (e.g., "video/quicktime").
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[NestedProperties]trait Has[NestedProperties]trait ShapeTag[NestedProperties]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- NestedProperties.type
Indicates that the put lifecycle operation of a resource can only be used to create a resource and cannot replace an existing resource.
Attributes
- Graph
- Supertypes
- Self type
- NonEmptyString.type
Attributes
- Graph
- Supertypes
- Self type
- NonEmptyStringList.type
Attributes
- Graph
- Supertypes
- Self type
- NonEmptyStringMap.type
Explicitly excludes a member from resource property mapping or enables another trait to carry the same implied meaning.
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[NotProperty]trait Has[NotProperty]trait ShapeTag[NotProperty]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- NotProperty.type
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[OptionalAuth]trait Has[OptionalAuth]trait ShapeTag[OptionalAuth]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- OptionalAuth.type
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.
Attributes
- 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.
- Companion:
- object
- Graph
- Supertypes
Attributes
- Graph
- Supertypes
- Self type
- PrimitiveShort.type
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.
Attributes
- noInlineDocumentSupport
Set to true if inline documents are not supported by this protocol.
- traits
Defines a list of traits that protocol implementations must understand in order to successfully use the protocol.
- Companion:
- object
- Graph
- Supertypes
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[ProtocolDefinition]trait Has[ProtocolDefinition]trait ShapeTag[ProtocolDefinition]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- ProtocolDefinition.type
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.
Attributes
- max
Specifies the allowed inclusive maximum value.
- min
Specifies the allowed inclusive minimum value.
- Companion:
- object
- Graph
- Supertypes
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[Recommended]trait Has[Recommended]trait ShapeTag[Recommended]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- Recommended.type
Attributes
- 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.
- Companion:
- object
- Graph
- Supertypes
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
- Graph
- Supertypes
- Self type
- References.type
Indicates that an operation supports compressing requests from clients to services.
Indicates that an operation supports compressing requests from clients to services.
Attributes
- encodings
Defines the priority-ordered list of compression algorithms supported by the service operation.
- Companion:
- object
- Graph
- Supertypes
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[RequestCompression]trait Has[RequestCompression]trait ShapeTag[RequestCompression]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- RequestCompression.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
- Graph
- Supertypes
- Self type
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[RequiresLength]trait Has[RequiresLength]trait ShapeTag[RequiresLength]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- RequiresLength.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
- Graph
- Supertypes
- Self type
- ResourceIdentifier.type
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
- Graph
- Supertypes
Attributes
- 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.
- Companion:
- object
- Graph
- Supertypes
- Known subtypes
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Sumtrait Mirrortrait Enumeration[StructurallyExclusive]trait Companion[StructurallyExclusive]trait Has[StructurallyExclusive]trait ShapeTag[StructurallyExclusive]trait HasIdclass Objecttrait Matchableclass Any
- Self type
Tags a shape with arbitrary tag names that can be used to filter and group shapes in the model.
Attributes
- 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).
- Companion:
- object
- Graph
- Supertypes
- Known subtypes
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Sumtrait Mirrortrait Enumeration[TimestampFormat]trait Companion[TimestampFormat]trait Has[TimestampFormat]trait ShapeTag[TimestampFormat]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- TimestampFormat.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
- Graph
- Supertypes
- Self type
- Title.type
Makes a shape a trait.
Makes a shape a trait.
Attributes
- 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.
- Companion:
- object
- Graph
- Supertypes
Attributes
- 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.
- Companion:
- object
- Graph
- Supertypes
- Known subtypes
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Sumtrait Mirrortrait Enumeration[TraitChangeSeverity]trait Companion[TraitChangeSeverity]trait Has[TraitChangeSeverity]trait ShapeTag[TraitChangeSeverity]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- TraitChangeSeverity.type
Attributes
- 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 already existed, continues to exist, but it is modified.
- Companion:
- object
- Graph
- Supertypes
- Known subtypes
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Sumtrait Mirrortrait Enumeration[TraitChangeType]trait Companion[TraitChangeType]trait Has[TraitChangeType]trait ShapeTag[TraitChangeType]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- TraitChangeType.type
Attributes
- 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.
- Companion:
- object
- Graph
- Supertypes
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[TraitDiffRule]trait Has[TraitDiffRule]trait ShapeTag[TraitDiffRule]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- TraitDiffRule.type
Attributes
- Graph
- Supertypes
- Self type
- TraitDiffRules.type
Attributes
- Graph
- Supertypes
- Self type
- TraitShapeId.type
Attributes
- Graph
- Supertypes
- Self type
- TraitShapeIdList.type
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[UniqueItems]trait Has[UniqueItems]trait ShapeTag[UniqueItems]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- UniqueItems.type
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
- Graph
- Supertypes
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[XmlAttribute]trait Has[XmlAttribute]trait ShapeTag[XmlAttribute]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- XmlAttribute.type
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[XmlFlattened]trait Has[XmlFlattened]trait ShapeTag[XmlFlattened]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- XmlFlattened.type
Adds an xmlns namespace definition URI to an XML element.
Attributes
- Companion:
- class
- Graph
- Supertypes
- trait Producttrait Mirrortrait Companion[XmlNamespace]trait Has[XmlNamespace]trait ShapeTag[XmlNamespace]trait HasIdclass Objecttrait Matchableclass Any
- Self type
- XmlNamespace.type
Deprecated classlikes
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.
Attributes
- member
An enum definition for the enum trait.
- Deprecated
[Since version 2.0]
The enum trait is replaced by the enum shape in Smithy 2.0- Graph
- Supertypes
- Self type
- Enum.type
Types
Defines the list of authentication schemes supported by a service or operation.
Defines the list of authentication schemes supported by a service or operation.
Attributes
- member
A string that must target an auth trait.
A string that must target an auth trait.
A string that must target an auth trait.
Attributes
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
Adds documentation to a shape or member using CommonMark syntax.
Adds documentation to a shape or member using CommonMark syntax.
Attributes
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
Defines the value of an enum member.
Defines the value of an enum member.
Attributes
Provides example inputs and outputs for operations.
Provides example inputs and outputs for operations.
Attributes
Provides a link to additional documentation.
Provides a link to additional documentation.
Attributes
Defines an HTTP response code for an operation error.
Defines an HTTP response code for an operation error.
Attributes
Binds a structure member to an HTTP header.
Binds a structure member to an HTTP header.
Attributes
Binds a map of key-value pairs to prefixed HTTP headers.
Binds a map of key-value pairs to prefixed HTTP headers.
Attributes
Binds an operation input structure member to a query string parameter.
Binds an operation input structure member to a query string parameter.
Attributes
The jsonName trait allows a serialized object property name to differ from a structure member name used in the model.
The jsonName trait allows a serialized object property name to differ from a structure member name used in the model.
Attributes
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
Restricts string shape values to a specified regular expression.
Restricts string shape values to a specified regular expression.
Attributes
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
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
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
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
Suppresses validation events by ID for a given shape.
Suppresses validation events by ID for a given shape.
Attributes
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
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
Deprecated types
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.
Attributes
- member
An enum definition for the enum trait.
- Deprecated
[Since version 2.0]
The enum trait is replaced by the enum shape in Smithy 2.0