Specifications

Smithy is split into several specifications.

Smithy specification

• Smithy specification
  • Conventions used in this document
  • Table of contents
    • 1. The Smithy model
    • 2. Prelude model
    • 3. Constraint traits
    • 4. Documentation traits
    • 5. Type refinement traits
    • 6. Protocol traits
    • 7. Authentication traits
    • 8. Behavior traits
    • 9. Resource traits
    • 10. Streaming Traits
    • 11. HTTP binding traits
    • 12. XML binding traits
    • 13. Endpoint Traits
    • 14. Selectors
    • 15. Model validation
    • 16. Smithy IDL
    • 17. JSON AST

Additional specifications

• HTTP Protocol Compliance Tests
• Waiters
• MQTT Protocol Bindings

AWS specifications

• AWS specifications
  • AWS Core Specification
  • AWS Authentication Traits
  • AWS IAM traits
  • Amazon API Gateway traits
  • AWS CloudFormation traits
  • AWS Protocols
  • AWS Service Customizations

Trait Index

The following is a list of all traits across all of the above specifications.

• aws.api#arn
• aws.api#arnReference
• aws.api#clientDiscoveredEndpoint
• aws.api#clientEndpointDiscovery
• aws.api#clientEndpointDiscoveryId
• aws.api#controlPlane
• aws.api#data
• aws.api#dataPlane
• aws.api#service
• aws.apigateway#apiKeySource
• aws.apigateway#authorizer
• aws.apigateway#authorizers
• aws.apigateway#integration
• aws.apigateway#mockIntegration
• aws.apigateway#requestValidator
• aws.auth#cognitoUserPools
• aws.auth#sigv4
• aws.auth#unsignedPayload
• aws.cloudformation#cfnAdditionalIdentifier
• aws.cloudformation#cfnDefaultValue
• aws.cloudformation#cfnExcludeProperty
• aws.cloudformation#cfnMutability
• aws.cloudformation#cfnName
• aws.cloudformation#cfnResource
• aws.iam#actionPermissionDescription
• aws.iam#conditionKeys
• aws.iam#defineConditionKeys
• aws.iam#disableConditionKeyInference
• aws.iam#iamResource
• aws.iam#requiredActions
• aws.iam#supportedPrincipalTypes
• aws.protocols#awsJson1_0
• aws.protocols#awsJson1_1
• aws.protocols#awsQuery
• aws.protocols#awsQueryCompatible
• aws.protocols#awsQueryError
• aws.protocols#ec2Query
• aws.protocols#ec2QueryName
• aws.protocols#httpChecksum
• aws.protocols#restJson1
• aws.protocols#restXml
• smithy.api#auth
• smithy.api#authDefinition
• smithy.api#box
• smithy.api#cors
• smithy.api#deprecated
• smithy.api#documentation
• smithy.api#endpoint
• smithy.api#enum
• smithy.api#error
• smithy.api#eventHeader
• smithy.api#eventPayload
• smithy.api#examples
• smithy.api#externalDocumentation
• smithy.api#hostLabel
• smithy.api#http
• smithy.api#httpApiKeyAuth
• smithy.api#httpBasicAuth
• smithy.api#httpBearerAuth
• smithy.api#httpChecksumRequired
• smithy.api#httpDigestAuth
• smithy.api#httpError
• smithy.api#httpHeader
• smithy.api#httpLabel
• smithy.api#httpPayload
• smithy.api#httpPrefixHeaders
• smithy.api#httpQuery
• smithy.api#httpQueryParams
• smithy.api#httpResponseCode
• smithy.api#idRef
• smithy.api#idempotencyToken
• smithy.api#idempotent
• smithy.api#input
• smithy.api#internal
• smithy.api#jsonName
• smithy.api#mediaType
• smithy.api#noReplace
• smithy.api#optionalAuth
• smithy.api#output
• smithy.api#paginated
• smithy.api#pattern
• smithy.api#private
• smithy.api#protocolDefinition
• smithy.api#range
• smithy.api#readonly
• smithy.api#recommended
• smithy.api#references
• smithy.api#required
• smithy.api#requiresLength
• smithy.api#resourceIdentifier
• smithy.api#retryable
• smithy.api#sensitive
• smithy.api#since
• smithy.api#sparse
• smithy.api#streaming
• smithy.api#tags
• smithy.api#timestampFormat
• smithy.api#title
• smithy.api#uniqueItems
• smithy.api#unstable
• smithy.api#xmlAttribute
• smithy.api#xmlFlattened
• smithy.api#xmlName
• smithy.api#xmlNamespace
• smithy.mqtt#publish
• smithy.mqtt#subscribe
• smithy.mqtt#topicLabel
• smithy.test#httpMalformedRequestTests
• smithy.test#httpRequestTests
• smithy.test#httpResponseTests
• smithy.waiters#waitable