@InterfaceAudience.Private @InterfaceStability.Evolving

Package org.apache.hadoop.fs.s3a

S3A Filesystem.

See: Description

Interface Summary

Interface	Description
Invoker.Operation<T>	Arbitrary operation throwing an IOException.
Invoker.Retried	Callback for retry and notification operations.
Invoker.VoidOperation	Void operation which may raise an IOException.
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	Factory for creation of AmazonS3 client instances.

Class Summary

Class	Description
AnonymousAWSCredentialsProvider	AnonymousAWSCredentialsProvider supports anonymous access to AWS services through the AWS SDK.
AWSCredentialProviderList	A list of providers.
Constants	All the constants used with the S3AFileSystem.
DefaultS3ClientFactory	The default S3ClientFactory implementation.
FailureInjectionPolicy	Simple object which stores current failure injection settings.
InconsistentAmazonS3Client	A wrapper around AmazonS3 that injects inconsistency and/or errors.
InconsistentS3ClientFactory	S3 Client factory used for testing with eventual consistency fault injection.
InconsistentS3Object	Wrapper around S3Object so we can do failure injection on getObjectContent() and S3ObjectInputStream.
Invoker	Class to provide lambda expression invocation of AWS operations.
Listing	Place for the S3A listing classes; keeps all the small classes under control.
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	Declaration of retry policy for documentation only.
S3A	S3A implementation of AbstractFileSystem.
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.
S3AMultipartUploader	MultipartUploader for S3AFileSystem.
S3AMultipartUploader.Factory	Factory for creating MultipartUploader objects for s3a:// FileSystems.
S3AOpContext	Base 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.
S3AUtils	Utility methods for S3A code.
S3GuardExistsRetryPolicy	Slightly-modified retry policy for cases when the file is present in the MetadataStore, but may be still throwing FileNotFoundException from S3.
S3ListRequest	API version-independent container for S3 List requests.
S3ListResult	API version-independent container for S3 List responses.
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.
WriteOperationHelper	Helper for low-level operations against an S3 Bucket for writing data and creating and committing pending writes.

Enum Summary

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

Exception Summary

Exception	Description
AWSBadRequestException	A 400 "Bad Request" exception was received.
AWSClientIOException	IOException equivalent of an AmazonClientException.
AWSNoResponseException	Status code 443, no response from server.
AWSRedirectException	Request is redirected.
AWSS3IOException	Wrap a AmazonS3Exception as an IOE, relaying all getters.
AWSServiceIOException	A specific exception from AWS operations.
AWSServiceThrottledException	Exception raised when a service was throttled.
AWSStatus500Exception	A 500 response came back from a service.
CredentialInitializationException	Exception which Hadoop's AWSCredentialsProvider implementations should throw when there is a problem with the credential setup.
RenameFailedException	Error to indicate that a specific rename failed.

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.