Instance Methodsoto-core 7.4.0SotoCore
getCredential(logger:)
Get credential used by client
func getCredential(logger: Logger = AWSClient.loggingDisabled) async throws -> Credential Parameters
- logger
optional logger to use
Returns
Credential
Get credential used by client
func getCredential(logger: Logger = AWSClient.loggingDisabled) async throws -> Credential s8SotoCore9AWSClientC13getCredential6logger0A8SignerV40E0_p7Logging6LoggerV_tYaKF What are these?9JQZLoptional logger to use
Credential
import SotoCorefinal class AWSClientClient managing communication with AWS services
struct LoggerA Logger is the central type in SwiftLog. Its central function is to emit log messages using one of the methods corresponding to a log level.
protocol Credential : SendableProtocol for providing credential details for accessing AWS services
init(credentialProvider credentialProviderFactory: CredentialProviderFactory = .default, retryPolicy retryPolicyFactory: RetryPolicyFactory = .default, middleware: some AWSMiddlewareProtocol, options: Options = Options(), httpClient: AWSHTTPClient = HTTPClient.shared, logger: Logger = AWSClient.loggingDisabled) Initialize an AWSClient struct
init(credentialProvider credentialProviderFactory: CredentialProviderFactory = .default, retryPolicy retryPolicyFactory: RetryPolicyFactory = .default, options: Options = Options(), httpClient: AWSHTTPClient = HTTPClient.shared, logger: Logger = AWSClient.loggingDisabled) Initialize an AWSClient struct
static let loggingDisabled: LoggerDefault logger that logs nothing
let credentialProvider: CredentialProviderAWS credentials provider
let httpClient: AWSHTTPClientHTTP client used by AWSClient
let logger: LoggerLogger used for non-request based output
let middleware: AWSMiddlewareProtocolMiddleware code to be applied to requests and responses
func execute<Output>(operation operationName: String, path: String, httpMethod: HTTPMethod, serviceConfig: AWSServiceConfig, input: some AWSEncodableShape, hostPrefix: String? = nil, logger: Logger = AWSClient.loggingDisabled) async throws -> Output where Output : AWSDecodableShape Execute a request with an input object and return the output object generated from the response
func execute(operation operationName: String, path: String, httpMethod: HTTPMethod, serviceConfig: AWSServiceConfig, input: some AWSEncodableShape, hostPrefix: String? = nil, logger: Logger = AWSClient.loggingDisabled) async throws Execute a request with an input object and an empty response
func execute<Output>(operation operationName: String, path: String, httpMethod: HTTPMethod, serviceConfig: AWSServiceConfig, logger: Logger = AWSClient.loggingDisabled) async throws -> Output where Output : AWSDecodableShape Execute an empty request and return the output object generated from the response
func execute(operation operationName: String, path: String, httpMethod: HTTPMethod, serviceConfig: AWSServiceConfig, logger: Logger = AWSClient.loggingDisabled) async throws Execute an empty request and an empty response
func shutdown() async throws Shutdown AWSClient asynchronously.
func signHeaders(url: URL, httpMethod: HTTPMethod, headers: HTTPHeaders = HTTPHeaders(), body: AWSHTTPBody, serviceConfig: AWSServiceConfig, logger: Logger = AWSClient.loggingDisabled) async throws -> HTTPHeaders Generate signed headers
func signURL(url: URL, httpMethod: HTTPMethod, headers: HTTPHeaders = HTTPHeaders(), expires: TimeAmount, serviceConfig: AWSServiceConfig, logger: Logger = AWSClient.loggingDisabled) async throws -> URL Generate a signed URL
func syncShutdown() throws Shutdown client synchronously.
func waitUntil<Input, Output>(_ input: Input, waiter: Waiter<Input, Output>, maxWaitTime: TimeAmount? = nil, logger: Logger = AWSClient.loggingDisabled) async throws where Input : Sendable, Output : Sendable Returns when waiter polling returns a success state or returns an error if the polling returns an error or timesout
struct ClientErrorErrors returned by AWSClient code
struct OptionsAdditional options
struct PaginatorSequence<Input, Output> where Input : AWSPaginateToken, Output : AWSShape, Input.Token : EquatableUsed to access paginated results.
struct Waiter<Input, Output> where Input : Sendable, Output : SendableA waiter is a client side abstraction used to poll a resource until a desired state is reached
enum WaiterStateWaiter state