Protocols

The following protocols are available globally.

Pagination

  • protocol for all AWSShapes that can be paginated. Adds an initialiser that does a copy but inserts a new integer based pagination token

    See more

    Declaration

    Swift

    public protocol AWSPaginateToken : AWSShape
  • Protocol for services objects. Contains a client to communicate with AWS and config for defining how to communicate

    See more

    Declaration

    Swift

    public protocol AWSService
  • Async Protocol for providing credentials

    See more

    Declaration

    Swift

    @available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
    public protocol AsyncCredentialProvider : CredentialProvider
  • Protocol providing future holding a credential

    See more

    Declaration

    Swift

    public protocol CredentialProvider : CustomStringConvertible
  • Declaration

    Swift

    public protocol ExpiringCredential : Credential
  • Protocol for the input and output objects for all AWS service commands. They need to be Codable so they can be serialized. They also need to provide details on how their container classes are coded when serializing XML.

    See more

    Declaration

    Swift

    public protocol AWSShape
  • AWSShape that can be encoded

    See more

    Declaration

    Swift

    public protocol AWSEncodableShape : AWSShape, Encodable
  • AWSShape that can be decoded

    Declaration

    Swift

    public protocol AWSDecodableShape : AWSShape, Decodable
  • Root AWSShape which include a payload

    See more

    Declaration

    Swift

    public protocol AWSShapeWithPayload
  • base protocol for encoder/decoder objects

    See more

    Declaration

    Swift

    public protocol CustomCoder
  • Protocol for object that will encode a value

    See more

    Declaration

    Swift

    public protocol CustomEncoder : CustomCoder
  • Protocol for object that will decode a value

    See more

    Declaration

    Swift

    public protocol CustomDecoder : CustomCoder
  • Protocol for a PropertyWrapper to properly handle CustomCoding when the wrappedValue is Optional

    See more

    Declaration

    Swift

    public protocol OptionalCustomCodingWrapper

Collection Coders

  • Protocol for array encoding properties. The only property required is the array element name member

    See more

    Declaration

    Swift

    public protocol ArrayCoderProperties
  • Protocol for dictionary encoding properties. The property required are the dictionary element name entry, the key name key and the value name value

    See more

    Declaration

    Swift

    public protocol DictionaryCoderProperties
  • Standard Error type returned by Soto. Initialized with error code and message. Must provide an implementation of var description : String

    See more

    Declaration

    Swift

    public protocol AWSErrorType : CustomStringConvertible, Error
  • HTTP Response

    See more

    Declaration

    Swift

    public protocol AWSHTTPResponse
  • Protocol defining requirements for a HTTPClient

    See more

    Declaration

    Swift

    public protocol AWSHTTPClient
  • Middleware protocol. Gives ability to process requests before they are sent to AWS and process responses before they are converted into output shapes

    See more

    Declaration

    Swift

    public protocol AWSServiceMiddleware
  • Protocol for Retry strategy. Has function returning amount of time before the next retry after an HTTP error

    See more

    Declaration

    Swift

    public protocol RetryPolicy
  • Protocol for matchers used in waiters.

    A matcher returns whether the returned value from an AWS API call matches a certain state

    See more

    Declaration

    Swift

    public protocol AWSWaiterMatcher