| Interface | Description |
|---|---|
| StringListTrait.StringListTraitConstructor<T extends StringListTrait> |
Factory method to create a StringList provider.
|
| Trait |
Traits provide additional context and semantics to shapes.
|
| TraitFactory |
Creates traits using trait data from a model.
|
| TraitService |
Creates traits from
Node values. |
| Class | Description |
|---|---|
| AbstractTrait |
Base implementation of traits.
|
| AbstractTrait.Provider |
Basic provider implementation that returns the name of the
provided trait.
|
| AbstractTraitBuilder<T extends Trait,B extends AbstractTraitBuilder> |
Provides the shared logic that all trait builders need.
|
| AnnotationTrait |
Trait implementation for traits that are an empty object.
|
| AnnotationTrait.Provider<T extends AnnotationTrait> |
Trait provider that expects a boolean value of true.
|
| AuthDefinitionTrait |
This trait is attached to another trait to define an auth scheme.
|
| AuthDefinitionTrait.Builder | |
| AuthDefinitionTrait.Provider | |
| AuthTrait |
Specifies the auth schemes supported by default for operations
bound to a service.
|
| AuthTrait.Provider | |
| BoxTrait |
Indicates that a shape is boxed, meaning a value may or may not be present.
|
| BoxTrait.Provider | |
| CorsTrait | |
| CorsTrait.Builder | |
| CorsTrait.Provider | |
| DeprecatedTrait |
Marks a shape as deprecated.
|
| DeprecatedTrait.Builder |
Builder used to create a DeprecatedTrait.
|
| DeprecatedTrait.Provider | |
| DocumentationTrait |
Adds documentation to a model.
|
| DocumentationTrait.Provider | |
| DynamicTrait |
A general-purpose trait used to represent traits that are defined in the
model and have no concrete implementation.
|
| EffectiveTraitQuery |
Queries a model for effective traits bound to shapes and members.
|
| EffectiveTraitQuery.Builder |
Builds a reusable EffectiveTraitQuery.
|
| EndpointTrait |
Defines custom endpoint bindings of an operation.
|
| EndpointTrait.Builder | |
| EndpointTrait.Provider | |
| EnumDefinition |
An enum definition for the enum trait.
|
| EnumDefinition.Builder |
Builds a
EnumDefinition. |
| EnumTrait |
Constrains string values to one of the predefined enum constants.
|
| EnumTrait.Builder |
Builder used to create the enum trait.
|
| EnumTrait.Provider | |
| ErrorTrait |
Indicates that a structure can be used as an error.
|
| ErrorTrait.Provider | |
| EventHeaderTrait |
Marks a structure member of an event as an event header.
|
| EventHeaderTrait.Provider | |
| EventPayloadTrait |
Marks a structure member of an event as the event payload.
|
| EventPayloadTrait.Provider | |
| ExamplesTrait |
Defines examples for an operation.
|
| ExamplesTrait.Builder |
Builds and examples trait.
|
| ExamplesTrait.ErrorExample | |
| ExamplesTrait.ErrorExample.Builder | |
| ExamplesTrait.Example |
A specific example.
|
| ExamplesTrait.Example.Builder |
Builder used to create
ExamplesTrait.Examples. |
| ExamplesTrait.Provider | |
| ExternalDocumentationTrait |
Provides named links to external documentation.
|
| ExternalDocumentationTrait.Builder |
Builder used to create the external documentation trait.
|
| ExternalDocumentationTrait.Provider | |
| HostLabelTrait |
Binds an input member to a label in the hostPrefix of an endpoint
trait on an operation.
|
| HostLabelTrait.Provider | |
| HttpApiKeyAuthTrait |
An HTTP-specific authentication scheme that sends an arbitrary
API key in a header or query string parameter.
|
| HttpApiKeyAuthTrait.Builder | |
| HttpApiKeyAuthTrait.Provider | |
| HttpBasicAuthTrait |
An auth scheme trait uses HTTP basic auth.
|
| HttpBasicAuthTrait.Provider | |
| HttpBearerAuthTrait |
An auth scheme trait uses HTTP bearer auth.
|
| HttpBearerAuthTrait.Provider | |
| HttpChecksumRequiredTrait |
Indicates that an operation requires a checksum in its HTTP request.
|
| HttpChecksumRequiredTrait.Provider | |
| HttpDigestAuthTrait |
An auth scheme trait uses HTTP digest auth.
|
| HttpDigestAuthTrait.Provider | |
| HttpErrorTrait |
Defines a custom HTTP status code for error structures.
|
| HttpErrorTrait.Provider | |
| HttpHeaderTrait |
Binds a member to an HTTP header.
|
| HttpHeaderTrait.Provider | |
| HttpLabelTrait |
Binds a member to a URI label of an input of an operation using
the member name.
|
| HttpLabelTrait.Provider | |
| HttpPayloadTrait |
Binds a single structure member to the payload of an HTTP request.
|
| HttpPayloadTrait.Provider | |
| HttpPrefixHeadersTrait |
Binds a map structure member to prefixed HTTP headers.
|
| HttpPrefixHeadersTrait.Provider | |
| HttpQueryParamsTrait |
Binds a map structure member to the HTTP query string.
|
| HttpQueryParamsTrait.Provider | |
| HttpQueryTrait |
Binds a member to an HTTP query string.
|
| HttpQueryTrait.Provider | |
| HttpResponseCodeTrait |
Indicates that the structure member represents the HTTP response
status code.
|
| HttpResponseCodeTrait.Provider | |
| HttpTrait |
Defines the HTTP request and response code bindings of an operation.
|
| HttpTrait.Builder |
Builder used to create an Http trait.
|
| HttpTrait.Provider | |
| IdempotencyTokenTrait |
Defines an operation input member that is used to prevent
replayed requests.
|
| IdempotencyTokenTrait.Provider | |
| IdempotentTrait |
Indicates that an operation is idempotent.
|
| IdempotentTrait.Provider | |
| IdRefTrait |
Indicates that a string value must contain a valid shape ID.
|
| IdRefTrait.Builder | |
| IdRefTrait.Provider | |
| InputTrait |
Specializes a structure as the input of a single operation.
|
| InputTrait.Provider | |
| InternalTrait |
Shapes marked with the internal trait are meant only for internal use and
must not be exposed to customers.
|
| InternalTrait.Provider | |
| JsonNameTrait |
Provides a custom name to use when serializing a structure member
name as a JSON object property.
|
| JsonNameTrait.Provider | |
| LengthTrait |
Constrains a shape to minimum and maximum number of elements or size.
|
| LengthTrait.Builder |
Builder used to create a LongTrait.
|
| LengthTrait.Provider | |
| MediaTypeTrait |
Documents the media type of a blob shape.
|
| MediaTypeTrait.Provider | |
| NoReplaceTrait |
Indicates that the put lifecycle operation of a resource
can only be used to create a resource and cannot replace
an existing resource.
|
| NoReplaceTrait.Provider | |
| OptionalAuthTrait |
Indicates that an operation / service supports unauthenticated access.
|
| OptionalAuthTrait.Provider | |
| OutputTrait |
Specializes a structure as the output of a single operation.
|
| OutputTrait.Provider | |
| PaginatedTrait |
Defines the pagination functionality of an operation.
|
| PaginatedTrait.Builder |
Builds the paginated trait.
|
| PaginatedTrait.Provider | |
| PatternTrait |
Restricts string values to a specified regular expression.
|
| PatternTrait.Provider | |
| PrivateTrait |
Indicates that a shape cannot be targeted outside of the namespace in
which it was defined.
|
| PrivateTrait.Provider | |
| ProtocolDefinitionTrait |
A trait that is attached to other traits to define a Smithy protocol.
|
| ProtocolDefinitionTrait.Builder | |
| ProtocolDefinitionTrait.Provider | |
| RangeTrait |
Constrains a shape to minimum and maximum numeric range.
|
| RangeTrait.Builder |
Builder used to create a RangeTrait.
|
| RangeTrait.Provider | |
| ReadonlyTrait |
Indicates that an operation is read-only.
|
| ReadonlyTrait.Provider | |
| RecommendedTrait | |
| RecommendedTrait.Builder |
Builder used to create a RecommendedTrait.
|
| RecommendedTrait.Provider | |
| ReferencesTrait |
Defines references to resources within a structure.
|
| ReferencesTrait.Builder |
Builder use to create the references trait.
|
| ReferencesTrait.Provider | |
| ReferencesTrait.Reference |
Reference to a resource.
|
| ReferencesTrait.Reference.Builder |
Builder to create a
ReferencesTrait.Reference. |
| RequiredTrait |
Indicates that a structure member is required.
|
| RequiredTrait.Provider | |
| RequiresLengthTrait |
Indicates that the streaming blob must be finite and has a known size.
|
| RequiresLengthTrait.Provider | |
| ResourceIdentifierTrait |
Binds an operation input member to a named identifier of the resource to
which the operation is bound.
|
| ResourceIdentifierTrait.Provider | |
| RetryableTrait |
Marks an error structure as retryable.
|
| RetryableTrait.Builder |
Builds a
RetryableTrait trait. |
| RetryableTrait.Provider | |
| SensitiveTrait |
Indicates that the data stored in the shape or member is sensitive and
should be handled with care.
|
| SensitiveTrait.Provider | |
| SinceTrait |
Defines when a shape or member was added to the model.
|
| SinceTrait.Provider | |
| SparseTrait |
Indicates that a list or map is sparse, meaning they may contain nulls.
|
| SparseTrait.Provider | |
| StreamingTrait |
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.
|
| StreamingTrait.Provider | |
| StringListTrait |
Contains abstract functionality to build traits that contain a list
of strings.
|
| StringListTrait.Builder<TRAIT extends StringListTrait,BUILDER extends StringListTrait.Builder> |
Abstract builder to build a StringList trait.
|
| StringListTrait.Provider<T extends StringListTrait> |
Trait provider that expects a list of string values.
|
| StringTrait |
Abstract trait class for traits that contain only a string value.
|
| StringTrait.Provider<T extends StringTrait> |
Trait provider that expects a string value.
|
| SuppressTrait | |
| SuppressTrait.Builder | |
| SuppressTrait.Provider | |
| TagsTrait |
Applies tags to a shape.
|
| TagsTrait.Builder | |
| TagsTrait.Provider | |
| TimestampFormatTrait |
Defines a custom serialization format for a timestamp.
|
| TimestampFormatTrait.Provider | |
| TitleTrait |
Provides a human-readable proper noun title to services and resources.
|
| TitleTrait.Provider | |
| TraitDefinition |
Trait definition trait.
|
| TraitDefinition.Builder |
Builder to create a TraitDefinition.
|
| TraitDefinition.Provider | |
| UniqueItemsTrait | Deprecated |
| UniqueItemsTrait.Provider | |
| UnitTypeTrait | |
| UnitTypeTrait.Provider | |
| UnstableTrait |
Marks a shape as unstable.
|
| UnstableTrait.Provider | |
| XmlAttributeTrait |
Marks a structure member to be serialized to/from an XML attribute.
|
| XmlAttributeTrait.Provider | |
| XmlFlattenedTrait | |
| XmlFlattenedTrait.Provider | |
| XmlNamespaceTrait |
Defines the XML Namespace prefix and URI.
|
| XmlNamespaceTrait.Builder |
Builder used to create an XmlNamespace trait.
|
| XmlNamespaceTrait.Provider | |
| XmlNameTrait |
Provides a custom name to use when serializing a structure member
name as a XML object property.
|
| XmlNameTrait.Provider |
| Enum | Description |
|---|---|
| HttpApiKeyAuthTrait.Location | |
| TimestampFormatTrait.Format |
The known
timestampFormat values. |
| TraitDefinition.StructurallyExclusive |
The structural exclusion semantics of the trait.
|