All Classes and Interfaces

Class
Description
Extension of SdkClientException that is thrown whenever an operation has been aborted by the SDK.
 
 
 
 
Represents UserAgent additional metadata following the format: md/[name]#[value]
 
 
 
Deprecated.
this class is deprecated and will not be updated.
 
Interface to configure a request execution and execute the request.
 
Interface to configure a request execution and execute the request.
Composite RetryCondition that evaluates to true when all contained retry conditions evaluate to true.
Wrapper pipeline that initializes and tracks the API call attempt metric collection.
Signals that an api call attempt could not complete within the specified timeout.
 
 
Wrapper around a RequestPipeline to manage the api call attempt timeout feature.
Wrapper pipeline that tracks the CoreMetric.API_CALL_DURATION metric.
Signals that an api call could not complete within the specified timeout.
 
 
Api Call Timeout Tracker to track the TimeoutTask and the ScheduledFuture.
Wrapper around a RequestPipeline to manage the api call timeout feature.
Encapsulates the API name and version of a library built using the AWS SDK.
 
 
Generates a unique identifier for the request that is consistent across retries.
A stage for adding the user agent header to the request, after retrieving the current string from execution attributes and adding any additional information.
Async response handler decorator to run interceptors after response is received.
Wrapper pipeline that initializes and tracks the API call attempt metric collection.
Wrapper pipeline that tracks the CoreMetric.API_CALL_DURATION metric.
 
 
Client interface to invoke an API.
 
Interface to deal with async paginated responses.
Interface to allow non-blocking streaming of request content.
 
Configuration options for AsyncRequestBody.fromInputStream(AsyncRequestBodyFromInputStreamConfiguration) to configure how the SDK should create an AsyncRequestBody from an InputStream.
 
Listener interface that invokes callbacks associated with a AsyncRequestBody and any resulting Subscriber.
 
Deprecated.
Replaced by software.amazon.awssdk.http.auth.spi.signer.HttpSigner in 'http-auth-spi'.
 
Response handler for asynchronous non-streaming operations.
Callback interface to handle a streaming asynchronous response.
Helper interface containing the result of splitting an AsyncResponseTransformer.
 
 
Listener interface that invokes callbacks associated with a AsyncResponseTransformer and any resulting SdkPublisher and Subscriber.
 
 
Wrapper around the pipeline for a single request to provide retry, clockskew and request throttling functionality.
Deprecated.
Replaced by software.amazon.awssdk.http.auth.spi.signer.HttpSigner in 'http-auth-spi'.
 
Augments a Marshaller to add contents for an async streamed request.
Builder class to build AsyncStreamingRequestMarshaller object.
Response handler for asynchronous streaming operations.
 
Implementation of TimeoutTask for asynchronous operations to be scheduled to fail the CompletableFuture and abort the asynchronous requests.
Waiter utility class that waits for a resource to transition to the desired state asynchronously
The Waiter Builder
Executes async waiter operations
Decorate HttpResponseHandler to attach SdkHttpResponse to the response object.
 
 
A wrapper of InputStream that implements pseudo-chunked-encoding.
 
A wrapper of InputStream that implements streaming in chunks.
A wrapper class of InputStream that implements compression in chunks.
 
A wrapper class of InputStream that implements chunked-encoding.
 
Deprecated.
Use instead BackoffStrategy
 
 
 
 
An implementation of AsyncRequestBody that allows performing a blocking write of an input stream to a downstream service.
 
An implementation of AsyncRequestBody that allows performing a blocking write of an output stream to a downstream service.
 
Represents a Boolean Document.
An AsyncRequestBody decorator that enables splitting into retryable sub-request bodies.
ContentStreamProvider implementation that buffers the data stream data to memory as it's read.
 
An enum class representing a short form of identity providers to record in the UA string.
 
Implementation of AsyncResponseTransformer that dumps content into a byte array and supports further conversions into types, like strings.
A splitting transformer that creates individual ByteArrayAsyncResponseTransformer instances for each part of a multipart download.
An implementation of AsyncRequestBody for providing data from the supplied ByteBuffer array.
 
Publisher that tracks how many bytes are published from the wrapped publisher to the downstream subscriber.
A base class for SdkBytes and ResponseBytes that enables retrieving an underlying byte array as multiple different types, like a byte buffer (via BytesWrapper.asByteBuffer(), or a string (via BytesWrapper.asUtf8String().
An input stream that tracks the number of bytes read from it.
Publisher that tracks how many bytes are published from the wrapped publisher to the downstream subscriber, along with timing information for throughput calculation.
Manages capacity of a finite resource.
Wrapper class to wrap an AsyncRequestBody to calculate checksum as it reads data and append Checksum as trailer at the end.
 
 
Defines all the Specifications that are required while adding HttpChecksum to a request and validating HttpChecksum of a response.
 
Stream that will update the Checksum as the data is read.
Publisher to update the checksum as it reads the data and finally compares the computed checksum with expected Checksum.
Enum to indicate the checksum validation is performed on a Response that supports Http Checksum Validation.
Class that will buffer incoming BufferBytes to chunks of bufferSize.
 
 
Implementation notes: this class should've been outside internal package, but we can't fix it due to backwards compatibility reasons.
Factory for creating request/response handler chains from the classpath.
Async configuration values for which the client already provides sensible defaults.
Configure and create a ClientAsyncConfiguration.
Client endpoint providers are responsible for resolving client-level endpoints.
Encapsulates parameters needed for a particular API call.
An option in a SdkClientConfiguration.
Configuration values for which the client already provides sensible defaults.
Enum that represents the type of client being used.
Utility methods for checking and reacting to the current client-side clock being different from the service-side clock.
Suggests a clock skew adjustment that should be applied to future requests.
An extension of AsyncRequestBody that is closable.
Detects whether the response succeeded or failed by just checking the HTTP status and delegates to appropriate async response handler.
Unmarshalls an HTTP response into either a successful response POJO, or into a (possibly modeled) exception based on the status code of the HTTP response.
Wrapper class to wrap an AsyncRequestBody.
 
Configuration options for operations with the RequestCompression trait to disable request configuration and set the minimum compression threshold in bytes.
 
ContentStreamProvider implementation for compression.
Interface for compressors used by CompressRequestStage to compress requests.
The supported compression algorithms for operations with the requestCompression trait.
Compress requests whose operations are marked with the "requestCompression" C2J trait.
A wrapper for the immutable context objects that are visible to the ExecutionInterceptors.
All information that is known about a particular execution that has failed.
 
Deprecated.
this class is deprecated and subject to removal.
Deprecated.
this class is deprecated and subject to removal.
Simple InputStream wrapper that examines the wrapped stream's contents as they are read and calculates and CRC32 checksum.
Wraps the provided input stream with a Crc32ChecksumCalculatingInputStream and after the stream is closed will validate the calculated checksum against the actual checksum.
Extension of SdkClientException that is thrown whenever the client-side computed CRC32 does not match the server-side computed CRC32.
 
 
Validate and decompress input data if necessary.
Class that identifies the type of credentials typically used by the service to authorize an api request.
 
 
 
Default implementation of the generic AsyncWaiter.
 
 
An SDK-internal implementation of Context.FailedExecution.
 
Utility to load the default HTTP client factory and create an instance of SdkHttpClient.
Default implementation of SdkAutoConstructList.
Default implementation of SdkAutoConstructMap.
Utility to load the default HTTP client factory and create an instance of SdkHttpClient.
Common system level user agent properties that can either be accessed as a string or as individual values.
 
 
Trait that supplies a default value when none is present for a given field.
Default implementation of the generic Waiter.
 
The default implementation of the WaiterResponse
 
Interface for Document Types.
 
 
Document visitor interface.
Requests elements from a subscriber until the subscription is completed.
Subscription which can emit Subscriber#onNext(T) signals to a subscriber, based on the demand received with the Subscription.request(long).
 
 
A NoOp implementation of Subscription interface.
 
 
 
This exception is thrown when the SDK was unable to retrieve an endpoint from AWS.
 
 
 
 
 
 
Builder interface for constructing a EndpointDiscoveryRequest.
Publisher implementation that wraps the content of another publisher in an envelope with an optional prefix (or header) and suffix (or footer).
 
 
An attribute attached to a particular execution, stored in ExecutionAttributes.
 
 
A mutable collection of ExecutionAttributes that can be modified by ExecutionInterceptors in order to save and retrieve information specific to the current execution.
 
Warning: This class should only be accessed by a single thread and be used throughout a single request lifecycle.
 
 
An interceptor that is invoked during the execution lifecycle of a request/response (execution).
A wrapper for a list of ExecutionInterceptors that ensures the interceptors are executed in the correct order as it is documented in the ExecutionInterceptor documentation.
Used for simulating an IOException for test purposes.
Implementation of AsyncRequestBody that reads data from a file.
A builder for FileAsyncRequestBody.
A helper class to split a FileAsyncRequestBody to multiple smaller async request bodies.
AsyncResponseTransformer that writes the data to the specified file.
A publisher of FileAsyncResponseTransformer that uses the Content-Range header of a SdkResponse to write to the offset defined in the range of the Content-Range.
ContentStreamProvider implementation for files.
Configuration options for AsyncRequestBody.fromFile(FileRequestBodyConfiguration) to configure how the SDK should read the file.
 
Configuration options for AsyncResponseTransformer.toFile(Path, FileTransformerConfiguration) to configure how the SDK should write the file and if the SDK should delete the file when an exception occurs.
 
Defines how the SDK should handle the file if there is an exception
Defines how the SDK should write the file
Decorator class that simply delegates to the wrapped TransformingAsyncResponseHandler.
 
 
Pipeline stage that executes an HttpResponseHandler to transform the response into a Response object that contains a flag indicating success of failure and an unmarshalled response object or exception as appropriate.
 
 
Defines all the constants that are used while adding and validating Http checksum for an operation.
 
Class to resolve the different Checksums specs from ExecutionAttributes.
Stage to implement the "httpChecksum" and "httpChecksumRequired" C2J traits, and flexible checksums.
 
Interceptor to intercepts Sync and Async responses.
Client scoped dependencies of AmazonSyncHttpClient and AmazonAsyncHttpClient.
Responsible for handling an HTTP response and returning an object of type T.
Wrapper for a TransformingAsyncResponseHandler that allows attachment to an external scope and given a way of evaluating whether that scope has changed or not will only allow prepare() to be called on its delegate once per state change and will cache and reserve the future that is returned by the delegate the rest of the time.
Utility class to manage idempotency token
A enum class representing a short form of identity providers to record in the UA string.
A AsyncResponseTransformer that allows performing blocking reads on the response data.
A AsyncRequestBody that allows reading data off of an InputStream using a background ExecutorService.
An SDK-internal implementation of Context.AfterExecution and its parent interfaces.
 
Attributes that can be applied to all sdk requests.
A set of utilities for monitoring the status of the currently-executing SDK thread.
An implementation of the Subscription interface that can be used to signal and cancel demand for paginated items across pages
 
Trait that indicates a String member is a JSON document.
A delegating checksum class to delegate to new checksum implementation for legacy checksum implementations
 
 
Internal List Builder for easy construction of Document Lists.
Trait that includes additional metadata about List members.
 
Trait to include metadata about the marshalling/unmarshalling location (i.e.
Builder for LocationTrait.
Delegate to the HTTP implementation to make an HTTP request and receive the response.
Delegate to the HTTP implementation to make an HTTP request and receive the response.
 
 
 
 
Trait that includes additional metadata for Map members.
 
Interface to marshall a POJO into a SdkHttpFullRequest.
Enum of known types of marshalling types.
Represents the various types supported for marshalling.
Enum representing the various locations data can be marshalled to.
Resolves the retry max attempts from SdkSystemSetting.AWS_MAX_ATTEMPTS and ProfileProperty.MAX_ATTEMPTS.
Simple retry condition that allows retries up to a certain max number of retries.
Deprecated.
this class is deprecated and subject to removal.
Merge customer supplied headers into the marshalled request.
Merge customer supplied query params into the marshalled request.
An implementation of HttpResponseHandler that publishes the time it took to execute {
Utility methods for working with metrics.
Utility class that maintains a listing of known Mimetypes, and determines the mimetype of files based on file extensions.
Pipeline stage that takes in a mutable SdkHttpFullRequest.Builder and returns the same builder.
Resolver for the SdkSystemSetting.AWS_NEW_RETRIES_2026 that supports setting a fallback value if not defined in the environment or system properties.
 
Extension of SdkException that can be used by clients to explicitly have an exception not retried.
 
 
A SubAsyncRequestBody implementation that doesn't support resubscribe/retry
 
Deprecated.
Replaced by software.amazon.awssdk.http.auth.spi.signer.HttpSigner#doNotSign() in 'http-auth-spi'.
An implementation of Subscription that does nothing.
A no op implementation of TimeoutTracker.
 
 
Composite retry condition that evaluates to true if any containing condition evaluates to true.
Iterable for the paginated items.
 
Deprecated.
 
Iterator for all response pages in a paginated operation.
 
 
 
 
 
Trait that indicates a member is the 'payload' member.
Deprecated.
Replaced by software.amazon.awssdk.http.auth.spi.signer.HttpSigner in 'http-auth-spi'.
 
Represents the communication protocol to use when sending requests to AWS.
Listener interface that invokes callbacks associated with a Publisher and any resulting Subscriber.
 
 
Modifies an HTTP request by moving query parameters to the body under the following conditions: - It is a POST request - There is no content stream provider - There are query parameters to transfer
 
 
Used for releasing a resource.
An input stream that can have the close operation disabled (to avoid accidentally being closed).
Represents the body of an HTTP request.
Container for request body metrics used to calculate WRITE_THROUGHPUT.
Enum class for request checksum calculation setting.
Allows customizing the variables used during determination of a RequestChecksumCalculation.
Implementation notes: this class should've been outside internal package, but we can't fix it due to backwards compatibility reasons.
 
Request scoped dependencies and context for an execution of a request by AmazonSyncHttpClient or AmazonAsyncHttpClient.
An SDK-internal implementation of RequestExecutionContext.Builder.
Client option defaults for individual SdkRequests.
Base per-request override configuration for all SDK requests.
 
 
Represents a series of transformations when executing a SDK request.
Builder for a RequestPipeline.
Pipeline stage that is a transformation on an immutable SdkHttpFullRequest.
 
Trait that indicates a value must be provided for a member.
A mark-and-resettable input stream that can be used on files or file input streams.
Response wrapper that indicates success or failure with the associated unmarshalled response object or exception object.
 
An in-memory representation of the service's response from a streaming operation.
Enum class for response checksum validation setting.
Allows customizing the variables used during determination of a ResponseChecksumValidation.
Input stream that provides access to the unmarshalled POJO response returned by the service in addition to the streamed contents.
Represents a value that can be either a response or a Throwable
An SdkPublisher that publishes response body content and also contains a reference to the SdkResponse returned by the service.
An implementation of the Subscription interface that can be used to signal and cancel demand for paginated response pages.
 
Interface for processing a streaming response from a service in a synchronous fashion.
 
Extension of SdkException that can be used by clients to explicitly have an exception retried.
 
 
Wrapper around the pipeline for a single request to provide retry, clock-skew and request throttling functionality.
Contains the logic shared by RetryableStage and AsyncRetryableStage when querying and interacting with a RetryStrategy.
A SubAsyncRequestBody implementation that supports resubscribe/retry once all data has been published to the first subscriber
A retry mode is a collection of retry behaviors encoded under a single value.
Allows customizing the variables used during determination of a RetryMode.
A RetryCondition that will return true if the provided exception seems to be due to a clock skew between the client and service.
Retry condition implementation that retries if the exception or the cause of the exception matches the classes defined.
Retry condition implementation that retries if the HTTP status code matches one of the provided status codes.
A RetryCondition that will return true if the provided exception seems to be due to a throttling error from the service to the client.
Deprecated.
Use instead RetryStrategy.
 
Implements the RetryStrategy interface by wrapping a RetryPolicy instance.
 
Contains useful information about a failed request that can be used to make retry and backoff decisions.
 
 
A collection of advanced options that can be configured on an async AWS client via ClientAsyncConfiguration.Builder.advancedOption(SdkAdvancedAsyncClientOption, Object).
A collection of advanced options that can be configured on an AWS client via ClientOverrideConfiguration.Builder.putAdvancedOption(SdkAdvancedClientOption, Object).
This includes required and optional override configuration required by every async client builder.
Default implementation of AsyncClientHandler.
A list that was auto constructed by the SDK.
A map that was auto constructed by the SDK.
An in-memory representation of data being given to a service or being returned by a service.
Deprecated.
this class is deprecated and will not be updated.
All SDK service client interfaces should extend this interface.
This includes required and optional override configuration required by every client builder.
A collection of configuration that is required by an AWS client in order to operate.
 
Base type for all client exceptions thrown by the SDK.
 
 
A set of internal options required by the SDK via SdkClientConfiguration.
A set of static methods used to validate that a SdkClientConfiguration contains all of the values required for the SDK to function.
Used for clock skew adjustment between the client JVM where the SDK is run, and the server side.
Represents AWS SDK user agent client values.
An SDK-internal implementation of the methods in SdkClientBuilder, SdkAsyncClientBuilder and SdkSyncClientBuilder.
Wrapper around SdkAsyncHttpClient to prevent it from being closed.
Wrapper around SdkHttpClient to prevent it from being closed.
 
 
 
Retry strategies used by any SDK client.
 
 
Base class for AWS Java SDK specific DigestInputStream.
General categories of errors that can be encountered when making an API call attempt.
Base class for SDK-specific exceptions.
 
 
Contains attributes attached to the execution.
Metadata about a member in an SdkPojo.
Builder for SdkField.
Base class for AWS Java SDK specific FilterInputStream.
Used for clock skew adjustment between the client JVM where the SDK is run, and the server side.
 
Base class for AWS Java SDK specific InputStream.
Attributes that can be applied to all sdk requests.
Options of SdkAdvancedClientOption that must not be used outside of tests that are stored in this project.
 
A custom iterable used in paginated responses.
An in-memory representation of Number being given to a service or being returned by a service.
A plugin that modifies SDK client configuration at client creation time or per-request execution time.
Interface to provide the list of SdkFields in a POJO.
A builder for an immutable SdkPojo with no fields.
Interface to hold protocol-specific information.
Interface that is implemented by the Async auto-paginated responses.
Common implementations of SdkPublisher that are provided for convenience when building asynchronous interceptors to be used with specific clients.
The base class for all SDK requests.
 
Base per-request override configuration for all SDK requests.
 
The base class for all SDK responses.
 
 
Contains predefined RetryCondition provided by SDK.
Class to expose SDK service client settings to the user, e.g., ClientOverrideConfiguration
The base interface for all SDK service client configuration builders
Extension of SdkException that represents an error response returned by the requested downstream service.
 
 
A centralized set of loggers that used across the SDK to log particular types of events.
This includes required and optional override configuration required by every sync client builder.
Client handler for SDK clients.
System properties to configure the SDK runtime.
Deprecated.
Responsible for building user agent strings for different use cases.
A container for the identity resolver, signer and auth option that we selected for use with this service call attempt.
 
Deprecated.
this class is deprecated and subject to removal.
Deprecated.
this class is deprecated and subject to removal.
Deprecated.
Replaced by software.amazon.awssdk.http.auth.spi.signer.HttpSigner in 'http-auth-spi'.
 
Sign the marshalled request (if applicable).
Implementation of SdkHttpContentPublisher that provides all it's data at once.
Splits an AsyncRequestBody to multiple smaller AsyncRequestBodys, each of which publishes a specific portion of the original data.
 
Split a AsyncResponseTransformer into multiple ones, publishing them as a SdkPublisher.
 
Configuration options for AsyncResponseTransformer.split(SplittingTransformerConfiguration) to configure how the SDK should split the AsyncResponseTransformer.
 
Used in combination with the generated member copiers to implement deep copies of shape members.
An implementation of ClientEndpointProvider that uses static values.
Augments a Marshaller to add contents for a streamed request.
Builder class to build StreamingRequestMarshaller object.
Adds additional wrapping around the request ContentStreamProvider.
 
Represent a sub AsyncRequestBody that publishes a portion of the source AsyncRequestBody
Configuration class containing shared properties for SubAsyncRequestBody implementations.
 
Listener interface that invokes callbacks associated with a Subscriber.
 
Client interface to invoke an API.
 
TimeoutTask to be scheduled for synchronous operations.
EndpointDiscoveryProvider implementation that loads endpoint discovery from the AWS_ENABLE_ENDPOINT_DISCOVERY system property or environment variable.
Common system level user agent properties that can either be accessed as a string or as individual values.
Utility for use with errors or exceptions.
Check if an Exception is caused by either ApiCallTimeout or ApiAttemptTimeout and translate that exception to a more appropriate timeout related exception so that it can be handled in other stages.
 
Tracker task to track the TimeoutTask and the ScheduledFuture that schedules the timeout task.
 
Trait that indicates a different format should be used for marshalling/unmarshalling timestamps.
Enum of the timestamp formats we currently support.
A lock-free implementation of a token bucket.
A function used by TokenBucketRetryCondition to determine how many tokens should be removed from the bucket when an exception is encountered.
A helper that can be used to assign exception costs to specific exception types, created via TokenBucketExceptionCostFunction.builder().
A RetryCondition that limits the number of retries made by the SDK using a token bucket algorithm.
Configure and create a TokenBucketRetryCondition.
The number of tokens in the token bucket after a specific token acquisition succeeds.
 
Marker interface for traits that contain additional metadata about SdkFields.
Enumerates all the know traits.
A response handler that returns a transformed response.
Adapter interface to convert one type to another
A utilities class used by generated clients to easily convert between nested types, such as lists and maps.
An internal class used solely for the purpose of testing via failure injection.
Unwrap a Response container to just the POJO result.
 
 
 
Document visitor interface with no return type.
Dummy implementation of SdkResponse.
 
Waiter utility class that waits for a resource to transition to the desired state.
The Waiter Builder
Inspects the response or errors returned from the operation and determines whether an expected state is met and returns the next WaiterState that the waiter should be transitioned to.
Key for additional attribute used in waiter classes
 
Internal waiter configuration class that provides default values if not overridden.
Executes sync waiter operations
The waiter executor helper class.
Configuration values for the Waiter.
 
The response returned from a waiter operation
 
Trait to include the xml attributes such as "xmlns:xsi" or "xsi:type".
 
 
Trait to indicate this is an Xml attribute.