Structures

The following structures are available globally.

AWSEndpoints
Endpoint list
See more
Declaration
Swift

public struct AWSEndpoints
AWSEndpointDiscovery
Helper object holding endpoint storage and closure used to discover endpoint
See more
Declaration
Swift

public struct AWSEndpointDiscovery
AWSPayload
Holds a request or response payload. A request payload can be in the form of either a ByteBuffer or a stream function that will supply ByteBuffers to the HTTP client. A response payload only comes in the form of a ByteBuffer
See more
Declaration
Swift

public struct AWSPayload

extension AWSPayload: Decodable
CredentialProviderFactory
A helper struct to defer the creation of a CredentialProvider until after the AWSClient has been created.
See more
Declaration
Swift

public struct CredentialProviderFactory


                    
                    
                    CredentialProviderError

Declaration

Swift

public struct CredentialProviderError : Error, Equatable

extension CredentialProviderError: CustomStringConvertible

RotatingCredential
Basic implementation of a struct conforming to ExpiringCredential to be used with the RotatingCredentialProvider
See more
Declaration
Swift

public struct RotatingCredential : ExpiringCredential
NullCredentialProvider
Credential provider that always fails
See more
Declaration
Swift

public struct NullCredentialProvider : CredentialProvider
AWSMemberEncoding
Structure defining where to serialize member of AWSShape.
See more
Declaration
Swift

public struct AWSMemberEncoding
AWSShapePayloadOptions
AWSShapeWithPayload options.
See more
Declaration
Swift

public struct AWSShapePayloadOptions : OptionSet


                    
                    
                    Region

Enumeration for all AWS server regions

Declaration

Swift

public struct Region : RawRepresentable, Equatable

extension Region: CustomStringConvertible

extension Region: Codable


                    
                    
                    AWSPartition

Enumeration for all AWS partitions

Declaration

Swift

public struct AWSPartition : RawRepresentable, Equatable, Hashable


                    
                    
                    CustomCoding

Property wrapper that applies a custom encoder and decoder to its wrapped value

Declaration

Swift

@propertyWrapper
public struct CustomCoding<Coder> where Coder : CustomCoder

extension CustomCoding: JMESPropertyWrapper

extension CustomCoding: Decodable where Coder: CustomDecoder

extension CustomCoding: Encodable where Coder: CustomEncoder


                    
                    
                    OptionalCustomCoding

Property wrapper that applies a custom encoder and decoder to its wrapped optional value

Declaration

Swift

@propertyWrapper
public struct OptionalCustomCoding<Coder> where Coder : CustomCoder

extension OptionalCustomCoding: JMESPropertyWrapper

extension OptionalCustomCoding: OptionalCustomCodingWrapper

extension OptionalCustomCoding: Decodable where Coder: CustomDecoder

extension OptionalCustomCoding: Encodable where Coder: CustomEncoder

Collection Coders


                    
                    
                    ArrayCoder

Coder for encoding/decoding Arrays. This is extended to support encoding and decoding based on whether Element is Encodable or Decodable.

Declaration

Swift

public struct ArrayCoder<Properties, Element> : CustomCoder where Properties : ArrayCoderProperties

extension ArrayCoder: CustomDecoder where Element: Decodable

extension ArrayCoder: CustomEncoder where Element: Encodable


                    
                    
                    DictionaryCoder

Coder for encoding/decoding Dictionaries. This is extended to support encoding and decoding based on whether Key and Value are Encodable or Decodable.

Declaration

Swift

public struct DictionaryCoder<Properties, Key, Value> : CustomCoder where Properties : DictionaryCoderProperties, Key : Hashable

extension DictionaryCoder: CustomDecoder where Key: Decodable, Value: Decodable

extension DictionaryCoder: CustomEncoder where Key: Encodable, Value: Encodable

StandardArrayCoderProperties
The most common array encoding property is an element name “member”
See more
Declaration
Swift

public struct StandardArrayCoderProperties : ArrayCoderProperties
StandardDictionaryCoderProperties
The most common dictionary encoding properties are element name “entry”, key name “key”, value name “value”
See more
Declaration
Swift

public struct StandardDictionaryCoderProperties : DictionaryCoderProperties

TimeStamp Coders

ISO8601DateCoder
Date coder for ISO8601 format
See more
Declaration
Swift

public struct ISO8601DateCoder : DateFormatCoder
HTTPHeaderDateCoder
Date coder for HTTP header format
See more
Declaration
Swift

public struct HTTPHeaderDateCoder : DateFormatCoder


                    
                    
                    UnixEpochDateCoder

Unix Epoch Date coder

Declaration

Swift

public struct UnixEpochDateCoder : CustomDecoder, CustomEncoder

QueryEncoder
The wrapper struct for encoding Codable classes to Query dictionary
See more
Declaration
Swift

public struct QueryEncoder


                    
                    
                    AWSClientError

Declaration

Swift

public struct AWSClientError : AWSErrorType

extension AWSClientError: Equatable

extension AWSClientError: CustomStringConvertible

AWSErrorContext
Additional information about error
See more
Declaration
Swift

public struct AWSErrorContext
AWSResponseError
Standard Response Error type returned by Soto. If the error code is unrecognised then this is returned
See more
Declaration
Swift

public struct AWSResponseError : AWSErrorType
AWSRawError
Unrecognised error. Used when we cannot extract an error code from the AWS response. Returns full body of error response
See more
Declaration
Swift

public struct AWSRawError : Error, CustomStringConvertible


                    
                    
                    AWSServerError

Declaration

Swift

public struct AWSServerError : AWSErrorType

extension AWSServerError: Equatable

extension AWSServerError: CustomStringConvertible

AWSHTTPRequest
HTTP Request
See more
Declaration
Swift

public struct AWSHTTPRequest
AWSMiddlewareContext
Context object sent to AWSServiceMiddleware chain functions
See more
Declaration
Swift

public struct AWSMiddlewareContext
AWSLoggingMiddleware
Middleware struct that outputs the contents of requests being sent to AWS and the bodies of the responses received
See more
Declaration
Swift

public struct AWSLoggingMiddleware : AWSServiceMiddleware
AWSRequest
Object encapsulating all the information needed to generate a raw HTTP request to AWS
See more
Declaration
Swift

public struct AWSRequest
AWSResponse
Structure encapsulating a processed HTTP Response
See more
Declaration
Swift

public struct AWSResponse
RetryPolicyFactory
Creates a RetryPolicy for AWSClient to use
See more
Declaration
Swift

public struct RetryPolicyFactory
JMESPathMatcher
Match whether the value indicated by JMESPath matches an expected value
See more
Declaration
Swift

public struct JMESPathMatcher<Value> : AWSWaiterMatcher where Value : CustomStringConvertible
JMESAnyPathMatcher
Match whether any of the values indicated by JMESPath matches an expected value
See more
Declaration
Swift

public struct JMESAnyPathMatcher<Value> : AWSWaiterMatcher where Value : CustomStringConvertible
JMESAllPathMatcher
Match whether all of the values indicated by JMESPath matches an expected value
See more
Declaration
Swift

public struct JMESAllPathMatcher<Value> : AWSWaiterMatcher where Value : CustomStringConvertible
AWSSuccessMatcher
Match whether an AWS API call was successful
See more
Declaration
Swift

public struct AWSSuccessMatcher : AWSWaiterMatcher
AWSErrorStatusMatcher
Match whether an AWS API call returns a specific HTTP response code
See more
Declaration
Swift

public struct AWSErrorStatusMatcher : AWSWaiterMatcher
AWSErrorCodeMatcher
Match whether an AWS API call returns a specific error code
See more
Declaration
Swift

public struct AWSErrorCodeMatcher : AWSWaiterMatcher