AWSShape

public protocol AWSShape : XMLCodable

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.

  • payloadPath Default implementation

    The path to the object that is included in the request/response body

    Default Implementation

    Declaration

    Swift

    static var payloadPath: String? { get }
  • _xmlNamespace Default implementation

    The XML namespace for the object

    Default Implementation

    Declaration

    Swift

    static var _xmlNamespace: String? { get }
  • _members Default implementation

    The array of members serialization helpers

    Default Implementation

    Declaration

    Swift

    static var _members: [AWSShapeMember] { get }
  • validate(name:) Default implementation

    returns if a shape is valid. The checks for validity are defined by the AWS model files we get from http://github.com/aws/aws-sdk-go

    Default Implementation

    stub validate function for all shapes

    Declaration

    Swift

    func validate(name: String) throws
  • getMember(named:) Extension method

    return member with provided name

    Declaration

    Swift

    public static func getMember(named: String) -> AWSShapeMember?
  • getMember(locationNamed:) Extension method

    return member with provided location name

    Declaration

    Swift

    public static func getMember(locationNamed: String) -> AWSShapeMember?
  • pathParams Extension method

    return list of member variables serialized in the URL path

    Declaration

    Swift

    public static var pathParams: [String : String] { get }
  • headerParams Extension method

    return list of member variables serialized in the headers

    Declaration

    Swift

    public static var headerParams: [String : String] { get }
  • queryParams Extension method

    return list of member variables serialized as query parameters

    Declaration

    Swift

    public static var queryParams: [String : String] { get }
  • hasEncodableBody Extension method

    returns whether the shape has any members being serialized into the request/response body

    Declaration

    Swift

    public static var hasEncodableBody: Bool { get }
  • validate() Extension method

    Undocumented

    Declaration

    Swift

    public func validate() throws
  • validate(_:name:parent:min:) Extension method

    Undocumented

    Declaration

    Swift

    public func validate<T>(_ value: T, name: String, parent: String, min: T) throws where T : BinaryInteger
  • validate(_:name:parent:max:) Extension method

    Undocumented

    Declaration

    Swift

    public func validate<T>(_ value: T, name: String, parent: String, max: T) throws where T : BinaryInteger
  • validate(_:name:parent:min:) Extension method

    Undocumented

    Declaration

    Swift

    public func validate<T>(_ value: T, name: String, parent: String, min: T) throws where T : FloatingPoint
  • validate(_:name:parent:max:) Extension method

    Undocumented

    Declaration

    Swift

    public func validate<T>(_ value: T, name: String, parent: String, max: T) throws where T : FloatingPoint
  • validate(_:name:parent:min:) Extension method

    Undocumented

    Declaration

    Swift

    public func validate<T>(_ value: T, name: String, parent: String, min: Int) throws where T : Collection
  • validate(_:name:parent:max:) Extension method

    Undocumented

    Declaration

    Swift

    public func validate<T>(_ value: T, name: String, parent: String, max: Int) throws where T : Collection

  • Undocumented

    Declaration

    Swift

    public func validate(_ value: String, name: String, parent: String, pattern: String) throws
  • validate(_:name:parent:min:) Extension method

    Undocumented

    Declaration

    Swift

    public func validate<T>(_ value: T?, name: String, parent: String, min: T) throws where T : BinaryInteger
  • validate(_:name:parent:max:) Extension method

    Undocumented

    Declaration

    Swift

    public func validate<T>(_ value: T?, name: String, parent: String, max: T) throws where T : BinaryInteger
  • validate(_:name:parent:min:) Extension method

    Undocumented

    Declaration

    Swift

    public func validate<T>(_ value: T?, name: String, parent: String, min: T) throws where T : FloatingPoint
  • validate(_:name:parent:max:) Extension method

    Undocumented

    Declaration

    Swift

    public func validate<T>(_ value: T?, name: String, parent: String, max: T) throws where T : FloatingPoint
  • validate(_:name:parent:min:) Extension method

    Undocumented

    Declaration

    Swift

    public func validate<T>(_ value: T?, name: String, parent: String, min: Int) throws where T : Collection
  • validate(_:name:parent:max:) Extension method

    Undocumented

    Declaration

    Swift

    public func validate<T>(_ value: T?, name: String, parent: String, max: Int) throws where T : Collection

  • Undocumented

    Declaration

    Swift

    public func validate(_ value: String?, name: String, parent: String, pattern: String) throws
  • idempotencyToken() Extension method

    Return an idempotencyToken

    Declaration

    Swift

    public static func idempotencyToken() -> String
  • getXMLContainerCoding(for:) Extension method

    Undocumented

    Declaration

    Swift

    public static func getXMLContainerCoding(for key: CodingKey) -> XMLContainerCoding?