@InterfaceAudience.Private @InterfaceStability.Evolving

Package org.apache.hadoop.fs.s3a

S3A Filesystem.

See: Description

Interface Summary

Interface	Description
Invoker.Retried	Callback for retry and notification operations.
S3AInputStream.InputStreamCallbacks	Callbacks for input stream IO.
S3AInternals	This is an unstable interface for access to S3A Internal state, S3 operations and the S3 client connector itself.
S3AUtils.CallOnLocatedFileStatus	An interface for use in lambda-expressions working with directory tree listings.
S3AUtils.LocatedFileStatusMap<T>	An interface for use in lambda-expressions working with directory tree listings.
S3ClientFactory	Deprecated This interface will be replaced by one which uses the AWS SDK V2 S3 client as part of upgrading S3A to SDK V2.
WriteOperationHelper.WriteOperationHelperCallbacks	Callbacks for writeOperationHelper.
WriteOperations	Operations to update the store.

Class Summary

Class	Description
AnonymousAWSCredentialsProvider	AnonymousAWSCredentialsProvider supports anonymous access to AWS services through the AWS SDK.
ArnResource	Represents an Arn Resource, this can be an accesspoint or bucket.
AWSCredentialProviderList	A list of providers.
Constants	Constants used with the S3AFileSystem.
DefaultS3ClientFactory	The default S3ClientFactory implementation.
FailureInjectionPolicy	Simple object which stores current failure injection settings.
Invoker	Class to provide lambda expression invocation of AWS operations.
Listing	Place for the S3A listing classes; keeps all the small classes under control.
Listing.AcceptAllButSelfAndS3nDirs	Accept all entries except the base path and those which map to S3N pseudo directory markers.
MultipartUtils	MultipartUtils upload-specific functions for use by S3AFileSystem and Hadoop CLI.
MultipartUtils.UploadIterator	Iterator over multipart uploads.
ProgressableProgressListener	Listener to progress from AWS regarding transfers.
Retries	Annotations to inform the caller of an annotated method whether the method performs retries and/or exception translation internally.
S3A	S3A implementation of AbstractFileSystem.
S3ADataBlocks	Set of classes to support output streaming into blocks which are then uploaded as to S3 as a single PUT, or as part of a multipart request.
S3ADataBlocks.BlockUploadData	The output information for an upload.
S3AFileStatus	File status for an S3A "file".
S3AFileSystem	The core S3A Filesystem implementation.
S3AInputStream	The input stream for an S3A object.
S3AInstrumentation	Instrumentation of S3A.
S3ALocatedFileStatus	LocatedFileStatus extended to also carry ETag and object version ID.
S3AOpContext	Class for operation context struct passed through codepaths for main S3AFileSystem operations.
S3AReadOpContext	Read-specific operation context struct.
S3ARetryPolicy	The S3A request retry policy.
S3AStorageStatistics	Storage statistics for S3A, dynamically generated from the IOStatistics.
S3AUtils	Utility methods for S3A code.
S3ClientFactory.S3ClientCreationParameters	Settings for the S3 Client.
S3ListRequest	API version-independent container for S3 List requests.
S3ListResult	API version-independent container for S3 List responses.
S3ObjectAttributes	This class holds attributes of an object independent of the file status type.
SharedInstanceCredentialProvider	This credential provider has jittered between existing and non-existing, but it turns up in documentation enough that it has been restored.
SimpleAWSCredentialsProvider	Support simple credentials for authenticating with AWS.
TemporaryAWSCredentialsProvider	Support session credentials for authenticating with AWS.
UploadInfo	Simple struct that contains information about a S3 upload.
VectoredIOContext	Context related to vectored IO operation.
WriteOperationHelper	Helper for low-level operations against an S3 Bucket for writing data, creating and committing pending writes, and other S3-layer operations.

Enum Summary

Enum	Description
S3AEncryptionMethods	This enum is to centralize the encryption methods and the value required in the configuration.
S3AInputPolicy	Stream input policy.
Statistic	Statistic which are collected in S3A.
Tristate	Simple enum to express {true, false, don't know}.

Exception Summary

Exception	Description
AWSApiCallTimeoutException	IOException equivalent of an ApiCallTimeoutException.
AWSBadRequestException	A 400 "Bad Request" exception was received.
AWSClientIOException	IOException equivalent of an SdkException.
AWSNoResponseException	Status code 443, no response from server.
AWSRedirectException	Request is redirected.
AWSS3IOException	Wrap a S3Exception as an IOE, relaying all getters.
AWSServiceIOException	A specific exception from AWS operations.
AWSServiceThrottledException	Exception raised when a service was throttled.
AWSStatus500Exception	A 5xx response came back from a service.
AWSUnsupportedFeatureException	A store returned an error indicating that it does not support a specific S3 feature such as the chosen ChangeDetectionPolicy or other AWS-S3 feature that the third-party store does not support.
CredentialInitializationException	Exception which Hadoop's AWSCredentialsProvider implementations should throw when there is a problem with the credential setup.
HttpChannelEOFException	Http channel exception; subclass of EOFException.
NoVersionAttributeException	Indicates the S3 object does not provide the versioning attribute required by the configured change detection policy.
RangeNotSatisfiableEOFException	Status code 416, range not satisfiable.
RemoteFileChangedException	Indicates the S3 object is out of sync with the expected version.
RenameFailedException	Error to indicate that a specific rename failed.
UnknownStoreException	The bucket or other AWS resource is unknown.

Annotation Types Summary

Annotation Type	Description
Retries.OnceExceptionsSwallowed	One attempt, Exceptions are swallowed.
Retries.OnceMixed	No retry, expect a bit of both.
Retries.OnceRaw	No retry, exceptions are not translated.
Retries.OnceTranslated	No retry, exceptions are translated.
Retries.RetryExceptionsSwallowed	Retried, Exceptions are swallowed.
Retries.RetryMixed	Retried, mixed translation.
Retries.RetryRaw	Retried, no translation.
Retries.RetryTranslated	Retried, exceptions are translated.

Package org.apache.hadoop.fs.s3a Description

S3A Filesystem. Except for the exceptions, it should all be hidden as implementation details.