ast library
Smithy AST representation.
Classes
- AcceptorDefinition
- AnnotationTrait
- ApplyShape
- ApplyShapeBuilder
- ArnReferenceTrait
- ArnTrait
- AuthDefinitionTrait
- AuthTrait
- AwsJson1_0Trait
- AwsJson1_1Trait
- AWSProtocolTrait
- AwsQueryCompatibleTrait
- AwsQueryErrorTrait
- AwsQueryTrait
- BigDecimalShape
- BigDecimalShapeBuilder
- BigIntegerShape
- BigIntegerShapeBuilder
- BlobShape
- BlobShapeBuilder
- BooleanShape
- BooleanShapeBuilder
- BoxTrait
- ByteShape
- ByteShapeBuilder
-
CategoryShapeVisitor<
R> - Visits shapes by category.
- ClientDiscoveredEndpointTrait
- ClientEndpointDiscoveryIdTrait
- ClientEndpointDiscoveryTrait
- ClientOptionalTrait
- CognitoUserPoolsTrait
- Configures an Amazon Cognito User Pools auth scheme.
- CollectionShape
- Abstract class representing Set and List shapes.
- CollectionShapeBuilder
- ControlPlaneTrait
- CorsTrait
- DataTrait
- DefaultTrait
- DeprecatedTrait
- DocumentationTrait
- DocumentShape
- DocumentShapeBuilder
- DoubleShape
- DoubleShapeBuilder
- DynamicTrait
- A general-purpose trait used to represent traits that are defined in the model and have no concrete implementation.
- Ec2QueryNameTrait
- Provides a custom name to use when serializing a structure member name as an EC2 query property.
- Ec2QueryTrait
- EndpointTrait
- EntityShape
- Abstract class representing service and resource shapes.
- EnumDefinition
- EnumShape
- EnumShapeBuilder
- EnumTrait
- EnumValueTrait
- ErrorExample
- ErrorTrait
- Indicates that a structure can be used as an error.
- EventHeaderTrait
- Marks a structure member of an event as an event header.
- EventPayloadTrait
- Marks a structure member of an event as the event payload.
- Example
- ExamplesTrait
- ExternalDocumentationTrait
- FloatShape
- FloatShapeBuilder
- HostLabelTrait
- Binds an input member to a label in the hostPrefix of an endpoint trait on an operation.
- HttpApiKeyAuthTrait
- HttpBasicAuthTrait
- An auth scheme trait uses HTTP basic auth.
- HttpBearerAuthTrait
- An auth scheme trait uses HTTP bearer auth.
- HttpChecksumRequiredTrait
- Indicates that an operation requires a checksum in its HTTP request. By default, the checksum used for a service is a MD5 checksum passed in the Content-MD5 header.
- HttpChecksumTrait
- HttpDigestAuthTrait
- An auth scheme trait uses HTTP digest auth.
- HttpErrorTrait
- HttpHeaderTrait
- HttpLabelTrait
- Binds a member to a URI label of an input of an operation using the member name.
- HttpMalformedRequestDefinition
- Defines a request to be used by an HttpMalformedRequest test case.
- HttpMalformedRequestTestCase
- HttpMalformedRequestTestsTrait
- Defines protocol tests for malformed HTTP request handling.
- HttpMalformedResponseBodyDefinition
- Defines the response expected by an HttpMalformedRequest test case.
- HttpMalformedResponseDefinition
- Defines the response expected by an HttpMalformedRequest test case.
-
HttpMessageTestCase<
T extends HttpMessageTestCase< T> > - Defines how an HTTP request is serialized given a specific protocol, authentication scheme, and set of input parameters.
- HttpPayloadTrait
- Binds a single structure member to the payload of an HTTP request.
- HttpPrefixHeadersTrait
- Binds a map structure member to prefixed HTTP headers.
- HttpQueryParamsTrait
- Binds a map structure member to the HTTP query string.
- HttpQueryTrait
- Binds a member to an HTTP query string.
- HttpRequestTestCase
- HttpRequestTestsTrait
- Defines protocol tests for malformed HTTP request handling.
- HttpResponseCodeTrait
- Indicates that the structure member represents the HTTP response status code. This MAY differ from the HTTP status code provided in the response.
- HttpResponseTestCase
- HttpResponseTestsTrait
- Defines protocol tests for malformed HTTP request handling.
- HttpTrait
- Defines the HTTP request and response code bindings of an operation.
- IdempotencyTokenTrait
- Defines an operation input member that is used to prevent replayed requests.
- IdempotentTrait
- Indicates that an operation is idempotent.
- IdRefTrait
- InputTrait
- Specializes a structure as the input of a single operation.
- IntegerShape
- IntegerShapeBuilder
- IntEnumShape
- IntEnumShapeBuilder
- InternalTrait
- Shapes marked with the internal trait are meant only for internal use and must not be exposed to customers.
- JsonNameTrait
- Provides a custom name to use when serializing a structure member name as a JSON object property.
- LengthTrait
- ListShape
- ListShapeBuilder
- LongShape
- LongShapeBuilder
- MapShape
- MapShapeBuilder
- Matcher
- MediaTypeTrait
- Documents the media type of a blob shape.
- MemberShape
- MemberShapeBuilder
- NamedMembersMap
- NamedMembersMapSerializer
- NamedMembersShape
- NamedMembersShapeBuilder
- NoReplaceTrait
- Indicates that the put lifecycle operation of a resource can only be used to create a resource and cannot replace an existing resource.
- NullableShapeIdConverter
- OperationShape
- OperationShapeBuilder
- OptionalAuthTrait
- Indicates that an operation / service supports unauthenticated access.
- OutputTrait
- Specializes a structure as the output of a single operation.
- PaginatedTrait
- Defines the pagination functionality of an operation.
- ParameterizedHttpMalformedRequestTestCase
- PathMatcher
- PatternTrait
- Restricts string values to a specified regular expression.
- PrimitiveBooleanShape
- PrimitiveBooleanShapeBuilder
- PrimitiveByteShape
- PrimitiveByteShapeBuilder
- PrimitiveDoubleShape
- PrimitiveDoubleShapeBuilder
- PrimitiveFloatShape
- PrimitiveFloatShapeBuilder
- PrimitiveIntegerShape
- PrimitiveIntegerShapeBuilder
- PrimitiveLongShape
- PrimitiveLongShapeBuilder
- PrimitiveShortShape
- PrimitiveShortShapeBuilder
- PrivateTrait
- Indicates that a shape cannot be targeted outside of the namespace in which it was defined.
- ProtocolDefinitionTrait
- A trait that is attached to other traits to define a Smithy protocol.
- RangeTrait
- Constrains a shape to minimum and maximum numeric range.
- ReadonlyTrait
- Indicates that an operation is read-only.
- RecommendedTrait
- ReferencesTrait
- Defines references to resources within a structure.
- RequiredTrait
- Indicates that a structure member is required.
- RequiresLengthTrait
- Indicates that the streaming blob must be finite and has a known size.
- ResolvedServiceTrait
- ResourceIdentifierTrait
- Binds an operation input member to a named identifier of the resource to which the operation is bound.
- ResourceReference
- Reference to a resource.
- ResourceShape
- ResourceShapeBuilder
- RestJson1Trait
-
Important: This protocol only permits the
httpPayloadtrait to be applied to members that target structures, documents, strings, blobs, or unions. - RestXmlTrait
- A RESTful protocol that sends XML in structured payloads.
- RetryableTrait
- Marks an error structure as retryable.
- S3UnwrappedXmlOutputTrait
- Segment
- SensitiveTrait
- Indicates that the data stored in the shape or member is sensitive and should be handled with care.
- ServiceShape
- ServiceShapeBuilder
- ServiceTrait
- Registers a service as an AWS service. This trait is required for all AWS services modeled in Smithy.
- SetShape
- SetShapeBuilder
- Shape
- ShapeBuilder
- ShapeId
- ShapeIdConverter
- ShapeIdSerializer
- ShapeMap
- ShapeMapSerializer
- ShapeRef
- ShapeRefBuilder
- ShapeSerializer
- ShapeType
-
ShapeVisitor<
R> - Visits shapes.
- ShortShape
- ShortShapeBuilder
- SigV4Trait
- Adds AWS signature version 4 authentication to a service or operation.
- SimpleShape
- Marker class for primitive/simple types.
- SimpleShapeBuilder
- SinceTrait
- Defines when a shape or member was added to the model.
- SmithyAst
- SmithyAstBuilder
- SmithyPattern
- SmithyVersion
- SmithyVersionSerializer
- SparseTrait
- Indicates that a list or map is sparse, meaning they may contain nulls.
- 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.
- StringEnumShape
- StringEnumShapeBuilder
- StringListTrait
- Contains abstract functionality to build traits that contain a list of strings.
- StringShape
- StringShapeBuilder
- StringTrait
- StructureShape
- StructureShapeBuilder
- SuppressTrait
- TagsTrait
- Applies tags to a shape.
- TimestampFormatTrait
- Defines a custom serialization format for a timestamp.
- TimestampShape
- TimestampShapeBuilder
- TitleTrait
- Provides a human-readable proper noun title to services and resources.
-
Trait<
TraitValue extends Object> - Traits provide additional context and semantics to shapes.
- TraitMap
- TraitMapSerializer
- UnionShape
- UnionShapeBuilder
- UniqueItemsTrait
- UnitTypeTrait
- UnsignedPayloadTrait
- Indicates that the payload of an operation is not to be signed.
- UnstableTrait
- Marks a shape as unstable.
- UriPattern
- WaitableTrait
- Waiter
- XmlAttributeTrait
- Marks a structure member to be serialized to/from an XML attribute.
- XmlFlattenedTrait
- XmlNamespaceTrait
- Defines the XML Namespace prefix and URI.
- XmlNameTrait
- Provides a custom name to use when serializing a structure member name as a XML object property.
Enums
- AcceptorState
- AppliesTo
- Category
- ChecksumAlgorithm
- ErrorKind
- Location
- MatcherType
- PathComparator
- SegmentType
- TimestampFormat
- The format to use for serializing/deserializing a timestamp as defined by the TimestampFormatTrait.
Extensions
Constants
- coreNamespace → const String
Typedefs
-
TraitConstructor<
TraitValue extends Object, T extends Trait< TraitValue> > = T Function(Object?) - Constructs Trait objects from JSON values.
Exceptions / Errors
- InvalidPatternError
- Error thrown for invalid patterns.
- InvalidUriPatternError
- Error thrown for invalid HTTP URI patterns.