aws_common library

Common types and utilities used across AWS and Amplify packages.

Classes

AWSBaseHttpClient
An AWSHttpClient which supports modifying requests before sending and, optionally, modifying responses before being returned from send.
AWSBaseHttpRequest
A parameterized HTTP request.
AWSBaseHttpResponse
A parameterized HTTP response.
AWSCredentials
A set of credentials used for accessing AWS services.
AWSCredentialsProvider
A utility for retrieving AWS credentials at runtime.
AWSCredentialsProviderChain
Attempts to load AWS credentials from a chain of credentials providers, in order.
AWSCustomHttpClient
Base class for all implementations of AWSHttpClient.
AWSErrorResult<V extends Object?, E extends Exception>
A failed AWSResult.
AWSFile
A cross-platform abstraction over a read-only file.
AWSHeaders
Headers used in AWS requests.
AWSHttpClient
An HTTP client with support for HTTP/1.1, HTTP/2, and cancelable requests.
AWSHttpOperation<ResponseType extends AWSBaseHttpResponse>
A wrapper over a CancelableOperation with progress monitoring support for in-flight HTTP requests sent with an AWSHttpClient.
AWSHttpRequest
A parameterized HTTP request.
AWSHttpResponse
A parameterized HTTP response.
AWSLogger
A logging utility providing the ability to emit log entries, configure the level at which entries are emitted, and register plugins which can handle log entries as they're emitted.
AWSLoggerPlugin
A plugin to an AWSLogger which handles log entries emitted at the LogLevel of the logger instance.
AWSOperation<T extends Object?>
A wrapper over a CancelableOperation.
AWSProfile
A collection of AWS configuration properties.
AWSProfileBuilder
AWSProfileFile
A collection of AWS configuration profiles.
AWSProfileFileBuilder
AWSProperty
A property from an AWS configuration profile.
AWSPropertyBuilder
AWSResult<V extends Object?, E extends Exception>
The result of an operation that may throw an exception.
AWSService
The enumeration of AWS services.
AWSStreamedHttpRequest
A streaming HTTP request.
AWSStreamedHttpResponse
A streaming HTTP response.
AWSSuccessResult<V extends Object?, E extends Exception>
A successful AWSResult.
Cancelable
An operation which can be canceled while pending or in progress.
CancelableCompleter<T>
A completer for a CancelableOperation.
CancelableOperation<T>
An asynchronous operation that can be cancelled.
CaseInsensitiveMap<V>
Creates a case-insensitive Map using equalsIgnoreAsciiCase and hashIgnoreAsciiCase for comparison.
CaseInsensitiveSet
Creates a case-insensitive Set using equalsIgnoreAsciiCase and hashIgnoreAsciiCase for comparison.
Closeable
Interface for objects which need cleanup before GC, usually to prevent memory leaks.
DartEnvironmentCredentialsProvider
Creates an AWSCredentialsProvider for credentials injected via the Dart environment.
DefaultCredentialsProviderChain
Uses the default chain to try loading credentials from the following sources, in order:
EnvironmentCredentialsProvider
Creates an AWSCredentialsProvider for credentials injected via the platform-specific environment.
HttpPayload
An HTTP request's payload.
LogEntry
A discrete log event emitted by an AWSLogger.
ProfileCredentialsProvider
Creates an AWSCredentialsProvider for credentials from an AWS shared credentials file.
SimpleLogPrinter
An AWSLoggerPlugin which prints log messages to the console when running in debug mode.
StaticCredentialsProvider
Creates an AWSCredentialsProvider for a set of static, compile-time AWS credentials.
StoppableTimer
A Timer that can be stopped and started again.
X509Certificate
X509Certificate represents an SSL certificate, with accessors to get the fields of the certificate.

Enums

AlpnProtocol
TLS Application-Layer Protocol Negotiation Protocol IDs.
AWSConfigValue<T extends Object>
A configuration value for use with AWS packages.
AWSHttpMethod
Valid HTTP methods for AWS requests.
LogLevel
The different levels of logging.
SupportedProtocols
Protocols supported by an AWSHttpClient.

Mixins

AWSDebuggable
An object whose properties can be introspected and thus, printed safely to the console.
AWSEquatable<T extends AWSEquatable<T>>
Mixin class to provide equatable functionality on objects.
AWSLoggerMixin
Mixin providing an AWSLogger to AWS classes.
AWSProgressOperation<T>
A mixin to AWSOperation which adds progress monitoring.
AWSSerializable<T extends Object?>
A mixin to provide toJson functionality to objects.

Extensions

StreamForward on Stream<T>
Helper for forwarding events of one Stream to another.
StringRecase on String
Re-casing helpers for strings.

Constants

zAccessKeyId → const String
The AWS_ACCESS_KEY_ID identifier, used for locating credentials in the environment.
zDebugMode → const bool
Whether running in debug mode.
zDefaultLogLevel → const LogLevel
The default log level used by AWSLogger.
zIsFlutter → const bool
Whether running in Flutter (as opposed to Dart-only).
zIsWeb → const bool
Whether running on the Web.
zProfileMode → const bool
Whether running in profile mode.
zReleaseMode → const bool
Whether running in release mode.
zSecretAccessKey → const String
The AWS_SECRET_ACCESS_KEY identifier, used for locating credentials in the environment.
zSessionToken → const String
The AWS_SESSION_TOKEN identifier, used for locating credentials in the environment.

Properties

zAssertsEnabled → bool
Whether asserts are enabled.
final

Functions

prettyPrintJson(Object? json) → String
Encodes json with indentation for easier debugging.
safePrint(Object? o) → void
Prints o in debug-mode only.
uuid({bool secure = false}) → String
Generates a UUID (v4).

Typedefs

BadCertificateCallback = bool Function(X509Certificate, String host, int port)
Callback for VM clients when an SSL handshake fails due to an untrusted certificate chain.

Exceptions / Errors

AWSHttpException
Exception thrown when an error occurs during an AWSHttpOperation.
CancellationException
Exception thrown when an operation is cancelled before completion.
InvalidCredentialsException
Exception thrown when AWS credentials are either unavailable or invalid.
InvalidFileException
The file created from AWSFile is not readable.