smithy.api.package.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smithy4s-core_sjs1_3 Show documentation
core
There is a newer version: 0.19.0-41-91762fb
package smithy

package object api {

  /** Defines the ordered list of supported authentication schemes.
    * @param member
    *   A string that must target an auth trait.
    */
  type Auth = smithy.api.Auth.Type
  /** A string that must target an auth trait. */
  type AuthTraitReference = smithy.api.AuthTraitReference.Type
  /** Provides a structure member with a default value. When added to root
    * level shapes, requires that every targeting structure member defines the
    * same default value on the member or sets a default of null.
    * 
    * This trait can currently only be used in Smithy 2.0 models.
    */
  type Default = smithy.api.Default.Type
  /** Adds documentation to a shape or member using CommonMark syntax. */
  type Documentation = smithy.api.Documentation.Type
  /** Constrains the acceptable values of a string to a fixed set
    * of constant values.
    * @param member
    *   An enum definition for the enum trait.
    */
  @deprecated(message = "The enum trait is replaced by the enum shape in Smithy 2.0", since = "2.0")
  type Enum = smithy.api.Enum.Type
  /** The optional name or label of the enum constant value.
    * 
    * This property is used in code generation to provide a label for
    * each enum value. No two enums can have the same 'name' value.
    */
  type EnumConstantBodyName = smithy.api.EnumConstantBodyName.Type
  /** Defines the value of an enum member. */
  type EnumValue = smithy.api.EnumValue.Type
  /** Provides example inputs and outputs for operations. */
  type Examples = smithy.api.Examples.Type
  /** Provides a link to additional documentation. */
  type ExternalDocumentation = smithy.api.ExternalDocumentation.Type
  /** Defines an HTTP response code for an operation error. */
  type HttpError = smithy.api.HttpError.Type
  /** Binds a structure member to an HTTP header. */
  type HttpHeader = smithy.api.HttpHeader.Type
  /** Binds a map of key-value pairs to prefixed HTTP headers. */
  type HttpPrefixHeaders = smithy.api.HttpPrefixHeaders.Type
  /** Binds an operation input structure member to a query string parameter. */
  type HttpQuery = smithy.api.HttpQuery.Type
  /** Allows a serialized object property name to differ from a structure member
    * name used in the model.
    */
  type JsonName = smithy.api.JsonName.Type
  type LocalMixinTrait = smithy.api.LocalMixinTrait.Type
  type LocalMixinTraitList = smithy.api.LocalMixinTraitList.Type
  /** Describes the contents of a blob shape using a media type as defined by
    * RFC 6838 (e.g., "video/quicktime").
    */
  type MediaType = smithy.api.MediaType.Type
  type NonEmptyString = smithy.api.NonEmptyString.Type
  type NonEmptyStringList = smithy.api.NonEmptyStringList.Type
  type NonEmptyStringMap = smithy.api.NonEmptyStringMap.Type
  /** Restricts string shape values to a specified regular expression. */
  type Pattern = smithy.api.Pattern.Type
  type PrimitiveShort = smithy.api.PrimitiveShort.Type
  /** Defines the resource shapes that are referenced by a string shape or a
    * structure shape and the members of the structure that provide values for
    * the identifiers of the resource.
    */
  type References = smithy.api.References.Type
  /** Defines the priority-ordered list of compression algorithms supported by
    * the service operation.
    */
  type RequestCompressionEncodingsList = smithy.api.RequestCompressionEncodingsList.Type
  /** Indicates that the targeted structure member provides an identifier for
    * a resource.
    */
  type ResourceIdentifier = smithy.api.ResourceIdentifier.Type
  /** Defines the version or date in which a shape or member was added to the
    * model.
    */
  type Since = smithy.api.Since.Type
  /** Suppresses validation events by ID for a given shape. */
  type Suppress = smithy.api.Suppress.Type
  /** Tags a shape with arbitrary tag names that can be used to filter and
    * group shapes in the model.
    */
  type Tags = smithy.api.Tags.Type
  /** Defines a proper name for a service or resource shape.
    * 
    * This title can be used in automatically generated documentation
    * and other contexts to provide a user friendly name for services
    * and resources.
    */
  type Title = smithy.api.Title.Type
  type TraitDiffRules = smithy.api.TraitDiffRules.Type
  type TraitShapeId = smithy.api.TraitShapeId.Type
  type TraitShapeIdList = smithy.api.TraitShapeIdList.Type
  /** A meta-trait used to apply validation to a specific shape in the model that a trait is applied to.
    * 
    * `traitValidators` is a map of validation event IDs to validators to apply to a shape.
    * Selectors are used to identify shapes that are incompatible with a constrained trait.
    * The shape with the targeted trait applied MUST be a valid entry point for the selector.
    * 
    * The following example defines a protocol that does not support document types. Each matching member found in the
    * closure of an attached shape emits a validation event:
    * 
    * ```
    * {@literal @}trait(selector: "service")
    * {@literal @}traitValidators(
    *     "myCustomProtocol.NoDocuments": {
    *         selector: "~> member :test(> document)"
    *         message: "This protocol does not support document types"
    *     }
    * )
    * {@literal @}protocolDefinition
    * structure myCustomProtocol {}
    * ```
    * @param key
    *   The validation event ID to emit when the constraint finds an incompatible shape.
    * @param value
    *   The validator to apply.
    */
  type TraitValidators = smithy.api.TraitValidators.Type
  /** Changes the serialized element or attribute name of a structure, union,
    * or member.
    */
  type XmlName = smithy.api.XmlName.Type

}