All Classes Interface Summary Class Summary Enum Summary Exception Summary Annotation Types Summary
Class |
Description |
AbbreviationNameValidator |
Emits a validation event if shapes or member names do not use strict
camelCasing (e.g., XmlRequest is preferred over XMLRequest).
|
AbbreviationNameValidator.Config |
AbbreviationName configuration settings.
|
AbbreviationNameValidator.Provider |
|
AbstractDiffEvaluator |
Provides a default diff evaluator implementation with utility methods
for emitting events of different severities.
|
AbstractShapeBuilder<B extends AbstractShapeBuilder,S extends Shape> |
Abstract builder used to create Shape s.
|
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.
|
AbstractValidator |
Abstract Validator class that has helpful methods for emitting events.
|
Acceptor |
Represents an acceptor in a waiter's state machine.
|
AcceptorState |
The transition state of a waiter.
|
ActionPermissionDescriptionTrait |
Defines the description of what providing access to an operation entails.
|
ActionPermissionDescriptionTrait.Provider |
|
AddedEntityBinding |
A meta-validator that emits a NOTE when an operation resource is added
to a service or resource entity.
|
AddedMetadata |
Creates a NOTE event when metadata is added.
|
AddedOperationError |
Emits a warning when an error is added to an operation.
|
AddedOperationInputOutput |
Meta-validator that emits a NOTE when a backward compatible operation
input or output is added (AddedOperationInput and AddedOperationOutput),
and an ERROR when a breaking operation input is added using the same
event IDs.
|
AddedShape |
Creates a NOTE event when a shape is added.
|
AddedTraitDefinition |
Creates a NOTE event when a trait definition is added.
|
AndExpression |
And expression where both sides must return truthy values.
|
AnnotationTrait |
Trait implementation for traits that are an empty object.
|
AnnotationTrait.Provider<T extends AnnotationTrait> |
Trait provider that expects a boolean value of true.
|
ApiGatewayConfig |
API Gateway OpenAPI configuration.
|
ApiGatewayConfig.ApiType |
The type of API Gateway service to generate.
|
ApiGatewayExtension |
|
ApiGatewayMapper |
An API Gateway mapper that only applies when the type of API being
converted matches the types of APIs handled by the mapper.
|
ApiKeySourceTrait |
|
ApiKeySourceTrait.Provider |
|
AppliesTo |
Indicates that a compliance test case is only to be implemented by
"client" or "server" implementations.
|
Apply |
Recursively applies transforms of other projections.
|
Apply.ApplyCallback |
|
Apply.Config |
apply configuration.
|
Arguments |
Container for parsed command line arguments meant to be queried by Commands.
|
ArnIndex |
Resolves and indexes the ARN templates for each resource in a service.
|
ArnReferenceTrait |
Indicates that a string shape contains an ARN.
|
ArnReferenceTrait.Builder |
|
ArnReferenceTrait.Provider |
|
ArnTemplateValidator |
Ensures that all arn traits for a service are valid and that their templates
only reference valid resource identifiers.
|
ArnTrait |
Configures the ARN template of a resource shape, relative to the
service to which a resource is bound.
|
ArnTrait.Builder |
|
ArnTrait.Provider |
|
ArrayNode |
Represents an array of nodes.
|
ArtifactDefinitions |
Class that defines the acceptable values that can be used in ShapeLink objects.
|
ArtifactDefinitions.Builder |
|
AstCommand |
|
AttributeValue |
Selector attribute values are the data model of selectors.
|
AuthDefinitionTrait |
This trait is attached to another trait to define an auth scheme.
|
AuthDefinitionTrait.Builder |
|
AuthDefinitionTrait.Provider |
|
AuthorizerDefinition |
Represents an API Gateway authorizer.
|
AuthorizerDefinition.Builder |
|
AuthorizerIndex |
Computes the effective authorizers of each resource and
operation in a service.
|
AuthorizersTrait |
Defines a map of API Gateway x-amazon-apigateway-authorizer
values that correspond to Smithy authorization definitions.
|
AuthorizersTrait.Builder |
|
AuthorizersTrait.Provider |
|
AuthorizersTraitValidator |
Each authorizer resolved within a service must use a scheme that
matches one of the schemes of the protocols of the service.
|
AuthorizerTrait |
Attaches an API Gateway authorizer to a service, resource, or operation.
|
AuthorizerTrait.Provider |
|
AuthTrait |
Specifies the auth schemes supported by default for operations
bound to a service.
|
AuthTrait.Provider |
|
AuthTraitValidator |
All @auth trait values referenced from an operation must refer
to authentication traits applied to service shapes that enclose the
operation.
|
AwsJson1_0Trait |
An RPC-based protocol that sends JSON payloads.
|
AwsJson1_0Trait.Builder |
|
AwsJson1_0Trait.Provider |
|
AwsJson1_1Trait |
An RPC-based protocol that sends JSON payloads.
|
AwsJson1_1Trait.Builder |
|
AwsJson1_1Trait.Provider |
|
AwsProtocolTrait |
Represents a configurable AWS protocol trait.
|
AwsProtocolTrait.Builder<T extends Trait,B extends AwsProtocolTrait.Builder> |
Builder for creating a AwsProtocolTrait .
|
AwsQueryTrait |
An RPC-based protocol that sends query string requests and XML responses.
|
AwsQueryTrait.Provider |
|
AwsRestJson1Protocol |
Converts the aws.protocols#restJson1 protocol to OpenAPI.
|
AwsV4Converter |
Adds AWS signature version in a way that"s compatible with AWS API Gateway.
|
BigDecimalShape |
Represents a integer shape.
|
BigDecimalShape.Builder |
|
BigIntegerShape |
Represents a integer shape.
|
BigIntegerShape.Builder |
|
BinaryExpression |
Abstract class representing expressions that have a left and right side.
|
BlobShape |
Represents a blob shape.
|
BlobShape.Builder |
|
BooleanNode |
Represents a boolean node.
|
BooleanShape |
Represents a boolean shape.
|
BooleanShape.Builder |
|
BottomUpIndex |
Computes all of the parent shapes of resources and operations from the bottom-up.
|
BoxIndex |
Deprecated. |
BoxTrait |
Indicates that a shape is boxed, meaning a value may or may not be present.
|
BoxTrait.Provider |
|
BuildCommand |
|
BuildInfo |
POJO to represents a smithy-build-info.json file.
|
BuildInfoPlugin |
Writes a build info file for each projection.
|
BuildParameterBuilder |
This builder can be used to build up a Smithy CLI command to
run `smithy build`.
|
BuildParameterBuilder.ClassPathTagMatcher |
Interface used to query a classpath for the given projection sources tags.
|
BuildParameterBuilder.JarFileClassPathTagMatcher |
Finds JARs by opening each JAR in the classpath and looking for
"Smithy-Tags" in the META-INF/MANIFEST.MF file.
|
BuildParameterBuilder.Result |
Result class used to build source and projection JARs.
|
ByteShape |
Represents a byte shape.
|
ByteShape.Builder |
|
CallbackObject |
|
CallbackObject.Builder |
|
CamelCaseValidator |
Emits a validation event if shapes at a specific location do not match the
desired camel casing format.
|
CamelCaseValidator.Config |
CamelCase configuration settings.
|
CamelCaseValidator.MemberNameHandling |
|
CamelCaseValidator.Provider |
|
CaseUtils |
Provides support for camelCase, snake_case, and other kinds
of case conversions.
|
CfnAdditionalIdentifierTrait |
Indicates that the CloudFormation property generated from this member is an
additional identifier for the resource.
|
CfnAdditionalIdentifierTrait.Provider |
|
CfnConfig |
"cloudformation" smithy-build plugin configuration settings.
|
CfnConverter |
|
CfnException |
|
CfnExcludePropertyTrait |
Indicates that structure member should not be included in generated
CloudFormation resource definitions.
|
CfnExcludePropertyTrait.Provider |
|
CfnMapper |
Provides a plugin infrastructure to hook into the Smithy CloudFormation
Resource Schema generation process and map over the result.
|
CfnMutabilityTrait |
Indicates an explicit CloudFormation mutability of the structure member
when part of a CloudFormation resource.
|
CfnMutabilityTrait.Provider |
|
CfnMutabilityTraitValidator |
Validates that members marked as having write-only mutability are not also
marked as additional identifiers for their CloudFormation resource.
|
CfnNameTrait |
|
CfnNameTrait.Provider |
|
CfnResource |
Contains extracted resource information.
|
CfnResource.Builder |
|
CfnResourceIndex |
Index of resources to their CloudFormation identifiers and properties.
|
CfnResourceIndex.Mutability |
Mutability options derived through lifecycle operations or traits.
|
CfnResourceProperty |
Contains extracted resource property information.
|
CfnResourceProperty.Builder |
|
CfnResourcePropertyValidator |
Validates that derived CloudFormation properties all have the same target.
|
CfnResourceTrait |
Indicates that a Smithy resource is a CloudFormation resource.
|
CfnResourceTrait.Builder |
|
CfnResourceTrait.Provider |
|
ChangedEnumTrait |
Emits a NOTE when a new enum value is added, emits an ERROR when an
enum value is removed, and emits an ERROR when an enum name changes.
|
ChangedLengthTrait |
Detects when the Length trait is made more restrictive by either
raising the min or lowering the max.
|
ChangedMemberOrder |
Creates a DANGER event when a structure or union member is added
anywhere other than the end of the previous definition or the
member order is changed.
|
ChangedMemberTarget |
Checks for changes in the shapes targeted by a member.
|
ChangedMetadata |
Represents a change in metadata.
|
ChangedMetadata |
Creates a WARNING event when metadata is changed.
|
ChangedOperationInput |
Emits an ERROR when the input shape of an operation is changed to
another shape.
|
ChangedOperationOutput |
Emits an ERROR when the output shape of an operation is changed to
another shape.
|
ChangedRangeTrait |
Detects when the Range trait is made more restrictive by either
raising the min or lowering the max.
|
ChangedResourceIdentifiers |
Creates an ERROR event when the identifiers of a resource changes.
|
ChangedShape<S extends Shape> |
Represents a changed shape.
|
ChangedShapeType |
Creates an ERROR event when the type of a shape changes.
|
CheckForGreedyLabels |
Checks for greedy labels and fails/warns depending on configuration.
|
CheckForPrefixHeaders |
Checks for prefix headers in the input or output of an operation,
and handles the settings for throwing an exception or warning if
they're found.
|
CleanBindings |
Removes operation bindings from resources and services when operations
are removed, and removes resource bindings from services and resources when
resources are removed.
|
CleanClientDiscoveryTraitTransformer |
Removes the endpoint discovery trait from a service if the referenced operation or error are removed.
|
CleanOperationStructures |
Removes references to removed structures from operation
input, output, and errors.
|
CleanResourceReferences |
|
CleanStructureAndUnionMembers |
Cleans up structure and union shapes after shapes are removed.
|
CleanTraitDefinitions |
|
Cli |
This class provides a very basic CLI abstraction.
|
ClientDiscoveredEndpointTrait |
Indicates that the target operation should use the SDK's endpoint discovery
logic.
|
ClientDiscoveredEndpointTrait.Builder |
|
ClientDiscoveredEndpointTrait.Provider |
|
ClientEndpointDiscoveryIdTrait |
Indicates members of the operation input which should be use to discover
endpoints.
|
ClientEndpointDiscoveryIdTrait.Provider |
|
ClientEndpointDiscoveryIndex |
|
ClientEndpointDiscoveryInfo |
|
ClientEndpointDiscoveryTrait |
Configures endpoint discovery for the targeted service.
|
ClientEndpointDiscoveryTrait.Builder |
|
ClientEndpointDiscoveryTrait.Provider |
|
ClientEndpointDiscoveryValidator |
|
CliError |
Throw this exception to cause the CLI to exit with a message and code.
|
CodegenException |
Thrown when an error occurs during code generation.
|
CodegenWriter<T extends CodegenWriter<T,U>,U extends ImportContainer> |
|
CodegenWriterDelegator<T extends CodegenWriter<T,?>> |
|
CodegenWriterFactory<T extends CodegenWriter<T,?>> |
Factory used to create a CodegenWriter .
|
CodeWriter |
Helper class for generating code.
|
CognitoUserPoolsTrait |
Configures an Amazon Cognito User Pools auth scheme.
|
CognitoUserPoolsTrait.Builder |
|
CognitoUserPoolsTrait.Provider |
|
CollectionShape |
Abstract class representing Set and List shapes.
|
CollectionShape.Builder<B extends CollectionShape.Builder,S extends CollectionShape> |
Builder used to create a List or Set shape.
|
Colors |
Provides an abstraction for printing with ANSI colors if it is supported.
|
Command |
Represents a CLI command.
|
ComparatorExpression |
Compares the left and right expression using a comparator,
resulting in a boolean value.
|
ComparatorType |
A comparator in a comparison expression.
|
Component |
Abstract class used for most OpenAPI model components.
|
Component.Builder<B extends Component.Builder,C extends Component> |
|
ComponentsObject |
|
ComponentsObject.Builder |
|
ConditionKeyDefinition |
|
ConditionKeyDefinition.Builder |
|
ConditionKeysIndex |
Provides an index of condition keys for a service, including any condition
keys inferred from resource identifiers.
|
ConditionKeysTrait |
Applies condition keys to an operation or resource.
|
ConditionKeysTrait.Builder |
|
ConditionKeysTrait.Provider |
|
ConditionKeysValidator |
Ensures that condition keys referenced by operations bound within the
closure of a service are defined either explicitly using the
defineConditionKeys trait or through an inferred resource
identifier condition key.
|
ConfigurableProjectionTransformer<T> |
An abstract class used to more easily implement a Smithy build projection
transformer that expects configuration input in a specific type, T .
|
ConfigurableSmithyBuildPlugin<T> |
An abstract class used to more easily implement a Smithy build plugin
that expects configuration input in a specific type, T .
|
ConflictingShapeNameException |
Thrown when two shapes generate the same JSON schema pointer.
|
Context |
Smithy to CloudFormation conversion context object.
|
Context<T extends Trait> |
Smithy to OpenAPI conversion context object.
|
ContextualValidationEventFormatter |
This validation event formatter outputs a validation event that points
to the source code line that triggered the event.
|
ControlPlaneTrait |
|
ControlPlaneTrait.Provider |
|
CoreExtension |
Registers the core Smithy2CloudFormation functionality.
|
CoreExtension |
Registers the core Smithy2OpenApi functionality.
|
CorsHttpIntegration |
Adds support for the API Gateway x-amazon-apigateway-cors
extension for API Gateway HTTP APIs using values from the
Smithy cors trait.
|
CorsTrait |
|
CorsTrait.Builder |
|
CorsTrait.Provider |
|
CurrentExpression |
Gets the current node.
|
DataPlaneTrait |
|
DataPlaneTrait.Provider |
|
DataTrait |
|
DataTrait.Provider |
|
DefineConditionKeysTrait |
Defines condition keys used in a service.
|
DefineConditionKeysTrait.Builder |
|
DefineConditionKeysTrait.Provider |
|
DeprecatedTrait |
Marks a shape as deprecated.
|
DeprecatedTrait.Builder |
Builder used to create a DeprecatedTrait.
|
DeprecatedTrait.Provider |
|
DeprecatedTraitValidator |
Emits a validation event if a model contains shapes that are bound to deprecated traits.
|
DiffCommand |
|
Differences |
Queryable container for detected structural differences between two models.
|
DiffEvaluator |
Interface used to evaluate two models and their normalized
differences and return ValidationEvent s that are relative to
the new model.
|
DisableConditionKeyInferenceTrait |
Disables the automatic inference of condition keys of a resource.
|
DisableConditionKeyInferenceTrait.Provider |
|
DocumentationTrait |
Adds documentation to a model.
|
DocumentationTrait.Provider |
|
DocumentationWriter<T extends CodeWriter> |
Responsible for properly writing documentation emitted when a
Runnable in invoked.
|
DocumentShape |
Represents a document shape.
|
DocumentShape.Builder |
|
DoubleShape |
Represents a double shape.
|
DoubleShape.Builder |
|
DynamicTrait |
A general-purpose trait used to represent traits that are defined in the
model and have no concrete implementation.
|
Ec2QueryNameTrait |
Indicates the serialized name of a structure member when that structure is
serialized for the input of an EC2 operation.
|
Ec2QueryNameTrait.Provider |
|
Ec2QueryTrait |
An RPC-based protocol that sends query string requests and XML responses,
customized for Amazon EC2.
|
Ec2QueryTrait.Provider |
|
EffectiveTraitQuery |
Queries a model for effective traits bound to shapes and members.
|
EffectiveTraitQuery.Builder |
Builds a reusable EffectiveTraitQuery.
|
EmitEachSelectorValidator |
Emits a validation event for each shape that matches a selector.
|
EmitEachSelectorValidator.Config |
EmitEachSelector configuration settings.
|
EmitEachSelectorValidator.Provider |
|
EmitNoneSelectorValidator |
Emits a validation event if no shapes match the given selector.
|
EmitNoneSelectorValidator.Config |
EmitNoneSelector configuration settings.
|
EmitNoneSelectorValidator.Provider |
|
EncodingObject |
|
EncodingObject.Builder |
|
EndpointTrait |
Defines custom endpoint bindings of an operation.
|
EndpointTrait.Builder |
|
EndpointTrait.Provider |
|
EntityShape |
Abstract class representing service and resource shapes.
|
EntityShape.Builder<B extends EntityShape.Builder,S extends EntityShape> |
Builder used to create a Service or Resource shape.
|
EnumDefinition |
An enum definition for the enum trait.
|
EnumDefinition.Builder |
|
EnumTrait |
Constrains string values to one of the predefined enum constants.
|
EnumTrait.Builder |
Builder used to create the enum trait.
|
EnumTrait.Provider |
|
EnumTraitValidator |
Ensures that enum traits are valid.
|
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 |
|
EventPayloadTraitValidator |
Ensures that when an event structure contains an eventPayload member,
that all other members are bound to headers.
|
EventSourceValidator |
Validates that the aws.api#service/eventSource property matches
aws.api#service/arnNamespace + ".amazonaws.com" and does
not use incorrect formats.
|
EventStreamIndex |
Index of operation shapes to event stream information.
|
EventStreamInfo |
Contains extracted event stream information.
|
ExamplesTrait |
Defines examples for an operation.
|
ExamplesTrait.Builder |
Builds and examples trait.
|
ExamplesTrait.Example |
A specific example.
|
ExamplesTrait.Example.Builder |
|
ExamplesTrait.Provider |
|
ExamplesTraitValidator |
Validates that examples traits are valid for their operations.
|
ExcludeMetadata |
excludeMetadata removes metadata entries when a metadata key
matches keys .
|
ExcludeMetadata.Config |
excludeMetadata configuration settings.
|
ExcludeShapesByTag |
excludeShapesByTag removes shapes if they are tagged with one or more
of the given arguments.
|
ExcludeShapesByTag.Config |
excludeShapesByTag configuration.
|
ExcludeShapesByTrait |
Removes shapes from the model if they are marked with a specific trait.
|
ExcludeShapesByTrait.Config |
|
ExcludeTags |
excludeTags removes tags from shapes and trait definitions
that match any of the provided tags .
|
ExcludeTags.Config |
excludeTags configuration.
|
ExcludeTraits |
excludeTraits removes trait definitions and traits from
shapes when a trait name matches any of the values given in
traits .
|
ExcludeTraits.Config |
excludeTraits configuration settings.
|
ExcludeTraitsByTag |
excludeTraitsByTag removes traits and trait definitions
from a model if the trait definition contains any of the provided
tags .
|
ExcludeTraitsByTag.Config |
excludeTraitsByTag configuration settings.
|
ExclusiveStructureMemberTraitValidator |
Validates traits that can only be applied to a single structure member.
|
ExpectationNotMetException |
Thrown by Node methods that expect a node to be of a particular
type or to have a particular member.
|
ExpressionProblem |
Represents a problem detected by static analysis.
|
ExpressionProblem.Severity |
The severity of the problem.
|
ExpressionTypeExpression |
Contains a reference to an expression that can be run zero or more
times by a function.
|
ExpressionVisitor<T> |
Visits each type of AST node.
|
ExternalDocumentation |
|
ExternalDocumentation.Builder |
|
ExternalDocumentationTrait |
Provides named links to external documentation.
|
ExternalDocumentationTrait.Builder |
Builder used to create the external documentation trait.
|
ExternalDocumentationTrait.Provider |
|
FieldExpression |
Gets a field by name from an object.
|
FileManifest |
|
FilterProjectionExpression |
A projection that filters values using a comparison.
|
FlattenExpression |
Flattens the wrapped expression into an array.
|
FlattenNamespaces |
flattenNamespaces updates a model by flattening the namespaces of
shapes connected to a service into a single, target namespace.
|
FlattenNamespaces.Config |
flattenNamespaces configuration settings.
|
FloatShape |
Represents a integer shape.
|
FloatShape.Builder |
|
FromSourceLocation |
|
FunctionalUtils |
Utilities for working with functions, predicates, etc.
|
FunctionExpression |
Executes a function by name using a list of argument expressions.
|
Handler |
Data class representing a CloudFormation Resource Schema's handler definition.
|
Handler.Builder |
|
HostLabelTrait |
Binds an input member to a label in the hostPrefix of an endpoint
trait on an operation.
|
HostLabelTrait.Provider |
|
HostLabelTraitValidator |
Validates that hostLabel traits are applied correctly for operation inputs.
|
HttpApiKeyAuthConverter |
Uses an HTTP header named X-Api-Key that contains an API key.
|
HttpApiKeyAuthTrait |
An HTTP-specific authentication scheme that sends an arbitrary
API key in a header or query string parameter.
|
HttpApiKeyAuthTrait.Builder |
|
HttpApiKeyAuthTrait.Location |
|
HttpApiKeyAuthTrait.Provider |
|
HttpBasicAuthTrait |
An auth scheme trait uses HTTP basic auth.
|
HttpBasicAuthTrait.Provider |
|
HttpBasicConverter |
Applies Basic HTTP auth.
|
HttpBearerAuthTrait |
An auth scheme trait uses HTTP bearer auth.
|
HttpBearerAuthTrait.Provider |
|
HttpBearerConverter |
Uses the Bearer scheme of the Authentication header.
|
HttpBinding |
Defines an HTTP message member binding.
|
HttpBinding.Location |
HTTP binding types.
|
HttpBindingIndex |
Computes and indexes the explicit and implicit HTTP bindings of a model.
|
HttpBindingsMissingValidator |
Validates that if any operation in a service uses the http trait,
then all operations use them.
|
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 |
|
HttpDigestConverter |
Applies Digest HTTP auth.
|
HttpErrorTrait |
Defines a custom HTTP status code for error structures.
|
HttpErrorTrait.Provider |
|
HttpHeaderTrait |
Binds a member to an HTTP header.
|
HttpHeaderTrait.Provider |
|
HttpHeaderTraitValidator |
Validates that httpHeader traits are case-insensitively unique.
|
HttpLabelTrait |
Binds a member to a URI label of an input of an operation using
the member name.
|
HttpLabelTrait.Provider |
|
HttpLabelTraitValidator |
Validates that httpLabel traits are applied correctly for operation inputs.
|
HttpMessageTestCase |
|
HttpMethodSemanticsValidator |
Validates that `http` traits applied to operation shapes use the most
semantically appropriate HTTP method according to RFC 7231.
|
HttpPayloadTrait |
Binds a single structure member to the payload of an HTTP request.
|
HttpPayloadTrait.Provider |
|
HttpPayloadValidator |
Validates that if a payload trait is present then all members of the
input of an operation are bound to part of the message.
|
HttpPrefixHeadersTrait |
Binds a map structure member to prefixed HTTP headers.
|
HttpPrefixHeadersTrait.Provider |
|
HttpPrefixHeadersTraitValidator |
Validates that httpHeader traits do not case-insensitively start with an
httpPrefixHeader on the same structure.
|
HttpQueryTrait |
Binds a member to an HTTP query string.
|
HttpQueryTrait.Provider |
|
HttpQueryTraitValidator |
Validates that httpQuery trait bindings are case-sensitively unique.
|
HttpRequestTestCase |
Defines a test case for an HTTP request.
|
HttpRequestTestCase.Builder |
Builder used to create a HttpRequestTestsTrait.
|
HttpRequestTestsInputValidator |
Ensures that input parameters of protocol request test cases are
valid for the attached operation.
|
HttpRequestTestsTrait |
Defines HTTP request protocol tests.
|
HttpRequestTestsTrait.Provider |
|
HttpResponseCodeSemanticsValidator |
Ensures that HTTP response codes are appropriate for operations and errors.
|
HttpResponseCodeTrait |
Indicates that the structure member represents the HTTP response
status code.
|
HttpResponseCodeTrait.Provider |
|
HttpResponseTestCase |
Defines a test case for an HTTP response.
|
HttpResponseTestCase.Builder |
Builder used to create a HttpResponseTestCase.
|
HttpResponseTestsErrorValidator |
Validates that protocol tests on errors use the correct params.
|
HttpResponseTestsOutputValidator |
Validates that protocol tests on output use the correct params.
|
HttpResponseTestsTrait |
Defines HTTP request protocol tests.
|
HttpResponseTestsTrait.Provider |
|
HttpTrait |
Defines the HTTP request and response code bindings of an operation.
|
HttpTrait.Builder |
Builder used to create an Http trait.
|
HttpTrait.Provider |
|
HttpUriConflictValidator |
Validates that no two URIs in a service conflict with each other.
|
IdempotencyTokenTrait |
Defines an operation input member that is used to prevent
replayed requests.
|
IdempotencyTokenTrait.Provider |
|
IdempotentTrait |
Indicates that an operation is idempotent.
|
IdempotentTrait.Provider |
|
IdentifierBindingIndex |
Index of operation shapes to the identifiers bound to the operation.
|
IdentifierBindingIndex.BindingType |
|
IdRefTrait |
Indicates that a string value must contain a valid shape ID.
|
IdRefTrait.Builder |
|
IdRefTrait.Provider |
|
ImportContainer |
Contains the imports associated with a specific file.
|
IncludeMetadata |
includeMetadata keeps only metadata keys specifically
defined in the provided keys setting.
|
IncludeMetadata.Config |
includeMetadata configuration settings.
|
IncludeNamespaces |
includeNamespaces filters out shapes and trait definitions
that are not part of one of the given namespaces .
|
IncludeNamespaces.Config |
includeNamespaces configuration.
|
IncludeServices |
includeServices filters out service shapes that are not
included in the list of shape IDs contained in the
services property.
|
IncludeServices.Config |
includeServices configuration.
|
IncludeShapesByTag |
includeShapesByTag removes shapes and trait definitions
that are not tagged with at least one of the tags provided
in the tags argument.
|
IncludeShapesByTag.Config |
includeShapesByTag configuration.
|
IncludeTags |
includeTags removes tags from shapes and trait
definitions that are not in the set of tags defined in
the tags property.
|
IncludeTags.Config |
includeTags configuration.
|
IncludeTraits |
includeTraits removes trait definitions when a trait name
does not match one of the provided traits shape IDs.
|
IncludeTraits.Config |
includeTraits configuration settings.
|
IncludeTraitsByTag |
includeTraitsByTag removes trait definitions from a model if
the definition does not contain at least one of the provided tags .
|
IncludeTraitsByTag.Config |
includeTraitsByTag configuration settings.
|
IndexExpression |
Gets a specific element by zero-based index.
|
InfoObject |
|
InfoObject.Builder |
|
InputOutputStructureReuseValidator |
Checks if a structure is used as both input and output and if the same
input or output structures are used across multiple operations.
|
InputOutputStructureReuseValidator.Provider |
|
IntegerShape |
Represents an integer shape.
|
IntegerShape.Builder |
|
IntegrationResponse |
An API Gateway integration response object.
|
IntegrationResponse.Builder |
|
IntegrationTrait |
API Gateway integration.
|
IntegrationTrait.Builder |
|
IntegrationTrait.Provider |
|
IntegrationTraitIndex |
Computes the API Gateway integration for each operation,
resource, and service shape in a model.
|
InternalTrait |
Shapes marked with the internal trait are meant only for internal use and
must not be exposed to customers.
|
InternalTrait.Provider |
|
InvalidPatternException |
Exception thrown for invalid patterns.
|
InvalidUriPatternException |
Exception thrown for invalid HTTP URI patterns.
|
IoUtils |
Utilities for IO operations.
|
JavaStyleDocumentationWriterBuilder |
A builder used to create a DocumentationWriter for Java style
documentation comments.
|
JmespathException |
Thrown when any JMESPath error occurs.
|
JmespathExpression |
Represents a JMESPath AST node.
|
JsonNameTrait |
Provides a custom name to use when serializing a structure member
name as a JSON object property.
|
JsonNameTrait.Provider |
|
JsonSchemaConfig |
JSON Schema configuration options.
|
JsonSchemaConfig.MapStrategy |
Configures how Smithy map shapes are converted to JSON Schema.
|
JsonSchemaConfig.UnionStrategy |
Configures how Smithy union shapes are converted to JSON Schema.
|
JsonSchemaConverter |
Converts a Smithy model index to a JSON schema document.
|
JsonSchemaConverter.Builder |
|
JsonSchemaMapper |
Updates a schema builder before converting a shape to a schema.
|
JsonSubstitutions |
Finds string set in a Node object string value and replaces them with a
corresponding Node.
|
KnowledgeIndex |
A marker interface used to indicate that a class contains an index of
computed knowledge about a Model .
|
LengthTrait |
Constrains a shape to minimum and maximum number of elements or size.
|
LengthTrait.Builder |
Builder used to create a LongTrait.
|
LengthTrait.Provider |
|
LengthTraitValidator |
|
LineValidationEventFormatter |
Writes ValidationEvent objects as a single line string.
|
LinkObject |
|
LinkObject.Builder |
|
LinterResult |
|
ListShape |
Represents a list shape.
|
ListShape.Builder |
|
ListUtils |
Immutable List utilities to polyfill Java 9+ features.
|
LiteralExpression |
Represents a literal value.
|
LongShape |
Represents a integer shape.
|
LongShape.Builder |
|
MappedReservedWords |
A reserved words implementation that maps known words to other words.
|
MappedReservedWords.Builder |
|
MapShape |
Represents a map shape.
|
MapShape.Builder |
|
MapUtils |
Immutable Map utilities to polyfill Java 9+ features.
|
Matcher<T> |
Determines if an acceptor matches the current state of a resource.
|
Matcher.ErrorTypeMember |
Matches if an operation returns an error, and the error matches the
expected error type.
|
Matcher.InputOutputMember |
|
Matcher.OutputMember |
|
Matcher.SuccessMember |
When set to true, matches when a call returns a success response.
|
Matcher.UnknownMember |
Represents an union union value.
|
Matcher.Visitor<T> |
Visits the variants of the Matcher union type.
|
MediaType |
Implements a simple media type parser based on the Content-Type grammar defined in
RFC 7231.
|
MediaTypeObject |
|
MediaTypeObject.Builder |
|
MediaTypeTrait |
Documents the media type of a blob shape.
|
MediaTypeTrait.Provider |
|
MediaTypeValidator |
|
MemberShape |
Represents a member that targets another shape by ID.
|
MemberShape.Builder |
|
MissingPaginatedTraitValidator |
Checks if an operation should be paginated but is not.
|
MissingPaginatedTraitValidator.Config |
|
MissingPaginatedTraitValidator.Provider |
|
MockIntegrationTrait |
API Gateway mock integration.
|
MockIntegrationTrait.Builder |
|
MockIntegrationTrait.Provider |
|
MockManifest |
|
MockManifest.StoreMode |
The way in which files are stored.
|
Model |
A Smithy model that contains shapes, traits, metadata, and various
computed information used to interpret the model.
|
Model.Builder |
Builder used to create a Model.
|
ModelAssembler |
Assembles and validates a Model from documents, files, shapes, and
other sources.
|
ModelDiff |
Computes the difference between two models and any problems that might
occur due to those differences.
|
ModelDiff.Builder |
Builder used to construct a diff of two Smithy models.
|
ModelDiff.Result |
The result of comparing two Smithy models.
|
ModelDiscovery |
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.
|
ModelImportException |
Exception thrown when a model fails to be imported.
|
ModelManifestException |
|
ModelPlugin |
Writes the projected/filtered SmithyBuild model.
|
ModelSerializer |
|
ModelSerializer.Builder |
|
ModelSyntaxException |
Thrown when the syntax of the IDL is invalid.
|
ModelTransformer |
Class used to transform Model s.
|
ModelTransformerPlugin |
Plugin service used with ModelTransformer.
|
ModifiedTrait |
Finds breaking changes related to when a trait is added, removed, or
updated.
|
MqttJsonTrait |
|
MqttJsonTrait.Provider |
|
MqttPublishInputValidator |
Publish operations must not contain event streams.
|
MqttSubscribeInputValidator |
Validates @smithy.mqtt#subscribe operation input.
|
MqttSubscribeOutputValidator |
Validates subscribe operation output.
|
MqttTopicConflictValidator |
Validates that no two MQTT topics conflict.
|
MqttTopicLabelValidator |
Validates that labels are correct for MQTT topics on
subscribe and publish operations.
|
MqttUnsupportedErrorsValidator |
Validates that @smithy.mqtt#publish and subscribe
operations should not define errors.
|
MultiSelectHashExpression |
Creates an object using key-value pairs.
|
MultiSelectListExpression |
Selects one or more values into a created array.
|
NeighborProvider |
Provides the neighbor relationships for a given shape.
|
NeighborProviderIndex |
Provides a cache of precomputed neighbors for models.
|
Node |
Base class of for all Smithy model nodes.
|
NodeDeserializationException |
Exception encountered during deserialization.
|
NodeHandler |
|
NodeMapper |
Serializes and deserializes Smithy Node values to/from objects.
|
NodeMapper.WhenMissing |
Specifies the behavior of the mapper when attempting to deserialize an unknown property.
|
NodePointer |
JSON Pointer abstraction over Smithy Node values.
|
NodeSerializationException |
Exception encountered during serialization.
|
NodeType |
The set of possible node types.
|
NodeValidationVisitor |
Validates Node values provided for Shape definitions.
|
NodeValidationVisitor.Builder |
|
NodeValidatorPlugin |
Applies pluggable validation when validating Node values against
the schema of a Shape (e.g., when validating that the values
provided for a trait in the model are valid for the shape of the trait).
|
NodeVisitor<R> |
Node visitor interface.
|
NodeVisitor.Default<R> |
Creates NodeVisitor that return a default value when necessary
when visiting nodes.
|
NoInlineDocumentSupportValidator |
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.
|
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 |
|
NotExpression |
Negates an expression based on if the wrapped expression is truthy.
|
NullableIndex |
An index that checks if a shape can be set to null.
|
NullNode |
Represents a null node.
|
NumberNode |
Represents a number node.
|
NumberShape |
Abstract class representing all numeric types.
|
ObjectNode |
Represents an object node.
|
ObjectNode.Builder |
Builder used to efficiently create an ObjectNode.
|
ObjectProjectionExpression |
A projection of object values.
|
OpenApi |
|
OpenApi.Builder |
|
OpenApiConfig |
"openapi" smithy-build plugin configuration settings.
|
OpenApiConfig.HttpPrefixHeadersStrategy |
Specifies what to do when the httpPrefixHeaders trait is found in a model.
|
OpenApiConverter |
Converts a Smithy model to OpenAPI.
|
OpenApiException |
|
OpenApiJsonAdd |
Adds JSON values into the generated OpenAPI model using a JSON Patch
like "add" operation that also generated intermediate objects as needed.
|
OpenApiJsonSchemaMapper |
|
OpenApiJsonSubstitutions |
Substitutes JSON string values using the mapping defined in
openapi.substitutions .
|
OpenApiMapper |
Provides a plugin infrastructure used to hook into the Smithy to OpenAPI
conversion process and map over the result.
|
OpenApiProtocol<T extends Trait> |
An OpenAPI protocol is used to convert a Smithy protocol into
HTTP-specific bindings.
|
OpenApiProtocol.Operation |
|
OperationIndex |
Index of operation IDs to their resolved input, output, and error
structures.
|
OperationObject |
|
OperationObject.Builder |
|
OperationShape |
Represents an API operation.
|
OperationShape.Builder |
|
OptionalAuthTrait |
Indicates that an operation / service supports unauthenticated access.
|
OptionalAuthTrait.Provider |
|
OptionalUtils |
Functions that make working with optionals easier.
|
OrExpression |
Or expression that returns the expression that returns a truthy value.
|
PaginatedIndex |
Index of operation shapes to paginated trait information.
|
PaginatedTrait |
Defines the pagination functionality of an operation.
|
PaginatedTrait.Builder |
Builds the paginated trait.
|
PaginatedTrait.Provider |
|
PaginatedTraitValidator |
Validates paginated traits.
|
PaginationInfo |
Resolved and valid pagination information about an operation in a service.
|
Pair<L,R> |
Generic immutable pair of values.
|
ParameterObject |
|
ParameterObject.Builder |
|
Parser |
Defines the CLI argument parser of a Command .
|
Parser.Argument |
A command line argument.
|
Parser.Arity |
Defines the arity of an argument.
|
Parser.Builder |
|
ParserUtils |
Utility methods that act on a SimpleParser and parse
Smithy grammar productions.
|
PathComparator |
Defines a comparison to perform in a PathMatcher.
|
PathFinder |
Finds the possible directed relationship paths from a starting shape to
shapes connected to the starting shape that match a selector.
|
PathFinder.Path |
An immutable Relationship path from a starting shape to an end shape.
|
PathItem |
|
PathItem.Builder |
|
PathMatcher |
A Matcher implementation for inputPathList ,
outputPathList , and errorPathList .
|
PatternTrait |
Restricts string values to a specified regular expression.
|
PatternTrait.Provider |
|
PlaneIndex |
Determines if a service, resource, or operation are considered
part of the data plane or control plane.
|
PluginContext |
Context object used in plugin execution.
|
PluginContext.Builder |
|
Prelude |
Represents the prelude model available to every Smithy model.
|
PrivateAccessValidator |
Ensures that shapes in separate namespaces don't refer to shapes in other
namespaces that are marked as private.
|
PrivateTrait |
Indicates that a shape cannot be targeted outside of the namespace in
which it was defined.
|
PrivateTrait.Provider |
|
ProjectionConfig |
|
ProjectionConfig.Builder |
|
ProjectionExpression |
Iterates over each element in the array returned from the left expression,
passes it to the right expression, and returns the aggregated results.
|
ProjectionResult |
The result of applying a projection to a model.
|
ProjectionResult.Builder |
|
ProjectionTransformer |
Creates a model transformer by name.
|
Property |
Data class representing a CloudFormation Resource Schema's property.
|
Property.Builder |
|
PropertyNamingStrategy |
Determines the field/property/member name of a member in an object.
|
ProtocolDefinitionTrait |
A trait that is attached to other traits to define a Smithy protocol.
|
ProtocolDefinitionTrait.Builder |
|
ProtocolDefinitionTrait.Provider |
|
ProtocolHttpPayloadValidator |
Ensures that the http payload trait is only bound to structures, unions,
documents, blobs, or strings for AWS protocols.
|
ProtocolHttpValidator |
Ensures that every entry in eventStreamHttp also appears in
the http property of a protocol trait.
|
PublishTrait |
smithy.mqtt#publish trait.
|
PublishTrait.Provider |
|
RangeTrait |
Constrains a shape to minimum and maximum numeric range.
|
RangeTrait.Builder |
Builder used to create a LongTrait.
|
RangeTrait.Provider |
|
RangeTraitValidator |
Ensures that range traits are valid.
|
ReadonlyTrait |
Indicates that an operation is read-only.
|
ReadonlyTrait.Provider |
|
Ref<T extends ToNode> |
|
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 |
|
ReferencesTraitValidator |
Validates that references are correct.
|
Relationship |
Represent a direct relationship between two shapes.
|
RelationshipDirection |
Defines the directionality of a relationship.
|
RelationshipType |
Defines the relationship types between neighboring shapes.
|
Remote |
Data class representing a CloudFormation Resource Schema's remote definition.
|
Remote.Builder |
|
RemovedAuthenticationScheme |
TODO: Implement evaluator to find removed authentication schemes.
|
RemovedEntityBinding |
A meta-validator that checks for the removal of an operation or
resource binding from a service or resource.
|
RemovedMetadata |
Creates a DANGER event when metadata is removed.
|
RemovedOperationError |
Emits a warning when an error is removed from an operation.
|
RemovedOperationInput |
Emits an ERROR when the input shape is removed from an operation.
|
RemovedOperationOutput |
Emits an ERROR when the output shape is removed from an operation.
|
RemovedShape |
Creates an ERROR event when a non-private shape is removed.
|
RemovedTraitDefinition |
Creates an ERROR event when a trait definition is removed.
|
RemoveEmptyComponents |
Removes empty key-value pairs in the "components" of a model if empty, and
removes the "components" key-value pair of a model if it is empty.
|
RemoveTraitDefinitions |
removeTraitShapes removes all trait definitions from a model,
but leaves if the trait definition contains any of the provided
tags .
|
RemoveTraitDefinitions.Config |
removeTraitShapes configuration settings.
|
RemoveTraits |
Removes traits from shapes when trait definitions are removed.
|
RemoveUnusedComponents |
Removes unused components from the OpenAPI model.
|
RemoveUnusedShapes |
removeUnusedShapes removes shapes from the model that are not
connected to any service shape.
|
RemoveUnusedShapes.Config |
removeUnusedShapes configuration settings.
|
RenameShapes |
renameShapes updates a model by renaming shapes.
|
RenameShapes.Config |
renameShapes configuration settings.
|
RequestBodyObject |
|
RequestBodyObject.Builder |
|
RequestValidatorTrait |
|
RequestValidatorTrait.Provider |
|
RequiredActionsTrait |
|
RequiredActionsTrait.Builder |
|
RequiredActionsTrait.Provider |
|
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 |
|
ReservedWords |
Determines what is reserved and escapes reserved words.
|
ReservedWordsBuilder |
Builds a ReservedWords implementation from explicit
mappings and from line-delimited files that contain reserved words.
|
ReservedWordsValidator |
Emits validation events for a configuration of reserved words.
|
ReservedWordsValidator.Config |
ReservedWords validator configuration.
|
ReservedWordsValidator.Provider |
|
ReservedWordsValidator.ReservedWords |
A single reserved words configuration.
|
ReservedWordSymbolProvider |
|
ReservedWordSymbolProvider.Builder |
|
ReservedWordSymbolProvider.Escaper |
Uses to manually escape Symbol s and member names.
|
ResolvedTopicIndex |
|
ResourceCycleValidator |
Validates that resource references do not introduce circular hierarchies.
|
ResourceIdentifierBindingValidator |
Validates that operations bound to resource shapes have identifier
bindings for all of 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.
|
ResourceIdentifierTrait |
Binds an operation input member to a named identifier of the resource to
which the operation is bound.
|
ResourceIdentifierTrait.Provider |
|
ResourceIdentifierValidator |
Validates that the resource identifiers of children of a resource contain
all of the identifiers as their parents.
|
ResourceLifecycleValidator |
Validates that resource are applied appropriately to resources.
|
ResourceSchema |
Data class representing a CloudFormation Resource Schema.
|
ResourceSchema.Builder |
|
ResourceShape |
Represents a resource shape.
|
ResourceShape.Builder |
|
ResponseObject |
|
ResponseObject.Builder |
|
RestJson1Trait |
A RESTful protocol that sends JSON in structured payloads.
|
RestJson1Trait.Builder |
|
RestJson1Trait.Provider |
|
RestXmlTrait |
A RESTful protocol that sends XML in structured payloads.
|
RestXmlTrait.Builder |
|
RestXmlTrait.Provider |
|
RetryableTrait |
Marks an error structure as retryable.
|
RetryableTrait.Builder |
|
RetryableTrait.Provider |
|
RuntimeType |
|
Schema |
Defines a single JSON schema.
|
Schema.Builder |
Abstract class used to build Schema components.
|
SchemaDocument |
Represents a JSON Schema document.
|
SchemaDocument.Builder |
Builds a JSON Schema document.
|
SdkServiceIdValidator |
Validates that SDK service IDs are correct and do not match any
prohibited patterns.
|
SecurityScheme |
|
SecurityScheme.Builder |
|
SecuritySchemeConverter<T extends Trait> |
Converts a Smithy authentication scheme to an OpenAPI security
scheme and applies security requirements to operations.
|
SelectCommand |
|
Selector |
Matches a set of shapes using a selector expression.
|
Selector.Runner |
Builds the execution environment for a selector and executes selectors.
|
SelectorSyntaxException |
Exception thrown when a selector expression is invalid.
|
SensitiveTrait |
Indicates that the data stored in the shape or member is sensitive and
should be handled with care.
|
SensitiveTrait.Provider |
|
SensitiveTraitValidator |
Finds members marked as sensitive that target shapes marked as sensitive,
and find members marked as sensitive that target structures, unions, or
enums.
|
ServerObject |
|
ServerObject.Builder |
|
ServiceIndex |
An index that resolves service protocols and auth schemes.
|
ServiceShape |
Represents a service shape.
|
ServiceShape.Builder |
|
ServiceTrait |
Registers a service as an AWS service.
|
ServiceTrait.Builder |
|
ServiceTrait.Provider |
|
ServiceValidator |
Validates that service closures do not contain duplicate case-insensitive
shape names.
|
SetShape |
Represents a set shape.
|
SetShape.Builder |
|
SetUtils |
Immutable Set utilities to polyfill Java 9+ features.
|
Severity |
Severity level of a validation exception.
|
Shape |
A Shape defines a model component.
|
ShapeId |
Immutable identifier for each shape in a model.
|
ShapeIdConflictValidator |
Ensures that no two shapes in the model have the same case-insensitive
shape ID.
|
ShapeIdSyntaxException |
Represents a shape ID syntax error.
|
ShapeLink |
Class that defines a link between the Smithy Shape and
the artifact that it produced.
|
ShapeLink.Builder |
|
ShapeRecursionValidator |
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.
|
ShapeType |
An enumeration of the different types in a model.
|
ShapeVisitor<R> |
Shape visitor pattern.
|
ShapeVisitor.Default<R> |
Creates ShapeVisitor that return a value when necessary
when visiting shapes.
|
ShortShape |
Represents a short shape.
|
ShortShape.Builder |
|
ShouldHaveUsedTimestampValidator |
Validates that shapes that have names that appear to be time values are
actually modeled with a timestamp shape.
|
ShouldHaveUsedTimestampValidator.Config |
|
ShouldHaveUsedTimestampValidator.Provider |
|
SigV4Trait |
Adds AWS signature version 4 authentication to a service or operation.
|
SigV4Trait.Builder |
|
SigV4Trait.Provider |
|
SimpleParser |
A simple expression parser that can be extended to implement parsers
for small domain specific languages.
|
SimpleShape |
Abstract class representing all simple type shapes.
|
SinceTrait |
Defines when a shape or member was added to the model.
|
SinceTrait.Provider |
|
SingleOperationBindingValidator |
Validates that an operation is only bound to once in an entire
service closure.
|
SingleResourceBindingValidator |
Validates that a resource is only bound to once in an entire
service closure.
|
SliceExpression |
Represents a slice expression, containing an optional zero-based
start offset, zero-based stop offset, and step.
|
Smithy2Cfn |
|
Smithy2CfnExtension |
An extension mechanism used to influence how CloudFormation resource schemas
are generated from Smithy models.
|
Smithy2OpenApi |
Converts Smithy to an OpenAPI model and saves it as a JSON file.
|
Smithy2OpenApiExtension |
An extension mechanism used to influence how Smithy models are converted
to OpenAPI models.
|
SmithyBuild |
|
SmithyBuildConfig |
Filter configuration that contains a list of named projections that
are used to apply filters to a model.
|
SmithyBuildConfig.Builder |
|
SmithyBuilder<T> |
A mutable object that can be used to create an immutable object of type T.
|
SmithyBuildException |
Base exception thrown for any error that occurs while building.
|
SmithyBuildPlugin |
Plugin extension class for SmithyBuild.
|
SmithyBuildResult |
Encapsulates the result of running SmithyBuild.
|
SmithyBuildResult.Builder |
Creates a SmithyBuildResult.
|
SmithyCli |
Entry point of the Smithy CLI.
|
SmithyGenerated |
Annotation used to indicate that a package or class was generated and
should not be edited directly.
|
SmithyIdlModelSerializer |
Serializes a Model into a set of Smithy IDL files.
|
SmithyIdlModelSerializer.Builder |
|
SmithyInternalApi |
Annotation used to indicate that an API is considered internal to Smithy
and subject to change.
|
SmithyJsonSchemaException |
|
SmithyPattern |
Represents a contained pattern.
|
SmithyPattern.Builder |
Builder used to create a SmithyPattern.
|
SmithyPattern.Segment |
Segment within a SmithyPattern.
|
SmithyPattern.Segment.Type |
|
SmithyTestCase |
Runs a single test case by loading a model and ensuring the resulting
events match the validation events stored in a newline separated file.
|
SmithyTestCase.Error |
Thrown when errors are encountered while unwrapping a test case.
|
SmithyTestCase.Result |
Output of validating a model against a test case.
|
SmithyTestSuite |
Runs test cases against a directory of models and error files.
|
SmithyTestSuite.Error |
Thrown when errors are encountered in the test runner.
|
SmithyTestSuite.Result |
Value result of executing the test suite.
|
SmithyUnstableApi |
Annotation used to indicate that an API is considered unstable and subject
to change.
|
SourceException |
|
SourceLocation |
Represents the source location of a model component.
|
SourcesConflictException |
Thrown when sources conflict in the source plugin.
|
SourcesPlugin |
Copies model sources into the sources plugin.
|
SparseTrait |
Indicates that a list or map is sparse, meaning they may contain nulls.
|
SparseTrait.Provider |
|
StandardOperationVerbValidator |
Validates that operation shape names start with standard verbs.
|
StandardOperationVerbValidator.Config |
StandardOperationVerb configuration settings.
|
StandardOperationVerbValidator.Provider |
|
StreamingTrait |
Indicates that the 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 |
|
StreamingTraitValidator |
Validates the streaming trait.
|
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.
|
StringListTrait.StringListTraitConstructor<T extends StringListTrait> |
Factory method to create a StringList provider.
|
StringNode |
Represents a string node.
|
StringShape |
Represents a string shape.
|
StringShape.Builder |
|
StringTrait |
Abstract trait class for traits that contain only a string value.
|
StringTrait.Provider<T extends StringTrait> |
Trait provider that expects a string value.
|
StringUtils |
Operations on String that are null safe.
|
StructureShape |
Structure shape that maps shape names to members.
|
StructureShape.Builder |
|
StutteredShapeNameValidator |
Validates that structure members and union member names do not
stutter their shape name as prefixes of their member or tag names.
|
StutteredShapeNameValidator.Provider |
|
Subexpression |
Visits the left expression and passes its result to the right expression.
|
SubscribeTrait |
smithy.mqtt#subscribe trait.
|
SubscribeTrait.Provider |
|
SuppressTrait |
|
SuppressTrait.Builder |
|
SuppressTrait.Provider |
|
Symbol |
A "symbol" is created by a SymbolProvider , and represents the
qualified name of a type in a target programming language.
|
Symbol.Builder |
Builds a Symbol.
|
SymbolContainer |
|
SymbolDependency |
Represents a dependency that is introduced by a Symbol .
|
SymbolDependency.Builder |
Builds a SymbolDependency.
|
SymbolDependencyContainer |
|
SymbolProvider |
Provides Symbol objects for shapes.
|
SymbolReference |
Represents a reference from a Symbol to another Symbol.
|
SymbolReference.Builder |
Builds a SymbolReference.
|
SymbolReference.ContextOption |
Options used to control the context of when the symbol reference is needed.
|
SymbolReference.Option |
Top-level interface for all SymbolReference options.
|
Tagged |
A type that contains tags.
|
TagObject |
|
TagObject.Builder |
|
TagsTrait |
Applies tags to a shape.
|
TagsTrait.Builder |
|
TagsTrait.Provider |
|
TargetValidator |
Validates that neighbors target resolvable shapes of the correct type.
|
TimestampFormatTrait |
Defines a custom serialization format for a timestamp.
|
TimestampFormatTrait.Format |
The known timestampFormat values.
|
TimestampFormatTrait.Provider |
|
TimestampShape |
Represents a timestamp shape.
|
TimestampShape.Builder |
|
TimestampValidationStrategy |
Defines how timestamps are validated.
|
TitleTrait |
Provides a human-readable proper noun title to services and resources.
|
TitleTrait.Provider |
|
ToNode |
A value that can be converted to a Node .
|
TopDownIndex |
Provides top-down access to all resources and operations contained within a
service or resource closure.
|
Topic |
Represents a parsed MQTT topic.
|
Topic.Level |
Represents a level in a topic.
|
TopicBinding<T extends Trait> |
Contains computed information about the resolved MQTT topic bindings
of an operation.
|
TopicLabelTrait |
Binds a member to an MQTT label using the member name.
|
TopicLabelTrait.Provider |
|
TopicSyntaxException |
Thrown when an MQTT topic is malformed.
|
TopologicalIndex |
Creates a reverse-topological ordering of shapes.
|
ToShapeId |
Interface used to convert a shape to a ShapeId.
|
ToSmithyBuilder<T> |
|
TraceFile |
Class that represents the contents of a Smithy trace file.
|
TraceFile.Builder |
Builder for constructing TraceFile's from scratch.
|
TraceMetadata |
Class that defines information a code-generated artifact.
|
TraceMetadata.Builder |
|
TracingSymbolProvider |
|
TracingSymbolProvider.Builder |
Builder to create a TracingSymbolProvider instance.
|
Trait |
Traits provide additional context and semantics to shapes.
|
TraitConflictValidator |
Validates that traits do not conflict.
|
TraitContainer |
Aggregates, merges, and creates traits.
|
TraitContainer.TraitHashMap |
The actual, mutable implementation used to aggregate traits.
|
TraitDefinition |
Trait definition trait.
|
TraitDefinition.Builder |
Builder to create a TraitDefinition.
|
TraitDefinition.Provider |
|
TraitDefinition.StructurallyExclusive |
The structural exclusion semantics of the trait.
|
TraitFactory |
Creates traits using trait data from a model.
|
TraitService |
Creates traits from Node values.
|
TraitTargetValidator |
Validates that traits are only applied to compatible shapes.
|
TraitValueValidator |
Validates that trait values are valid for their trait definitions.
|
TransformConfig |
Transform configuration found in a projection.
|
TransformConfig.Builder |
|
TransformContext |
|
TransformContext.Builder |
|
TriConsumer<T,U,V> |
Similar to BiConsumer , but accepts three arguments.
|
UnionShape |
Tagged union shape that maps member names to member definitions.
|
UnionShape.Builder |
|
UniqueItemsTrait |
Indicates that the members of a list must be unique.
|
UniqueItemsTrait.Provider |
|
UniqueProtocolTestCaseIdValidator |
Validates that the "id" property of smithy.test#httpRequestTests
and smithy.test#httpResponseTests are unique across all test
cases.
|
UniqueWaiterNamesValidator |
Ensures that no two waiters use the same case-insensitive name in the
closure of a service.
|
UnknownProjectionException |
Thrown when a projection extends from an unknown projection.
|
UnknownTransformException |
Thrown when a mapper cannot be found.
|
UnreferencedShapes |
Finds shapes that are not connected to a service shape, are not trait
definitions, and are not referenced by trait definitions.
|
UnreferencedShapeValidator |
Adds a validation note event for each shape in the model that is not
connected to a service shape.
|
UnreferencedTraitDefinitions |
Finds trait definitions that are not connected to a service shape.
|
UnsignedPayloadTrait |
Indicates that the payload of an operation is not to be signed.
|
UnsignedPayloadTrait.Provider |
|
UnstableTrait |
Marks a shape as unstable.
|
UnstableTrait.Provider |
|
UnstableTraitValidator |
Emits a validation event if a model contains shapes that are bound to unstable traits.
|
UnsupportedTraits |
Logs each instance of traits and features that are known to not
work in OpenAPI.
|
UriPattern |
Represents a URI pattern.
|
UseShapeWriterObserver<T extends CodegenWriter<T,?>> |
An observer invoked when a shape CodegenWriter is used.
|
ValidateCommand |
|
ValidatedResult<T> |
Represents the result of an operation and the ValidationEvent s
that occurred.
|
ValidatedResultException |
|
ValidationEvent |
A validation event created when validating a model.
|
ValidationEvent.Builder |
Builds ValidationEvent values.
|
ValidationEventFormatter |
Formats ValidationEvent s.
|
ValidationUtils |
Utility methods used when validating.
|
Validator |
|
ValidatorFactory |
Creates built-in Validator instances and Validator
instances loaded by name.
|
ValidatorService |
Represents a service provider for configurable Validators that appear
in Smithy models.
|
ValidatorService.Provider |
Provides a simple abstraction for creating validator service subclasses.
|
WaitableTrait |
Indicates that an operation has various named "waiters" that can be used
to poll a resource until it enters a desired state.
|
WaitableTrait.Builder |
|
WaitableTrait.Provider |
|
WaitableTraitValidator |
|
Waiter |
Defines an individual operation waiter.
|
Waiter.Builder |
|
Walker |
Walks connected shapes within a Model.
|
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 |
|
XmlNamespaceTraitValidator |
Validates that the xmlNamespace traits are applied correctly for structures.
|
XmlNameTrait |
Provides a custom name to use when serializing a structure member
name as a XML object property.
|
XmlNameTrait.Provider |
|
XmlObject |
|
XmlObject.Builder |
|