| Modifier and Type | Class and Description |
|---|---|
class |
Arn
The Arns generated and recognized by this code are the Arns described here:
https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
class |
ArnResource
An additional model within
Arn that provides the Resource Type, Resource, and
Resource Qualifier of an AWS Arn when those values are present and correctly formatted
within an Arn. |
| Modifier and Type | Class and Description |
|---|---|
class |
AnonymousCredentialsProvider
Credentials provider that always returns anonymous
AwsCredentials. |
class |
AwsBasicCredentials
Provides access to the AWS credentials used for accessing services: AWS access key ID and secret access key.
|
interface |
AwsCredentials
Provides access to the AWS credentials used for accessing services: AWS access key ID and secret access key.
|
interface |
AwsCredentialsProvider
Interface for loading
AwsCredentials that are used for authentication. |
class |
AwsCredentialsProviderChain
AwsCredentialsProvider implementation that chains together multiple credentials providers. |
class |
AwsSessionCredentials
A special type of
AwsCredentials that provides a session token to be used in service authentication. |
class |
EnvironmentVariableCredentialsProvider
AwsCredentialsProvider implementation that loads credentials from the AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and
AWS_SESSION_TOKEN environment variables. |
interface |
HttpCredentialsProvider
A base for many credential providers within the SDK that rely on calling a remote HTTP endpoint to refresh credentials.
|
class |
ProcessCredentialsProvider
A credentials provider that can load credentials from an external process.
|
class |
ProfileCredentialsProvider
Credentials provider based on AWS configuration profiles.
|
class |
StaticCredentialsProvider
An implementation of
AwsCredentialsProvider that returns a set implementation of AwsCredentials. |
class |
SystemPropertyCredentialsProvider
AwsCredentialsProvider implementation that loads credentials from the aws.accessKeyId, aws.secretAccessKey and
aws.sessionToken system properties. |
class |
WebIdentityTokenFileCredentialsProvider
A credential provider that will read web identity token file path, aws role arn and aws session name from system properties or
environment variables for using web identity token credentials with STS.
|
| Modifier and Type | Class and Description |
|---|---|
class |
Aws4Signer
Deprecated.
Use
com.ibm.cos.v2.http.auth.aws.signer.AwsV4HttpSigner from the 'http-auth-aws' module. |
class |
Aws4UnsignedPayloadSigner |
class |
AwsS3V4Signer
Deprecated.
Use
com.ibm.cos.v2.http.auth.aws.signer.AwsV4HttpSigner from the 'http-auth-aws' module. |
| Modifier and Type | Class and Description |
|---|---|
class |
Aws4PresignerParams |
class |
Aws4SignerParams
Parameters that are used during signing.
|
class |
AwsS3V4SignerParams |
class |
SignerChecksumParams
Deprecated.
this class is deprecated and will not be updated. Use
SignerProperty and
HttpSigner in 'http-auth-spi' instead. |
class |
TokenSignerParams
Parameters that are used during signing.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
SdkToken
Provides token which is used to securely authorize requests to services that use token based auth, e.g., OAuth.
|
interface |
SdkTokenProvider
Interface for loading
SdkToken that are used for authentication. |
class |
StaticTokenProvider
An implementation of
SdkTokenProvider that returns a set implementation of SdkToken. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
AwsCrtS3V4aSigner
Deprecated.
Use
com.ibm.cos.v2.http.auth.aws.signer.AwsV4aHttpSigner from the 'http-auth-aws' module. |
interface |
AwsCrtV4aSigner
Deprecated.
Use
com.ibm.cos.v2.http.auth.aws.signer.AwsV4aHttpSigner from the 'http-auth-aws' module. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
AwsClient
Interface for an AWS Client that extends SdkClient.
|
class |
AwsExecutionAttribute
AWS-specific attributes attached to the execution.
|
class |
AwsRequest
Base class for all AWS Service requests.
|
class |
AwsRequestOverrideConfiguration
Request-specific configuration overrides for AWS service clients.
|
class |
AwsResponse
Base class for all AWS Service responses.
|
class |
AwsServiceClientConfiguration
Class to expose AWS service client settings to the user, e.g., region
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
AwsAsyncClientBuilder<B extends AwsAsyncClientBuilder<B,C>,C>
This includes required and optional override configuration required by every AWS async client builder.
|
interface |
AwsClientBuilder<BuilderT extends AwsClientBuilder<BuilderT,ClientT>,ClientT>
This includes required and optional override configuration required by every client builder.
|
interface |
AwsSyncClientBuilder<B extends AwsSyncClientBuilder<B,C>,C>
This includes required and optional override configuration required by every sync client builder.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AwsAdvancedClientOption<T>
A collection of advanced options that can be configured on an AWS client via
ClientOverrideConfiguration.Builder.putAdvancedOption(SdkAdvancedClientOption, Object). |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultsMode
A defaults mode determines how certain default configuration options are resolved in the SDK.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AccountIdEndpointMode
Enum Class for AccountId Endpoint Mode.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AwsErrorDetails |
class |
AwsServiceException
Extension of
SdkServiceException that represents an error response returned
by an Amazon web service. |
| Modifier and Type | Class and Description |
|---|---|
class |
PresignedRequest
The base class for all presigned requests.
|
static interface |
PresignedRequest.Builder |
class |
PresignRequest
The base class for all presign requests.
|
static interface |
PresignRequest.Builder
The base interface for all presign request builders.
|
interface |
SdkPresigner
The base interface for all SDK presigners.
|
static interface |
SdkPresigner.Builder
The base interface for all SDK presigner builders.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AwsRetryPolicy
Deprecated.
Use instead
AwsRetryStrategy |
class |
AwsRetryStrategy
Retry strategies used by clients when communicating with AWS services.
|
| Modifier and Type | Class and Description |
|---|---|
class |
RetryOnErrorCodeCondition
Retry condition implementation that retries if the exception or the cause of the exception matches the error codes defined.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ApiName
Encapsulates the API name and version of a library built using the AWS SDK.
|
class |
BytesWrapper
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(). |
class |
ClientType
Enum that represents the type of client being used.
|
class |
CompressionConfiguration
Configuration options for operations with the RequestCompression trait to disable request configuration and set the minimum
compression threshold in bytes.
|
class |
CredentialType
Class that identifies the type of credentials typically used by the service to authorize an api request.
|
class |
FileRequestBodyConfiguration
Configuration options for
AsyncRequestBody.fromFile(FileRequestBodyConfiguration) to configure how the SDK
should read the file. |
class |
FileTransformerConfiguration
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. |
class |
RequestOverrideConfiguration
Base per-request override configuration for all SDK requests.
|
class |
ResponseBytes<ResponseT>
An in-memory representation of the service's response from a streaming operation.
|
class |
ResponseInputStream<ResponseT>
Input stream that provides access to the unmarshalled POJO response returned by the service in addition to the streamed
contents.
|
class |
SdkBytes
An in-memory representation of data being given to a service or being returned by a service.
|
interface |
SdkClient
All SDK service client interfaces should extend this interface.
|
class |
SdkNumber
An in-memory representation of Number being given to a service or being returned by a service.
|
interface |
SdkPlugin
A plugin modifies a client's configuration when the client is created or at request execution
time.
|
class |
SdkRequest
The base class for all SDK requests.
|
class |
SdkRequestOverrideConfiguration
Base per-request override configuration for all SDK requests.
|
class |
SdkResponse
The base class for all SDK responses.
|
class |
SdkServiceClientConfiguration
Class to expose SDK service client settings to the user, e.g., ClientOverrideConfiguration
|
interface |
ServiceConfiguration |
class |
SplittingTransformerConfiguration
Configuration options for
AsyncResponseTransformer.split(SplittingTransformerConfiguration) to configure how the SDK
should split the AsyncResponseTransformer. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
AsyncRequestBody
Interface to allow non-blocking streaming of request content.
|
class |
AsyncRequestBodyFromInputStreamConfiguration
Configuration options for
AsyncRequestBody.fromInputStream(AsyncRequestBodyFromInputStreamConfiguration)
to configure how the SDK should create an AsyncRequestBody from an InputStream. |
class |
AsyncRequestBodySplitConfiguration
Configuration options for
AsyncRequestBody.split(com.ibm.cos.v2.core.async.AsyncRequestBodySplitConfiguration) to configure how the SDK
should split an SdkPublisher. |
interface |
AsyncResponseTransformer<ResponseT,ResultT>
Callback interface to handle a streaming asynchronous response.
|
class |
BlockingInputStreamAsyncRequestBody
An implementation of
AsyncRequestBody that allows performing a blocking write of an input stream to a downstream
service. |
class |
BlockingOutputStreamAsyncRequestBody
An implementation of
AsyncRequestBody that allows performing a blocking write of an output stream to a downstream
service. |
class |
ResponsePublisher<ResponseT extends SdkResponse>
An
SdkPublisher that publishes response body content and also contains a reference to the SdkResponse returned
by the service. |
interface |
SdkPublisher<T>
Interface that is implemented by the Async auto-paginated responses.
|
| Modifier and Type | Class and Description |
|---|---|
class |
Algorithm
Deprecated.
this class is deprecated and will not be updated.
|
class |
ChecksumValidation
Enum to indicate the checksum validation is performed on a Response that supports Http Checksum Validation.
|
class |
RequestChecksumCalculation
Enum class for request checksum calculation setting.
|
class |
ResponseChecksumValidation
Enum class for response checksum validation setting.
|
interface |
SdkChecksum
Deprecated.
this class is deprecated and will not be updated.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
SdkAsyncClientBuilder<B extends SdkAsyncClientBuilder<B,C>,C>
This includes required and optional override configuration required by every async client builder.
|
interface |
SdkClientBuilder<B extends SdkClientBuilder<B,C>,C>
This includes required and optional override configuration required by every client builder.
|
interface |
SdkSyncClientBuilder<B extends SdkSyncClientBuilder<B,C>,C>
This includes required and optional override configuration required by every sync client builder.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ClientAsyncConfiguration
Async configuration values for which the client already provides sensible defaults.
|
class |
ClientOverrideConfiguration
Configuration values for which the client already provides sensible defaults.
|
class |
SdkAdvancedAsyncClientOption<T>
A collection of advanced options that can be configured on an async AWS client via
ClientAsyncConfiguration.Builder.advancedOption(SdkAdvancedAsyncClientOption,
Object). |
class |
SdkAdvancedClientOption<T>
A collection of advanced options that can be configured on an AWS client via
ClientOverrideConfiguration.Builder.putAdvancedOption(SdkAdvancedClientOption, Object). |
| Modifier and Type | Interface and Description |
|---|---|
interface |
Document
Interface for Document Types.
|
interface |
DocumentVisitor<R>
Document visitor interface.
|
interface |
VoidDocumentVisitor
Document visitor interface with no return type.
|
| Modifier and Type | Class and Description |
|---|---|
class |
EndpointDiscoveryFailedException
This exception is thrown when the SDK was unable to retrieve an endpoint from AWS.
|
| Modifier and Type | Class and Description |
|---|---|
class |
SystemPropertiesEndpointDiscoveryProvider
EndpointDiscoveryProvider implementation that loads endpoint discovery from the AWS_ENABLE_ENDPOINT_DISCOVERY
system property or environment variable. |
| Modifier and Type | Class and Description |
|---|---|
class |
AbortedException
Extension of
SdkClientException that is thrown whenever an
operation has been aborted by the SDK. |
class |
ApiCallAttemptTimeoutException
Signals that an api call attempt could not complete within the specified timeout.
|
class |
ApiCallTimeoutException
Signals that an api call could not complete within the specified timeout.
|
class |
Crc32MismatchException
Extension of
SdkClientException that is thrown whenever the
client-side computed CRC32 does not match the server-side computed CRC32. |
class |
NonRetryableException
Extension of
SdkException that can be used by clients to
explicitly have an exception not retried. |
class |
RetryableException
Extension of
SdkException that can be used by clients to
explicitly have an exception retried. |
class |
SdkClientException
Base type for all client exceptions thrown by the SDK.
|
class |
SdkException
Base class for all exceptions thrown by the SDK.
|
class |
SdkInterruptedException |
class |
SdkServiceException
Extension of SdkException that represents an error response returned by
the requested downstream service.
|
| Modifier and Type | Class and Description |
|---|---|
class |
SdkIdentityProperty |
| Modifier and Type | Class and Description |
|---|---|
class |
SdkDefaultRetryStrategy
Retry strategies used by any SDK client.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ResponseOrException<R>
Represents a value that can be either a response or a Throwable
|
| Modifier and Type | Class and Description |
|---|---|
class |
CoreMetric |
| Modifier and Type | Interface and Description |
|---|---|
interface |
SdkIterable<T>
A custom iterable used in paginated responses.
|
| Modifier and Type | Class and Description |
|---|---|
class |
RetryMode
A retry mode is a collection of retry behaviors encoded under a single value.
|
class |
RetryPolicy
Deprecated.
Use instead
RetryStrategy. |
class |
RetryPolicyContext
Contains useful information about a failed request that can be used to make retry and backoff decisions.
|
static class |
RetryPolicyContext.Builder |
| Modifier and Type | Interface and Description |
|---|---|
interface |
BackoffStrategy
Deprecated.
Use instead
BackoffStrategy |
class |
EqualJitterBackoffStrategy
Deprecated.
|
class |
FixedDelayBackoffStrategy
Deprecated.
Use instead
BackoffStrategy and
BackoffStrategy.fixedDelay(Duration). |
class |
FullJitterBackoffStrategy
Deprecated.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AndRetryCondition
Composite
RetryCondition that evaluates to true when all contained retry conditions evaluate to true. |
class |
MaxNumberOfRetriesCondition
Simple retry condition that allows retries up to a certain max number of retries.
|
class |
OrRetryCondition
Composite retry condition that evaluates to true if any containing condition evaluates to true.
|
interface |
RetryCondition
Deprecated.
Use instead
RetryStrategy.Builder.retryOnException(Predicate). |
class |
RetryOnClockSkewCondition
A
RetryCondition that will return true if the provided exception seems to be due to a clock skew between the
client and service. |
class |
RetryOnExceptionsCondition
Retry condition implementation that retries if the exception or the cause of the exception matches the classes defined.
|
class |
RetryOnStatusCodeCondition
Retry condition implementation that retries if the HTTP status code matches one of the provided status codes.
|
class |
RetryOnThrottlingCondition
A
RetryCondition that will return true if the provided exception seems to be due to a throttling error from the
service to the client. |
interface |
TokenBucketExceptionCostFunction
A function used by
TokenBucketRetryCondition to determine how many tokens should be removed from the bucket when an
exception is encountered. |
class |
TokenBucketRetryCondition
A
RetryCondition that limits the number of retries made by the SDK using a token bucket algorithm. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
AsyncRequestBodySigner
Deprecated.
Replaced by
com.ibm.cos.v2.http.auth.spi.signer.HttpSigner in 'http-auth-spi'. |
interface |
AsyncSigner
Deprecated.
Replaced by
com.ibm.cos.v2.http.auth.spi.signer.HttpSigner in 'http-auth-spi'. |
class |
NoOpSigner
Deprecated.
Replaced by
com.ibm.cos.v2.http.auth.spi.signer.HttpSigner#doNotSign() in
'http-auth-spi'. |
interface |
Presigner
Deprecated.
Replaced by
com.ibm.cos.v2.http.auth.spi.signer.HttpSigner in 'http-auth-spi'. |
interface |
Signer
Deprecated.
Replaced by
com.ibm.cos.v2.http.auth.spi.signer.HttpSigner in 'http-auth-spi'. |
| Modifier and Type | Class and Description |
|---|---|
class |
RequestBody
Represents the body of an HTTP request.
|
interface |
ResponseTransformer<ResponseT,ReturnT>
Interface for processing a streaming response from a service in a synchronous fashion.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
AsyncWaiter<T>
Waiter utility class that waits for a resource to transition to the desired state asynchronously
|
interface |
Waiter<T>
Waiter utility class that waits for a resource to transition to the desired state.
|
interface |
WaiterAcceptor<T>
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. |
interface |
WaiterBuilder<T,B> |
class |
WaiterOverrideConfiguration
Configuration values for the
Waiter. |
interface |
WaiterResponse<T>
The response returned from a waiter operation
|
class |
WaiterState |
| Modifier and Type | Class and Description |
|---|---|
class |
CrtConnectionHealthConfiguration
The base class for CRT connection health configuration
|
class |
CrtProxyConfiguration
The base class for AWS CRT proxy configuration
|
| Modifier and Type | Class and Description |
|---|---|
class |
Endpoint
Represents an endpoint computed by an
EndpointProvider. |
class |
EndpointAttributeKey<T>
A key for adding and retrieving attributes from an
Endpoint in a typesafe manner. |
interface |
EndpointProvider
A marker interface for an endpoint provider.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
ContentStreamProvider
Provides the content stream of a request.
|
interface |
ExecutableHttpRequest
An HTTP request that can be invoked by
ExecutableHttpRequest.call(). |
class |
FileStoreTlsKeyManagersProvider
Implementation of
FileStoreTlsKeyManagersProvider that loads a the
key store from a file. |
class |
Http2Metric
Metrics collected by HTTP clients for HTTP/2 operations.
|
class |
HttpExecuteRequest
Request object containing the parameters necessary to make a synchronous HTTP request.
|
class |
HttpExecuteResponse |
class |
HttpMetric
Metrics collected by HTTP clients for HTTP/1 and HTTP/2 operations.
|
class |
ProtocolNegotiation
The protocol negotiation selection scheme used by the HTTP client to establish connections
|
class |
SdkCancellationException
Exception thrown when the response subscription is cancelled.
|
interface |
SdkHttpClient
Interface to take a representation of an HTTP request, make an HTTP call, and return a representation of an HTTP response.
|
class |
SdkHttpExecutionAttribute<T>
An attribute attached to a particular HTTP request execution, stored in
SdkHttpExecutionAttributes. |
class |
SdkHttpExecutionAttributes
An immutable collection of
SdkHttpExecutionAttributes that can be configured on an AsyncExecuteRequest via
AsyncExecuteRequest.Builder#httpExecutionAttributes(SdkHttpExecutionAttributes) |
interface |
SdkHttpFullRequest
An immutable HTTP request with a possible HTTP body.
|
interface |
SdkHttpHeaders
An immutable set of HTTP headers.
|
interface |
SdkHttpResponse
An immutable HTTP response without access to the response body.
|
interface |
SdkHttpService
Service Provider interface for HTTP implementations.
|
class |
SystemPropertyTlsKeyManagersProvider
Implementation of
TlsKeyManagersProvider that gets the information
about the KeyStore to load from the system properties. |
interface |
TlsKeyManagersProvider
Provider for the
key managers to be used by the SDK when
creating the SSL context. |
interface |
TlsTrustManagersProvider
Provider for the
trust managers to be used by the SDK when
creating the SSL context. |
| Modifier and Type | Class and Description |
|---|---|
class |
ApacheHttpClient
An implementation of
SdkHttpClient that uses Apache HTTP client to communicate with the service. |
class |
ApacheSdkHttpService
Service binding for the Apache implementation.
|
class |
ProxyConfiguration
Configuration that defines how to communicate via an HTTP or HTTPS proxy.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AsyncExecuteRequest
Request object containing the parameters necessary to make an asynchronous HTTP request.
|
interface |
SdkAsyncHttpClient
Interface to take a representation of an HTTP request, asynchronously make an HTTP call, and return a representation of an
HTTP response.
|
interface |
SdkAsyncHttpResponseHandler
Handles asynchronous HTTP responses.
|
interface |
SdkAsyncHttpService
Service Provider interface for Async HTTP implementations.
|
interface |
SdkHttpContentPublisher
A
Publisher of HTTP content data that allows streaming operations for asynchronous HTTP clients. |
| Modifier and Type | Class and Description |
|---|---|
class |
IAMRequestSigner |
| Modifier and Type | Interface and Description |
|---|---|
interface |
AwsV4AuthScheme
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
AwsV4aHttpSigner
An
HttpSigner that will use the AWS V4a signing algorithm to sign a request using an
AwsCredentialsIdentity). |
interface |
AwsV4FamilyHttpSigner<T extends Identity>
An interface shared by
AwsV4HttpSigner for defining signer properties that are common
across both signers. |
interface |
AwsV4HttpSigner
An
HttpSigner that will use the AWS V4 signing algorithm to sign a request using an
AwsCredentialsIdentity). |
class |
RegionSet
This class represents the concept of a set of regions.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
BearerAuthScheme
|
interface |
NoAuthAuthScheme
An auth scheme that represents no authentication.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
BearerHttpSigner
An
HttpSigner that will sign a request with a bearer-token (TokenIdentity). |
| Modifier and Type | Interface and Description |
|---|---|
interface |
AuthScheme<T extends Identity>
An authentication scheme, composed of:
A scheme ID - A unique identifier for the authentication scheme.
An identity provider - An API that can be queried to acquire the customer's identity.
A signer - An API that can be used to sign HTTP requests.
See example auth schemes defined here.
|
interface |
AuthSchemeOption
An authentication scheme option, composed of the scheme ID and properties for use when resolving the identity and signing
the request.
|
interface |
AuthSchemeProvider
A marker interface for an auth scheme provider.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
AsyncSignedRequest
Represents a request with async payload that has been signed by
HttpSigner. |
interface |
AsyncSignRequest<IdentityT extends Identity>
Input parameters to sign a request with async payload, using
HttpSigner. |
interface |
BaseSignedRequest<PayloadT>
/**
Base interface to a request that has been signed by
HttpSigner, independent of payload type. |
interface |
BaseSignRequest<PayloadT,IdentityT extends Identity>
Base interface to represent input parameters to sign a request using
HttpSigner, independent of payload type. |
interface |
HttpSigner<IdentityT extends Identity>
Interface for the process of modifying a request destined for a service so that the service can authenticate the SDK
customer’s identity.
|
interface |
SignedRequest
Represents a request with sync payload that has been signed by
HttpSigner. |
class |
SignerProperty<T>
A strongly-typed property for input to an
HttpSigner. |
interface |
SignRequest<IdentityT extends Identity>
Input parameters to sign a request with sync payload, using
HttpSigner. |
| Modifier and Type | Class and Description |
|---|---|
class |
AwsCrtAsyncHttpClient
An implementation of
SdkAsyncHttpClient that uses the AWS Common Runtime (CRT) Http Client to communicate with
Http Web Services. |
class |
AwsCrtHttpClient
An implementation of
SdkHttpClient that uses the AWS Common Runtime (CRT) Http Client to communicate with
Http Web Services. |
class |
AwsCrtSdkHttpService
Service binding for the AWS common runtime HTTP client implementation.
|
class |
ConnectionHealthConfiguration
Configuration that defines health checks for all connections established by
the
ConnectionHealthConfiguration. |
class |
ProxyConfiguration
Proxy configuration for
AwsCrtAsyncHttpClient. |
class |
TcpKeepAliveConfiguration
Configuration that defines keep-alive options for all connections established by
the
TcpKeepAliveConfiguration. |
| Modifier and Type | Class and Description |
|---|---|
class |
Http2Configuration
Configuration specific to HTTP/2 connections.
|
class |
NettyNioAsyncHttpClient
An implementation of
SdkAsyncHttpClient that uses a Netty non-blocking HTTP client to communicate with the service. |
class |
NettySdkAsyncHttpService
Service binding for the Netty default implementation.
|
class |
ProxyConfiguration
Proxy configuration for
NettyNioAsyncHttpClient. |
class |
SdkEventLoopGroup
|
| Modifier and Type | Class and Description |
|---|---|
class |
ProxyConfiguration
Proxy configuration for
UrlConnectionHttpClient. |
interface |
UrlConnectionFactory
An interface that, given a
URI creates a new HttpURLConnection. |
class |
UrlConnectionHttpClient
An implementation of
SdkHttpClient that uses HttpURLConnection to communicate with the service. |
class |
UrlConnectionSdkHttpService
Service binding for the URL Connection implementation.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
AwsCredentialsIdentity
Provides access to the AWS credentials used for accessing services: AWS access key ID and secret access key.
|
interface |
AwsSessionCredentialsIdentity
A special type of
AwsCredentialsIdentity that provides a session token to be used in service authentication. |
interface |
Identity
Interface to represent who is using the SDK, i.e., the identity of the caller, used for authentication.
|
class |
IdentityProperty<T>
A strongly-typed property for input to an
IdentityProvider. |
interface |
IdentityProvider<IdentityT extends Identity>
Interface for loading
Identity that is used for authentication. |
interface |
IdentityProviders
An interface to allow retrieving an IdentityProvider based on the identity type.
|
interface |
ResolveIdentityRequest
A request to resolve an
Identity. |
interface |
TokenIdentity
Provides token which is used to securely authorize requests to services that use token based auth, e.g., OAuth.
|
| Modifier and Type | Class and Description |
|---|---|
class |
LoggingMetricPublisher
An implementation of
MetricPublisher that logs all published metrics under the com.ibm.cos.v2.metrics.LoggingMetricPublisher namespace. |
class |
MetricCategory
A enum class representing the different types of metric categories in the SDK.
|
interface |
MetricCollection
An immutable collection of metrics.
|
interface |
MetricCollector
Used to collect metrics reported by the SDK.
|
class |
MetricLevel
The
MetricLevel associated with a SdkMetric, similar to log levels, defines the 'scenario' in which the metric
is useful. |
interface |
MetricPublisher
Interface to report and publish the collected SDK metric events to external
sources.
|
interface |
MetricRecord<T>
A container associating a metric and its value.
|
class |
NoOpMetricCollector
A metric collector that doesn't do anything.
|
interface |
SdkMetric<T>
A specific SDK metric.
|
| Modifier and Type | Class and Description |
|---|---|
class |
Profile
A named collection of configuration stored in a
ProfileFile. |
class |
ProfileFile
Provides programmatic access to the contents of an AWS configuration profile file.
|
class |
ProfileFileLocation
A collection of static methods for loading the location for configuration and credentials files.
|
interface |
ProfileFileSupplier
Encapsulates the logic for supplying either a single or multiple ProfileFile instances.
|
class |
ProfileProperty
The properties used by the Java SDK from the credentials and config files.
|
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultServiceMetadata |
class |
EndpointTag
A tag applied to endpoints to specify that they're to be used in certain contexts.
|
class |
GeneratedPartitionMetadataProvider |
class |
GeneratedRegionMetadataProvider |
class |
GeneratedServiceMetadataProvider |
class |
PartitionEndpointKey
A key used to look up a specific partition hostname or DNS suffix via
PartitionMetadata.hostname(PartitionEndpointKey) or PartitionMetadata.dnsSuffix(PartitionEndpointKey). |
static interface |
PartitionEndpointKey.Builder |
interface |
PartitionMetadata
Metadata about a partition such as aws or aws-cn.
|
interface |
PartitionMetadataProvider |
class |
Region
An Amazon Web Services region that hosts a set of Amazon services.
|
interface |
RegionMetadata
A collection of metadata about a region.
|
interface |
RegionMetadataProvider |
class |
RegionScope
This class represents the concept of a regional scope, in form of a string with possible wildcards.
|
class |
ServiceEndpointKey
A ServiceEndpointKey uniquely identifies a service endpoint, and can be used to look up endpoints via
ServiceMetadata.endpointFor(ServiceEndpointKey). |
static interface |
ServiceEndpointKey.Builder |
interface |
ServiceMetadata
Metadata about a service, like S3, DynamoDB, etc.
|
class |
ServiceMetadataAdvancedOption<T>
A collection of advanced options that can be configured on a
ServiceMetadata via
ServiceMetadataConfiguration.Builder.putAdvancedOption(ServiceMetadataAdvancedOption, Object). |
class |
ServiceMetadataConfiguration
Configuration for a
ServiceMetadata. |
interface |
ServiceMetadataProvider |
interface |
ServicePartitionMetadata
The metadata associated with a specific service, in a specific partition.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AwsCnPartitionMetadata |
class |
AwsEuscPartitionMetadata |
class |
AwsIsoBPartitionMetadata |
class |
AwsIsoEPartitionMetadata |
class |
AwsIsoFPartitionMetadata |
class |
AwsIsoPartitionMetadata |
class |
AwsPartitionMetadata |
class |
AwsUsGovPartitionMetadata |
| Modifier and Type | Class and Description |
|---|---|
class |
AfSouth1 |
| Modifier and Type | Class and Description |
|---|---|
class |
EnhancedS3ServiceMetadata
Decorator metadata class for S3 to allow customers to opt in to using the
regional S3 us-east-1 endpoint instead of the legacy
s3.amazonaws.com when specifying the us-east-1 region. |
class |
S3ControlServiceMetadata |
class |
S3OutpostsServiceMetadata |
class |
S3ServiceMetadata |
| Modifier and Type | Interface and Description |
|---|---|
interface |
AdaptiveRetryStrategy
The adaptive retry strategy is a
RetryStrategy when executing against a very resource-constrained set of resources. |
class |
DefaultRetryStrategy
Built-in implementations of the
RetryStrategy interface. |
interface |
LegacyRetryStrategy
The legacy retry strategy is a
RetryStrategy for normal use-cases. |
interface |
StandardRetryStrategy
The standard retry strategy is the recommended
RetryStrategy for normal use-cases. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
AcquireInitialTokenRequest
Encapsulates the abstract scope to start the attempts about to be executed using a retry strategy.
|
interface |
AcquireInitialTokenResponse
Encapsulates the response from the
RetryStrategy to the request to start the attempts to be executed. |
interface |
BackoffStrategy
Determines how long to wait before each execution attempt.
|
interface |
RecordSuccessRequest
Request that the calling code makes to the
RetryStrategy using
RetryStrategy.recordSuccess(RecordSuccessRequest) to notify that the attempted execution succeeded. |
interface |
RecordSuccessResponse
Response given to the calling code by the
RetryStrategy after calling
RetryStrategy.recordSuccess(RecordSuccessRequest). |
interface |
RefreshRetryTokenRequest
Request that the calling code makes to the
RetryStrategy using
RetryStrategy.refreshRetryToken(RefreshRetryTokenRequest) to notify that the attempted execution failed and the
RetryToken needs to be refreshed. |
interface |
RefreshRetryTokenResponse
Response from the
RetryStrategy after calling RetryStrategy.refreshRetryToken(RefreshRetryTokenRequest). |
interface |
RetryStrategy
A strategy used by an SDK to determine when something should be retried.
|
interface |
RetryToken
An opaque token representing an in-progress execution.
|
class |
TokenAcquisitionFailedException
Exception thrown by
RetryStrategy when a new token cannot be acquired. |
| Modifier and Type | Class and Description |
|---|---|
class |
DelegatingS3AsyncClient |
class |
DelegatingS3Client |
class |
LegacyMd5Plugin
Plugin that enables legacy MD5 checksum behavior for S3 operations.
|
interface |
S3AsyncClient
Service client for accessing Amazon S3 asynchronously.
|
interface |
S3BaseClientBuilder<B extends S3BaseClientBuilder<B,C>,C>
This includes configuration specific to Amazon S3 that is supported by both
S3ClientBuilder and
S3AsyncClientBuilder. |
interface |
S3Client
Service client for accessing Amazon S3.
|
class |
S3Configuration |
class |
S3ServiceClientConfiguration
Class to expose the service client settings to the user.
|
class |
S3Uri
Object that represents a parsed S3 URI.
|
class |
S3Utilities
Utilities for working with Amazon S3 objects.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
S3AuthSchemeParams
The parameters object used to resolve the auth schemes for the S3 service.
|
interface |
S3AuthSchemeProvider
An auth scheme provider for S3 service.
|
| Modifier and Type | Class and Description |
|---|---|
class |
S3EndpointParams
The parameters object used to resolve an endpoint for the S3 service.
|
interface |
S3EndpointProvider
An endpoint provider for S3.
|
| Modifier and Type | Class and Description |
|---|---|
class |
GetUrlRequest
Request to generate a URL representing an object in Amazon S3.
|
class |
S3ResponseMetadata |
interface |
SelectObjectContentEventStream
Base interface for all event types in SelectObjectContentEventStream.
|
interface |
SelectObjectContentResponseHandler
Response handler for the SelectObjectContent API.
|
| Modifier and Type | Class and Description |
|---|---|
class |
MultipartConfiguration
Class that hold configuration properties related to multipart operation for a
S3AsyncClient. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
S3Presigner
Enables signing an S3
SdkRequest so that it can be executed without requiring any additional authentication on the
part of the caller. |
static interface |
S3Presigner.Builder
A builder for creating
S3Presigners. |
| Modifier and Type | Class and Description |
|---|---|
class |
AbortMultipartUploadPresignRequest
A request to pre-sign a
AbortMultipartUploadRequest so that it can be executed at a later time without requiring
additional signing or authentication. |
static interface |
AbortMultipartUploadPresignRequest.Builder
A builder for a
AbortMultipartUploadPresignRequest, created with AbortMultipartUploadPresignRequest.builder(). |
class |
CompleteMultipartUploadPresignRequest
A request to pre-sign a
CompleteMultipartUploadRequest so that it can be executed at a later time without requiring
additional signing or authentication. |
static interface |
CompleteMultipartUploadPresignRequest.Builder
A builder for a
CompleteMultipartUploadPresignRequest, created with CompleteMultipartUploadPresignRequest.builder(). |
class |
CreateMultipartUploadPresignRequest
A request to pre-sign a
CreateMultipartUploadRequest so that it can be executed at a later time without requiring
additional signing or authentication. |
static interface |
CreateMultipartUploadPresignRequest.Builder
A builder for a
CreateMultipartUploadPresignRequest, created with CreateMultipartUploadPresignRequest.builder(). |
class |
DeleteObjectPresignRequest
A request to pre-sign a
DeleteObjectRequest so that it can be executed at a later time without requiring additional
signing or authentication. |
static interface |
DeleteObjectPresignRequest.Builder |
class |
GetObjectPresignRequest
A request to pre-sign a
GetObjectRequest so that it can be executed at a later time without requiring additional
signing or authentication. |
static interface |
GetObjectPresignRequest.Builder
A builder for a
GetObjectPresignRequest, created with GetObjectPresignRequest.builder(). |
class |
PresignedAbortMultipartUploadRequest
A pre-signed
AbortMultipartUploadRequest that can be executed at a later time without requiring additional signing
or authentication. |
static interface |
PresignedAbortMultipartUploadRequest.Builder
A builder for a
PresignedAbortMultipartUploadRequest, created with PresignedAbortMultipartUploadRequest.builder(). |
class |
PresignedCompleteMultipartUploadRequest
A pre-signed
CompleteMultipartUploadRequest that can be executed at a later time without requiring additional signing
or authentication. |
static interface |
PresignedCompleteMultipartUploadRequest.Builder
A builder for a
PresignedCompleteMultipartUploadRequest, created with PresignedCompleteMultipartUploadRequest.builder(). |
class |
PresignedCreateMultipartUploadRequest
A pre-signed
CreateMultipartUploadRequest that can be executed at a later time without requiring additional signing or
authentication. |
static interface |
PresignedCreateMultipartUploadRequest.Builder
A builder for a
PresignedCreateMultipartUploadRequest, created with PresignedCreateMultipartUploadRequest.builder(). |
class |
PresignedDeleteObjectRequest
A pre-signed a
DeleteObjectRequest that can be executed at a later time without requiring additional signing or
authentication. |
static interface |
PresignedDeleteObjectRequest.Builder
A builder for a
PresignedDeleteObjectRequest, created with PresignedDeleteObjectRequest.builder(). |
class |
PresignedGetObjectRequest
A pre-signed a
GetObjectRequest that can be executed at a later time without requiring additional signing or
authentication. |
static interface |
PresignedGetObjectRequest.Builder
A builder for a
PresignedGetObjectRequest, created with PresignedGetObjectRequest.builder(). |
class |
PresignedPutObjectRequest
A pre-signed a
PutObjectRequest that can be executed at a later time without requiring additional signing or
authentication. |
static interface |
PresignedPutObjectRequest.Builder
A builder for a
PresignedPutObjectRequest, created with PresignedPutObjectRequest.builder(). |
class |
PresignedUploadPartRequest
A pre-signed
UploadPartRequest that can be executed at a later time without requiring additional signing or
authentication. |
static interface |
PresignedUploadPartRequest.Builder
A builder for a
PresignedUploadPartRequest, created with PresignedUploadPartRequest.builder(). |
class |
PutObjectPresignRequest
A request to pre-sign a
PutObjectRequest so that it can be executed at a later time without requiring additional
signing or authentication. |
static interface |
PutObjectPresignRequest.Builder
A builder for a
PutObjectPresignRequest, created with PutObjectPresignRequest.builder(). |
class |
UploadPartPresignRequest
A request to pre-sign a
UploadPartRequest so that it can be executed at a later time without requiring additional
signing or authentication. |
static interface |
UploadPartPresignRequest.Builder
A builder for a
UploadPartPresignRequest, created with UploadPartPresignRequest.builder(). |
| Modifier and Type | Interface and Description |
|---|---|
interface |
S3ExpressAuthScheme
An auth scheme for faster authentication when interacting with S3 express.
|
interface |
S3ExpressSessionCredentials
Session credentials used by
S3ExpressAuthScheme. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
S3AsyncWaiter
Waiter utility class that polls a resource until a desired state is reached or until it is determined that the
resource will never enter into the desired state.
|
interface |
S3Waiter
Waiter utility class that polls a resource until a desired state is reached or until it is determined that the
resource will never enter into the desired state.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
S3TransferManager
The S3 Transfer Manager offers a simple API that allows you to transfer a single object or a set of objects to and
from Amazon S3 with enhanced throughput and reliability.
|
class |
SizeConstant
Helpful constants for common size units.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
DownloadFilter
DownloadFilter allows you to filter out which objects should be downloaded as part of a DownloadDirectoryRequest. |
class |
TransferRequestOverrideConfiguration
Configuration options for
UploadFileRequest and DownloadFileRequest. |
| Modifier and Type | Class and Description |
|---|---|
class |
CompletedCopy
Represents a completed copy transfer to Amazon S3.
|
class |
CompletedDirectoryDownload
Represents a completed download directory transfer to Amazon S3.
|
interface |
CompletedDirectoryTransfer
A completed directory-based transfer.
|
class |
CompletedDirectoryUpload
Represents a completed upload directory transfer to Amazon S3.
|
class |
CompletedDownload<ResultT>
Represents a completed download transfer from Amazon S3.
|
class |
CompletedFileDownload
Represents a completed download transfer from Amazon S3.
|
class |
CompletedFileUpload
Represents a completed upload transfer to Amazon S3.
|
interface |
CompletedObjectTransfer
A completed single object transfer.
|
interface |
CompletedTransfer
The parent interface for all completed transfers.
|
class |
CompletedUpload
Represents a completed upload transfer to Amazon S3.
|
interface |
Copy
A copy transfer of an object that is already stored in S3.
|
class |
CopyRequest
Creates a copy of an object that is already stored in S3.
|
static interface |
CopyRequest.Builder
A builder for a
CopyRequest, created with CopyRequest.builder() |
interface |
DirectoryDownload
A download transfer of a directory of objects from S3
|
interface |
DirectoryTransfer
Represents the upload or download of a directory of files to or from S3.
|
interface |
DirectoryUpload
An upload transfer of a single object to S3.
|
interface |
Download<ResultT>
A download transfer of a single object from S3.
|
class |
DownloadDirectoryRequest
Request object to download the objects in the provided S3 bucket to a local directory using the Transfer Manager.
|
class |
DownloadFileRequest
Download an object identified by the bucket and key from S3 to a local file.
|
static interface |
DownloadFileRequest.Builder
A builder for a
DownloadFileRequest, created with DownloadFileRequest.builder() |
class |
DownloadRequest<ReturnT>
Represents the request to download an object identified by the bucket and key from S3 through the given
AsyncResponseTransformer. |
class |
FailedFileDownload
Represents a failed single file download from
S3TransferManager.downloadDirectory(DownloadDirectoryRequest). |
class |
FailedFileUpload
Represents a failed single file upload from
S3TransferManager.uploadDirectory(com.ibm.cos.v2.transfer.s3.model.UploadDirectoryRequest). |
interface |
FailedObjectTransfer
Represents a failed single file transfer in a multi-file transfer operation such as
S3TransferManager.uploadDirectory(com.ibm.cos.v2.transfer.s3.model.UploadDirectoryRequest) |
interface |
FileDownload
A download transfer of a single object from S3.
|
interface |
FileUpload
An upload transfer of a single object to S3.
|
interface |
ObjectTransfer
Represents the upload or download of a single object to or from S3.
|
class |
ResumableFileDownload
An opaque token that holds the state and can be used to resume a paused download operation.
|
class |
ResumableFileUpload
POJO class that holds the state and can be used to resume a paused upload file operation.
|
interface |
ResumableTransfer
Contains the information of a pausible upload or download; such
information can be used to resume the upload or download later on
|
interface |
Transfer
Represents the upload or download of one or more objects to or from S3.
|
interface |
TransferDirectoryRequest
Interface for all transfer directory requests.
|
interface |
TransferObjectRequest
Interface for all single object transfer requests.
|
interface |
TransferRequest
The parent interface for all transfer requests.
|
interface |
Upload
An upload transfer of a single object to S3.
|
class |
UploadDirectoryRequest
Request object to upload a local directory to S3 using the Transfer Manager.
|
class |
UploadFileRequest
Represents the request to upload a local file to an object in S3.
|
static interface |
UploadFileRequest.Builder
A builder for a
UploadFileRequest, created with UploadFileRequest.builder() |
class |
UploadRequest
Upload the given
AsyncRequestBody to an object in S3. |
static interface |
UploadRequest.Builder
A builder for a
UploadRequest, created with UploadRequest.builder() |
| Modifier and Type | Class and Description |
|---|---|
class |
LoggingTransferListener
An example implementation of
TransferListener that logs a progress bar at the INFO level. |
interface |
TransferListener
The
TransferListener interface may be implemented by your application in order to receive event-driven updates on the
progress of a transfer initiated by S3TransferManager. |
static interface |
TransferListener.Context.BytesTransferred
Additional bytes have been submitted or received.
|
static interface |
TransferListener.Context.TransferComplete
The transfer has completed successfully.
|
static interface |
TransferListener.Context.TransferFailed
The transfer failed.
|
static interface |
TransferListener.Context.TransferInitiated
A new transfer has been initiated.
|
interface |
TransferProgress
TransferProgress is a stateful representation of the progress of a transfer initiated by S3TransferManager. |
interface |
TransferProgressSnapshot
TransferProgressSnapshot is an immutable, point-in-time representation of the progress of a given transfer
initiated by S3TransferManager. |
| Modifier and Type | Class and Description |
|---|---|
class |
CancellableOutputStream
An implementation of
OutputStream to which writing can be CancellableOutputStream.cancel()ed. |
class |
Lazy<T>
A class that lazily constructs a value the first time
Lazy.getValue() is invoked. |
interface |
SdkAutoCloseable
An implementation of
AutoCloseable that does not throw any checked exceptions. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
CopyableBuilder<B extends CopyableBuilder<B,T>,T extends ToCopyableBuilder<B,T>>
A special type of
SdkBuilder that can be used when the built type implements ToCopyableBuilder. |
interface |
SdkBuilder<B extends SdkBuilder<B,T>,T>
A mutable object that can be used to create an immutable object of type T.
|
interface |
ToCopyableBuilder<B extends CopyableBuilder<B,T>,T extends ToCopyableBuilder<B,T>>
Implementors of this interface provide a way to get from an instance of T to a
CopyableBuilder. |
Copyright © 2026. All rights reserved.