All Classes and Interfaces
Class
Description
Abstract builder used to create
Shapes.Base implementation of traits.
Basic provider implementation that returns the name of the
provided trait.
Provides the shared logic that all trait builders need.
Abstract Validator class that has helpful methods for emitting events.
Trait implementation for traits that are an empty object.
Trait provider that expects a boolean value of true.
Represents an array of nodes.
Builder used to efficiently create an ArrayNode.
Selector attribute values are the data model of selectors.
This trait is attached to another trait to define an auth scheme.
Specifies the auth schemes supported by default for operations
bound to a service.
All
@auth trait values referenced from an operation must refer
to authentication traits applied to service shapes that enclose the
operation.Represents a
integer shape.Builder used to create a
BigDecimalShape.Represents a
integer shape.Builder used to create a
BigIntegerShape.Represents a
blob shape.Builder used to create a
BlobShape.Represents a boolean node.
Represents a
boolean shape.Builder used to create a
BooleanShape.Computes all of the parent shapes of resources and operations from the bottom-up.
Deprecated.
Deprecated.
Represents a
byte shape.Builder used to create a
ByteShape.Options that can be enabled when changing shape types.
Removes operation bindings from resources and services when operations
are removed, and removes resource bindings from services and resources when
resources are removed.
Removes references to removed structures from operation
input, output, and errors.
Removes references to resources that are removed from
ReferencesTraits.Removes "rename" entries from service shapes when a shape is removed.
Cleans up structure, union, enum, and intEnum shapes after shapes are removed.
Removes traits from
AuthDefinitionTrait and
ProtocolDefinitionTrait traits that refer to removed shapes.Indicates that non-authoritative code generators should treat a member
as optional even if it's required or default.
Abstract class representing Set and List shapes.
Builder used to create a List or Set shape.
This validation event formatter outputs a validation event that points
to the source code line that triggered the event.
Provides a default value for a shape or member.
Finds operations that are meant to partially update a resource, but that use
members with default values in their input shapes, making it impossible
to know if the member was provided explicitly or defaulted.
Marks a shape as deprecated.
Builder used to create a DeprecatedTrait.
Emits a validation event if a model contains shapes that are bound to deprecated traits.
Adds documentation to a model.
Represents a
document shape.Builder used to create a
DocumentShape.Represents a
double shape.Builder used to create a
DoubleShape.A general-purpose trait used to represent traits that are defined in the
model and have no concrete implementation.
Queries a model for effective traits bound to shapes and members.
Builds a reusable EffectiveTraitQuery.
Emits a validation event for each shape that matches a selector.
EmitEachSelector configuration settings.
Emits a validation event if no shapes match the given selector.
EmitNoneSelector configuration settings.
Defines custom endpoint bindings of an operation.
Abstract class representing service and resource shapes.
Builder used to create a Service or Resource shape.
An enum definition for the enum trait.
Builds a
EnumDefinition.Emits an error validation event if an enum member's enumValue trait has the wrong type,
if there are any duplicate values in a single enum, if the enum's default value is
set using the enumValue trait, or if an intEnum member lacks an enumValue trait.
Deprecated.
Builder used to create the enum trait.
Ensures that enum traits are valid.
Sets the value for an enum member.
Indicates that a structure can be used as an error.
Marks a structure member of an event as an event header.
Marks a structure member of an event as the event payload.
Ensures that when an event structure contains an eventPayload member,
that all other members are bound to headers.
Index of operation shapes to event stream information.
Contains extracted event stream information.
Defines examples for an operation.
Builds an examples trait.
A specific example.
Builder used to create
ExamplesTrait.Examples.Validates that examples traits are valid for their operations.
Validates traits that can only be applied to a single structure member.
Thrown by
Node methods that expect a node to be of a particular
type or to have a particular member.Provides named links to external documentation.
Builder used to create the external documentation trait.
Represents a
integer shape.Builder used to create a
FloatShape.A value that can be traced back to a
SourceLocation.Binds an input member to a label in the hostPrefix of an endpoint
trait on an operation.
Validates that hostLabel traits are applied correctly for operation inputs.
An HTTP-specific authentication scheme that sends an arbitrary
API key in a header or query string parameter.
Validates that if an HttpApiKeyAuth trait's scheme field is present then
the 'in' field must specify "header".
An auth scheme trait uses HTTP basic auth.
An auth scheme trait uses HTTP bearer auth.
Defines an HTTP message member binding.
HTTP binding types.
Computes and indexes the explicit and implicit HTTP bindings of a model.
Validates that if any operation in a service uses the http trait,
then all operations use them.
Emits warnings when a structure member has an HTTP binding trait that will be ignored
in some contexts to which it is bound.
Indicates that an operation requires a checksum in its HTTP request.
An auth scheme trait uses HTTP digest auth.
Defines a custom HTTP status code for error structures.
Binds a member to an HTTP header.
Validates that httpHeader traits are case-insensitively unique.
Binds a member to a URI label of an input of an operation using
the member name.
Validates that httpLabel traits are applied correctly for operation inputs.
Validates that `http` traits applied to operation shapes use the most
semantically appropriate HTTP method according to RFC 9110.
Binds a single structure member to the payload of an HTTP request.
Validates that if a payload trait is present then all members of the
input of an operation are bound to part of the message.
Binds a map structure member to prefixed HTTP headers.
Validates that httpHeader traits do not case-insensitively start with an
httpPrefixHeader on the same structure.
Binds a map structure member to the HTTP query string.
When the `httpQueryParams` trait is used, this validator emits a NOTE when another member of the container shape
applies the `httpQuery` trait which may result in a conflict within the query string.
Binds a member to an HTTP query string.
Validates that httpQuery trait bindings are case-sensitively unique.
Ensures that HTTP response codes are appropriate for operations and errors.
Indicates that the structure member represents the HTTP response
status code.
Defines the HTTP request and response code bindings of an operation.
Builder used to create an Http trait.
Validates that no two URIs in a service conflict with each other.
Validates that at most one greedy label is present in the pattern, and, if any greedy label is present that it's
the last label in the pattern.
Emits warnings when a structure member has an idempotency token trait that will be ignored.
Defines an operation input member that is used to prevent
replayed requests.
Indicates that an operation is idempotent.
Index of operation shapes to the identifiers bound to the operation.
Represents a parsed token from the Smithy IDL.
Iterates over a Smithy IDL model as a series of tokens.
Indicates that a string value must contain a valid shape ID.
Specializes a structure as the input of a single operation.
Represents an
integer shape.Builder used to create a
IntegerShape.Builder used to create a
IntegerShape.Shapes marked with the internal trait are meant only for internal use and
must not be exposed to customers.
Exception thrown for invalid patterns.
Exception thrown for invalid HTTP URI patterns.
Provides a custom name to use when serializing a structure member
name as a JSON object property.
A marker interface used to indicate that a class contains an index of
computed knowledge about a
Model.Constrains a shape to minimum and maximum number of elements or size.
Builder used to create a LongTrait.
Writes
ValidationEvent objects as a single line string.Represents a
list shape.Builder used to create a
ListShape.Represents a
integer shape.Builder used to create a
LongShape.Represents a
map shape.Builder used to create a
ListShape.Documents the media type of a blob shape.
Represents a member that targets another shape by ID.
Builder used to create a
MemberShape.Validates if a member matches a resource identifier without the
proper configuration of a `@references` trait.
Builder used to create a MixinTrait.
A Smithy model that contains shapes, traits, metadata, and various
computed information used to interpret the model.
Builder used to create a Model.
Assembles and validates a
Model from documents, files, shapes, and
other sources.Creates a
ValidationEventDecorator that applies custom suppressions, custom severity overrides,
suppressions parsed from model metadata, and severity overrides parsed from model metadata.Discovers Smithy models by finding all
META-INF/smithy/manifest
files on the class path and loading all of the newline separated relative
model files referenced from the manifest.Exception thrown when a model fails to be imported.
Serializes a
Model to an ObjectNode.Builder used to create
ModelSerializer.Thrown when the syntax of the IDL is invalid.
Class used to transform
Models.Plugin service used with ModelTransformer.
Exception thrown when a model transformation error occurs.
Provides the neighbor relationships for a given shape.
Provides a cache of precomputed neighbors for models.
Indicates that the contents of a structure member contain the top-level
properties of the associated resource.
An auth scheme trait for
smithy.api#noAuth which indicates no authentication.Base class of for all Smithy model nodes.
Non-numeric values for floats and doubles.
Exception encountered during deserialization.
Serializes and deserializes Smithy
Node values to/from objects.Specifies the behavior of the mapper when attempting to deserialize an unknown property.
JSON Pointer abstraction over Smithy
Node values.Exception encountered during serialization.
The set of possible node types.
Builds a
NodeValidationVisitor.Features to use when validating.
Validation context to pass to each NodeValidatorPlugin.
Node visitor interface.
Creates
NodeVisitor that return a default value when necessary
when visiting nodes.Detects when a protocol indicates that it does not support inline documents,
yet the protocol trait is attached to a service that uses inline documents.
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 a top level input/output structure member is not associated
with a resource property.
An index that checks if a member is nullable.
Defines the type of model consumer to assume when determining if
a member should be considered nullable or always present.
Represents a null node.
Represents a number node.
Abstract class representing all numeric types.
Represents an object node.
Builder used to efficiently create an ObjectNode.
Index of operation IDs to their resolved input, output, and error
structures.
Represents an API operation.
Builder used to create a
OperationShape.Validates operation inputs, outputs, and the use of
input
and output traits.Indicates that an operation / service supports unauthenticated access.
Used to provide the original shape ID of a shape that is renamed
in the semantic model.
Specializes a structure as the output of a single operation.
Index of operation shapes to paginated trait information.
Defines the pagination functionality of an operation.
Builds the paginated trait.
Validates paginated traits.
Resolved and valid pagination information about an operation in a service.
Utility methods that act on a
SimpleParser and parse
Smithy grammar productions.Finds the possible directed relationship paths from a starting shape to
shapes connected to the starting shape that match a selector.
An immutable
Relationship path from a starting shape to an end shape.Restricts string values to a specified regular expression.
Emits a validation event if a pattern trait is not anchored.
Represents the prelude model available to every Smithy model.
Ensures that shapes in separate namespaces don't refer to shapes in other
namespaces that are marked as private.
Indicates that a shape cannot be targeted outside of the namespace in
which it was defined.
Index of member shape to associated resource property information.
Configures how a structure member maps to a resource property.
A trait that is attached to other traits to define a Smithy protocol.
Constrains a shape to minimum and maximum numeric range.
Builder used to create a RangeTrait.
Ensures that range traits are valid.
Indicates that an operation is read-only.
Builder used to create a RecommendedTrait.
Defines references to resources within a structure.
Builder use to create the references trait.
Reference to a resource.
Builder to create a
ReferencesTrait.Reference.Validates that references are correct.
Represent a direct relationship between two shapes.
Defines the directionality of a relationship.
Defines the relationship types between neighboring shapes.
Removes mixins from shapes when a mixin is removed from the model.
Removes traits from shapes when trait definitions are removed.
Indicates that an operation supports compressing requests from clients to services.
Validates the requestCompression trait.
Indicates that a structure member is required.
Indicates that the streaming blob must be finite and has a known size.
Validates that resource references do not introduce circular hierarchies.
Validates that operations bound to resource shapes have identifier
bindings for all the identifiers of the parent of the binding resource,
that operations bound to a resource with the
collection
trait are bound using a collection binding, and operations bound with
no collection trait are bound using an instance binding.Binds an operation input member to a named identifier of the resource to
which the operation is bound.
Validates that the resource identifiers of children of a resource contain
all of the identifiers as their parents.
Validates that resource are applied appropriately to resources.
Validates that resource properties are correctly used in resource-bound operations.
Represents a
resource shape.Builder used to create a
ResourceShape.Marks an error structure as retryable.
Builds a
RetryableTrait trait.Matches a set of shapes using a selector expression.
Deprecated.
This class is no longer necessary.
Represents a selector match found in the model.
Starting environment context object used when evaluating a selector.
Exception thrown when a selector evaluation is invalid.
Exception thrown when a selector expression is invalid.
Indicates that the data stored in the shape or member is sensitive and
should be handled with care.
Validates the @authDefinition traits applied to service shapes.
Validates if operations that are bound directly to a service may
be more accurately bound to a resource bound to the same service.
An index that resolves service protocols and auth schemes.
Defines the type of auth schemes returned by
ServiceIndex.getEffectiveAuthSchemes(software.amazon.smithy.model.shapes.ToShapeId).Represents a
service shape.Builder used to create a
ServiceShape.Validates that service closures do not contain duplicate case-insensitive
shape names.
Deprecated.
Builder used to create a
SetShape.Severity level of a validation exception.
Changes the severity of a validation event.
A
Shape defines a model component.Immutable identifier for each shape in a model.
Ensures that no two shapes in the model have the same case-insensitive
shape ID.
Represents a shape ID syntax error.
Ensures that list, set, and map shapes are not directly recursive,
meaning that if they do have a recursive reference to themselves,
one or more references that form the recursive path travels through
a structure or union shape.
An enumeration of the different types in a model.
Shape visitor pattern.
Creates
ShapeVisitor that only requires implementation of
all data shape branches, but does not support service shapes.Creates
ShapeVisitor that return a value when necessary
when visiting shapes.Represents a
short shape.Builder used to create a
ShortShape.Abstract class representing all simple type shapes.
Defines when a shape or member was added to the model.
Validates that an operation is only bound to once in an entire
service closure.
Validates that a resource is only bound to once in an entire
service closure.
Defines how shapes, traits, and metadata are sorted when serializing a model with
SmithyIdlModelSerializer.Serializes a
Model into a set of Smithy IDL files.Builder used to create
SmithyIdlModelSerializer.Represents a contained pattern.
Builder used to create a SmithyPattern.
Segment within a SmithyPattern.
Runs a single test case by loading a model and ensuring the resulting
events match the validation events stored in a newline separated file.
Thrown when errors are encountered while unwrapping a test case.
Output of validating a model against a test case.
Runs test cases against a directory of models and error files.
Thrown when errors are encountered in the test runner.
Value result of executing the test suite.
Loads lines of text from source location files to display in things like error messages.
A pair of line numbers to the contents of lines.
An exception that can be traced back to a
SourceLocation.Represents the source location of a model component.
Indicates that a list or map is sparse, meaning they may contain nulls.
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.
Validates the streaming trait.
Contains abstract functionality to build traits that contain a list
of strings.
Abstract builder to build a StringList trait.
Trait provider that expects a list of string values.
Factory method to create a StringList provider.
Represents a string node.
Represents a
string shape.Builder used to create a
StringShape.This is a simple, not thread-safe, caching string table that converts CharSequence to String objects.
Abstract trait class for traits that contain only a string value.
Trait provider that expects a string value.
Structure shape that maps shape names to members.
Builder used to create a
StructureShape.Suppresses
ValidationEvents emitted from Validators.Applies tags to a shape.
Validates that neighbors target resolvable shapes of the correct type.
Index containing the full set of
TextInstances associated with a model.Contains information about text that occurs in the Smithy IDL written by the owner,
inluding location metadata.
Enum type indicating what kind of location in the model associated text appeared in.
Defines a custom serialization format for a timestamp.
The known
timestampFormat values.Represents a
timestamp shape.Builder used to create a
TimestampShape.Defines how timestamps are validated.
Provides a human-readable proper noun title to services and resources.
A value that can be converted to a
Node.Provides top-down access to all resources and operations contained within a
service or resource closure.
Topologically sorts shapes based on their dependencies (i.e., mixins).
Thrown when cycles exist between shapes.
Interface used to convert a shape to a ShapeId.
Traits provide additional context and semantics to shapes.
Validates that the JSON pointer paths of the breakingChanges property
of a trait refers to valid parts of the model.
Validates that traits do not conflict.
Trait definition trait.
Represents an individual trait diff rule to define backward compatibility rules.
Builder to create a TraitDefinition.
The structural exclusion semantics of the trait.
Creates traits using trait data from a model.
Creates traits from
Node values.Validates that traits are only applied to compatible shapes.
Implementation of smithy.api#traitValidators.
Validates that trait values are valid for their trait definitions.
Tagged union shape that maps member names to member definitions.
Builder used to create a
UnionShape.Indicates that the members of a list must be unique.
Ensures that a unit type can only be referenced as operation
input/output or by a tagged union member.
Finds shapes that are not connected to a "root" shape, are not trait definitions, are not referenced by trait
definitions, and are not referenced in trait values through
IdRefTrait.Finds shapes that aren't connected to any shapes considered "roots" (defaults to service shapes).
Deprecated.
Finds trait definitions that are not connected to a service shape.
Marks a shape as unstable.
Emits a validation event if a model contains shapes that are bound to unstable traits.
Represents a URI pattern.
Represents the result of an operation and the
ValidationEvents
that occurred.Thrown when
ValidatedResult.validate() is called and the result contains
ERROR events.A validation event created when validating a model.
Builds ValidationEvent values.
Validation event decorators take validation events and transform them by adding more contextual information,
usually adding a hint to let the user know what can it be done to solve the issue.
Formats
ValidationEvents.Utility methods used when validating.
Validates a
Model and returns a list of ValidationEvent.Creates built-in
Validator instances and Validator
instances loaded by name.Represents a service provider for configurable Validators that appear
in Smithy models.
Provides a simple abstraction for creating validator service subclasses.
Walks connected shapes within a Model.
Marks a structure member to be serialized to/from an XML attribute.
Defines the XML Namespace prefix and URI.
Builder used to create an XmlNamespace trait.
Validates that the xmlNamespace traits are applied correctly for structures.
Provides a custom name to use when serializing a structure member
name as a XML object property.
NullableIndexinstead.