SotoCore · soto-core documentation

func AWSMiddlewareStack(@AWSMiddlewareBuilder _ builder: () -> some AWSMiddlewareProtocol) -> some AWSMiddlewareProtocol

func soto_crc32(_ crc: CRC32, bytes: some Collection<UInt8>) -> CRC32

Calculate CRC32 checksum

func soto_crc32c(_ crc: CRC32, bytes: some Collection<UInt8>) -> CRC32

Calculate CRC32C checksum

protocol AWSDecodableShape : AWSShape, Decodable

AWSShape that can be decoded from API output

protocol AWSEncodableShape : AWSShape, Encodable

AWSShape that can be encoded into API input

protocol AWSErrorType : CustomStringConvertible, Error

Standard Error type returned by Soto.

protocol AWSHTTPClient : Sendable

Protocol for HTTP clients that work with Soto

protocol AWSMiddlewareProtocol : Sendable

Middleware protocol, with function that takes a request, context and the next function to call

protocol AWSPaginateToken : AWSShape

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

protocol AWSService : Sendable

Services object protocol. Contains a client to communicate with AWS and configuration for defining how to communicate.

protocol AWSShape : Sendable

Protocol for the input and output objects for all AWS service commands.

protocol AWSWaiterMatcher : Sendable

Protocol for matchers used in waiters.

protocol ArrayCoderProperties

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

protocol CredentialProvider : CustomStringConvertible, Sendable

Provides AWS credentials

protocol CustomCoder

base protocol for encoder/decoder objects

protocol CustomDecoder : CustomCoder

Protocol for object that will decode a value

protocol CustomEncoder : CustomCoder

Protocol for object that will encode a value

protocol DateFormatCoder : CustomDecoder, CustomEncoder where Self.CodableValue == Date

Protocol for time stamp coders that use a DateFormatter. Use this to enforce the timestamp format we require, or to set the timestamp format output

protocol DictionaryCoderProperties

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

protocol ExpiringCredential : Credential

Credential provider whose credentials expire over tiem.

protocol OptionalCustomCodingWrapper

Protocol for a PropertyWrapper to properly handle CustomCoding when the wrappedValue is Optional

protocol RetryPolicy : Sendable

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

struct ARN

Amazon Resource Name (ARN). A unique identifier assigned to AWS resource

struct AWSBase64Data

Holds request or response data that is encoded as base64 during transit

final class AWSClient

Client managing communication with AWS services

struct AWSClientError

enum AWSDocument

Document value that can hold arbitrary data (See https://smithy.io/2.0/spec/simple-types.html#document)

struct AWSEditHeadersMiddleware

Middleware for editing header values sent to AWS service.

struct AWSEndpointStorage

Endpoint Storage attached to a Service

struct AWSEndpoints

Endpoint list

struct AWSErrorCodeMatcher

Match whether an AWS API call returns a specific error code

struct AWSErrorContext

Additional information about error

struct AWSErrorStatusMatcher

Match whether an AWS API call returns a specific HTTP response code

struct AWSEventPayload

Event payload type. To aid encoding and decoding

struct AWSEventStream<Event> where Event : Sendable

AsyncSequence of Event stream events

struct AWSEventStreamError

Errors thrown while decoding the event stream buffers

struct AWSHTTPBody

Storage for HTTP body which can be either a ByteBuffer or an AsyncSequence of ByteBuffers

struct AWSHTTPRequest

Object encapsulating all the information needed to generate a raw HTTP request to AWS

struct AWSHTTPResponse

Structure encapsulating an HTTP Response

struct AWSLoggingMiddleware

Middleware that outputs the contents of requests being sent to AWS and the contents of the responses received.

struct AWSMiddleware

Middleware initialized with a middleware handle

@resultBuilder enum AWSMiddlewareBuilder

struct AWSMiddlewareContext

Context object sent to AWSMiddlewareProtocol handle functions

struct AWSPartition

Enumeration for all AWS partitions

struct AWSRawError

Raw unprocessed error.

struct AWSResponseError

Response Error type returned by Soto if the error code is unrecognised

struct AWSServerError

final class AWSServiceConfig

Configuration class defining an AWS service

struct AWSShapeOptions

AWSShape options.

struct AWSSuccessMatcher

Match whether an AWS API call was successful

struct AWSTracingMiddleware

Middleware for adding tracing to AWS calls.

struct AnyAsyncSequence<Element>

struct ArrayCoder<Properties, Element> where Properties : ArrayCoderProperties, Element : Sendable

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

struct ByteBufferAsyncSequence

Provide ByteBuffer as an AsyncSequence of equal size blocks

struct CredentialProviderError

struct CredentialProviderFactory

Provides factory functions for CredentialProviders.

@propertyWrapper struct CustomCoding<Coder> where Coder : CustomCoder

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

final class DeferredCredentialProvider

Wrap and store result from another credential provider.

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

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

struct EC2ArrayCoder<Properties, Element> where Properties : ArrayCoderProperties, Element : Sendable

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

struct EmptyCredential

Empty credentials

struct EndpointDiscoveryMiddleware

Middleware that runs an endpoint discovery function to set service endpoint prior to running operation

struct EndpointVariantType

Endpoint variant types

struct FixedSizeByteBufferAsyncSequence<Base> where Base : AsyncSequence, Base.Element == ByteBuffer

An AsyncSequence that returns fixed size ByteBuffers from an AsyncSequence of ByteBuffers

struct HTTPHeaderDateCoder

Date coder for HTTP header format

struct HeaderDecodingError

Decoding error returned when extracting data out of response headers

struct ISO8601DateCoder

Date coder for ISO8601 format

struct JMESAllPathMatcher<Value> where Value : CustomStringConvertible

Match whether all of the values indicated by JMESPath matches an expected value

struct JMESAnyPathMatcher<Value> where Value : CustomStringConvertible

Match whether any of the values indicated by JMESPath matches an expected value

struct JMESPathMatcher<Value> where Value : CustomStringConvertible

Match whether the value indicated by JMESPath matches an expected value

struct NullCredentialProvider

Credential provider that always fails

@propertyWrapper struct OptionalCustomCoding<Coder> where Coder : CustomCoder

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

struct QueryEncoder

The wrapper struct for encoding Codable classes to Query dictionary

struct Region

Enumeration for all AWS server regions

class RequestEncodingContainer

Request container used during Codable encode(to:) that allows for encoding data into the request that is not part of standard Codable output

struct ResponseDecodingContainer

Response container used during Codable init(from:) that allows for extracting data from the full response and not only its body

struct RetryPolicyFactory

Creates a RetryPolicy for AWSClient to use

enum RetryStatus

Return value for RetryPolicy.getRetryWaitTime. Either retry after time amount or don’t retry

struct RotatingCredential

Basic implementation of a struct conforming to ExpiringCredential.

final class RotatingCredentialProvider

Wrap a credential provider that returns an ExpiringCredential

struct S3Middleware

Middleware applied to S3 service

enum ServiceProtocol

Communication protocol

struct StandardArrayCoderProperties

The most common array encoding property is an element name “member”

struct StandardDictionaryCoderProperties

The most common dictionary encoding properties are element name “entry”, key name “key”, value name “value”

struct TreeHashMiddleware

Middleware to add tree hash of body to request

struct UnixEpochDateCoder

Unix Epoch Date coder

typealias AWSMiddlewareNextHandler = (AWSHTTPRequest, AWSMiddlewareContext) async throws -> AWSHTTPResponse

Function to call next middleware in the chain

typealias CRC32 = UInt32

typealias EC2StandardArrayCoder<Element> = EC2ArrayCoder<StandardArrayCoderProperties, Element>

Standard EC2 Array Coder with element name “member”

typealias StandardArrayCoder<Element> = ArrayCoder<StandardArrayCoderProperties, Element>

typealias StandardDictionaryCoder<Key, Value> = DictionaryCoder<StandardDictionaryCoderProperties, Key, Value> where Key : Decodable, Key : Encodable, Key : Hashable

import CSotoExpat

import INIParser

import SotoSignerV4

import SotoTestUtils

import SotoXML

Module information