smithy.api

Indicates that the default trait was added to a member.

Defines the list of authentication schemes supported by a service or operation.

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.

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.

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.

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.

Defines how a service supports cross-origin resource sharing.

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.

Marks a shape or member as deprecated.

Adds documentation to a shape or member using CommonMark syntax.

Configures a custom operation endpoint.

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.

An enum definition for the enum trait.

Defines the value of an enum member.

Indicates that a structure shape represents an error.

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

Marks a member as a header of an event.

Marks a member as the payload of an event.

Provides example inputs and outputs for operations.

Provides a link to additional documentation.

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.

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

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

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

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.

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

Defines an HTTP response code for an operation error.

Binds a structure member to an HTTP header.

Binds an operation input structure member to an HTTP label.

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

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

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

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

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 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.

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

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.

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

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.

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

Makes a structure or union a mixin.

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

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

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

Indicates that an operation can be called without authentication.

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

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.

Restricts string shape values to a specified regular expression.

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

Configures a structure member's resource property mapping behavior.

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.

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

Indicates that an operation is effectively read-only.

Indicates that a structure member SHOULD be set.

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.

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

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

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

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

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

Indicates that an error MAY be retried by the client.

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

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

Marks a list or map as sparse.

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.

Suppresses validation events by ID for a given shape.

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

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.

Makes a shape a trait.