| Package | Description |
|---|---|
| com.ibm.cloud.objectstorage | |
| com.ibm.cloud.objectstorage.auth | |
| com.ibm.cloud.objectstorage.auth.json | |
| com.ibm.cloud.objectstorage.auth.profile |
AWS configuration profiles allow you to share multiple sets of AWS
security credentials between different tools such as the AWS SDK for Java
and the AWS CLI.
|
| com.ibm.cloud.objectstorage.http.timers.client | |
| com.ibm.cloud.objectstorage.oauth | |
| com.ibm.cloud.objectstorage.protocol | |
| com.ibm.cloud.objectstorage.protocol.json | |
| com.ibm.cloud.objectstorage.regions | |
| com.ibm.cloud.objectstorage.services.aspera.transfer | |
| com.ibm.cloud.objectstorage.services.s3 |
Synchronous client for accessing Amazon S3.
|
| com.ibm.cloud.objectstorage.services.s3.internal | |
| com.ibm.cloud.objectstorage.services.s3.internal.crypto.v1 | |
| com.ibm.cloud.objectstorage.services.s3.model |
Classes modeling the various types represented by Amazon S3.
|
| com.ibm.cloud.objectstorage.services.s3.transfer.exception | |
| com.ibm.cloud.objectstorage.waiters |
| Modifier and Type | Class and Description |
|---|---|
class |
AbortedException
SDK operation aborted exception.
|
class |
AmazonServiceException
Extension of SdkClientException that represents an error response returned
by an Amazon web service.
|
class |
ResetException
Stream reset failure.
|
| Modifier and Type | Method and Description |
|---|---|
byte[] |
AbstractAWSSigner.hash(byte[] data)
Hashes the binary data using the SHA-256 algorithm.
|
protected byte[] |
AbstractAWSSigner.hash(InputStream input) |
byte[] |
AbstractAWSSigner.hash(String text)
Hashes the string contents (assumed to be UTF-8) using the SHA-256
algorithm.
|
protected boolean |
AWS3Signer.shouldUseHttpsScheme(SignableRequest<?> request) |
protected byte[] |
AbstractAWSSigner.sign(byte[] data,
byte[] key,
SigningAlgorithm algorithm) |
void |
AWS3Signer.sign(SignableRequest<?> request,
AWSCredentials credentials)
Signs the specified request with the AWS3 signing protocol by using the
AWS account credentials specified when this object was constructed and
adding the required AWS3 headers to the request.
|
void |
QueryStringSigner.sign(SignableRequest<?> request,
AWSCredentials credentials)
This signer will add "Signature" parameter to the request.
|
void |
QueryStringSigner.sign(SignableRequest<?> request,
SignatureVersion version,
SigningAlgorithm algorithm,
AWSCredentials credentials)
This signer will add following authentication parameters to the request:
AWSAccessKeyId SignatureVersion SignatureMethod Timestamp Signature
|
byte[] |
AbstractAWSSigner.sign(String stringData,
byte[] key,
SigningAlgorithm algorithm) |
protected String |
AbstractAWSSigner.signAndBase64Encode(byte[] data,
String key,
SigningAlgorithm algorithm)
Computes an RFC 2104-compliant HMAC signature for an array of bytes and
returns the result as a Base64 encoded string.
|
protected String |
AbstractAWSSigner.signAndBase64Encode(String data,
String key,
SigningAlgorithm algorithm)
Computes an RFC 2104-compliant HMAC signature and returns the result as a
Base64 encoded string.
|
| Constructor and Description |
|---|
JsonConfigFile()
Loads the IBM credentials file from the default location (~/.bluemix/cos_credentials) or from
an alternate location if
IBM_CREDENTIAL_JSON_FILE is set. |
JsonConfigFile(File file)
Loads the IBM credentials from the file.
|
| Constructor and Description |
|---|
ProfilesConfigFile()
Loads the AWS credential profiles file from the default location (~/.aws/credentials) or from
an alternate location if
AWS_CREDENTIAL_PROFILES_FILE is set. |
ProfilesConfigFile(File file)
Loads the AWS credential profiles from the file.
|
ProfilesConfigFile(File file,
ProfileCredentialsService credentialsService)
Loads the AWS credential profiles from the file.
|
ProfilesConfigFile(String filePath,
ProfileCredentialsService credentialsService)
Loads the AWS credential profiles from the file.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ClientExecutionTimeoutException |
| Modifier and Type | Class and Description |
|---|---|
class |
OAuthServiceException
Provides an extension of the SdkClientException
for errors reported by the IAM Service processing a request.
|
| Modifier and Type | Method and Description |
|---|---|
<T> void |
ProtocolMarshaller.marshall(T val,
MarshallingInfo<T> marshallingInfo)
Marshalls the value into the appropriate location based on the
MarshallingInfo metadata. |
| Modifier and Type | Class and Description |
|---|---|
static class |
SdkJsonGenerator.JsonGenerationException
Indicates an issue writing JSON content.
|
| Modifier and Type | Method and Description |
|---|---|
abstract String |
AwsRegionProvider.getRegion() |
String |
AwsRegionProviderChain.getRegion() |
String |
AwsSystemPropertyRegionProvider.getRegion() |
String |
AwsEnvVarOverrideRegionProvider.getRegion() |
String |
AwsProfileRegionProvider.getRegion() |
| Modifier and Type | Class and Description |
|---|---|
class |
AsperaTransferException
Provides an extension of the SdkClientException
for errors reported by the IAM Service processing a request.
|
| Modifier and Type | Method and Description |
|---|---|
TransferSpecs |
AsperaTransferManager.getTransferSpec(FASPConnectionInfo faspConnectionInfo,
String localFileName,
String remoteFileName,
String direction) |
| Modifier and Type | Method and Description |
|---|---|
void |
AmazonS3Client.abortMultipartUpload(AbortMultipartUploadRequest abortMultipartUploadRequest) |
void |
AbstractAmazonS3.abortMultipartUpload(AbortMultipartUploadRequest request) |
void |
AmazonS3.abortMultipartUpload(AbortMultipartUploadRequest request)
Aborts a multipart upload.
|
void |
AmazonS3Client.addLegalHold(AddLegalHoldRequest addLegalHoldRequest) |
void |
AmazonS3.addLegalHold(AddLegalHoldRequest addLegalHoldRequest)
Adds a legal hold to the specified object in the specified bucket.
|
void |
AmazonS3Client.addLegalHold(String bucketName,
String key,
String legalHoldId) |
void |
AmazonS3.addLegalHold(String bucketName,
String key,
String legalHoldId)
Adds a legal hold to the specified object in the specified bucket.
|
void |
AmazonS3Client.changeObjectStorageClass(String bucketName,
String key,
StorageClass newStorageClass) |
void |
AbstractAmazonS3.changeObjectStorageClass(String bucketName,
String key,
StorageClass newStorageClass) |
void |
AmazonS3.changeObjectStorageClass(String bucketName,
String key,
StorageClass newStorageClass)
Deprecated.
this operation will not retain the ACL's or SSE parameters
associated with the given Amazon S3 object. Use
AmazonS3.copyObject(CopyObjectRequest)
instead. |
CompleteMultipartUploadResult |
AmazonS3Client.completeMultipartUpload(CompleteMultipartUploadRequest completeMultipartUploadRequest) |
CompleteMultipartUploadResult |
AbstractAmazonS3.completeMultipartUpload(CompleteMultipartUploadRequest request) |
CompleteMultipartUploadResult |
AmazonS3.completeMultipartUpload(CompleteMultipartUploadRequest request)
Completes a multipart upload by assembling previously uploaded parts.
|
CopyObjectResult |
AmazonS3Client.copyObject(CopyObjectRequest copyObjectRequest) |
CopyObjectResult |
AbstractAmazonS3.copyObject(CopyObjectRequest copyObjectRequest) |
CopyObjectResult |
AmazonS3.copyObject(CopyObjectRequest copyObjectRequest)
Copies a source object to a new destination in Amazon S3.
|
CopyObjectResult |
AmazonS3Client.copyObject(String sourceBucketName,
String sourceKey,
String destinationBucketName,
String destinationKey) |
CopyObjectResult |
AbstractAmazonS3.copyObject(String sourceBucketName,
String sourceKey,
String destinationBucketName,
String destinationKey) |
CopyObjectResult |
AmazonS3.copyObject(String sourceBucketName,
String sourceKey,
String destinationBucketName,
String destinationKey)
Copies a source object to a new destination in Amazon S3.
|
CopyPartResult |
AbstractAmazonS3.copyPart(CopyPartRequest copyPartRequest) |
CopyPartResult |
AmazonS3.copyPart(CopyPartRequest copyPartRequest)
Copies a source object to a part of a multipart upload.
|
Bucket |
AmazonS3Client.createBucket(CreateBucketRequest createBucketRequest) |
Bucket |
AbstractAmazonS3.createBucket(CreateBucketRequest createBucketRequest) |
Bucket |
AmazonS3.createBucket(CreateBucketRequest createBucketRequest)
Creates a new S3 bucket.
|
Bucket |
AmazonS3Client.createBucket(String bucketName) |
Bucket |
AbstractAmazonS3.createBucket(String bucketName) |
Bucket |
AmazonS3.createBucket(String bucketName)
Creates a new S3 bucket.
|
Bucket |
AmazonS3Client.createBucket(String bucketName,
Region region)
Deprecated.
|
Bucket |
AbstractAmazonS3.createBucket(String bucketName,
Region region) |
Bucket |
AmazonS3.createBucket(String bucketName,
Region region)
Deprecated.
Use regional endpoint and call
AmazonS3.createBucket(String) instead. |
Bucket |
AmazonS3Client.createBucket(String bucketName,
String region)
Deprecated.
|
Bucket |
AbstractAmazonS3.createBucket(String bucketName,
String region) |
Bucket |
AmazonS3.createBucket(String bucketName,
String region)
Deprecated.
Use regional endpoint and call
AmazonS3.createBucket(String) instead. |
void |
AmazonS3Client.deleteBucket(DeleteBucketRequest deleteBucketRequest) |
void |
AbstractAmazonS3.deleteBucket(DeleteBucketRequest deleteBucketRequest) |
void |
AmazonS3.deleteBucket(DeleteBucketRequest deleteBucketRequest)
Deletes the specified bucket.
|
void |
AmazonS3Client.deleteBucket(String bucketName) |
void |
AbstractAmazonS3.deleteBucket(String bucketName) |
void |
AmazonS3.deleteBucket(String bucketName)
Deletes the specified bucket.
|
void |
AmazonS3Client.deleteBucketReplicationConfiguration(DeleteBucketReplicationConfigurationRequest deleteBucketReplicationConfigurationRequest) |
void |
AbstractAmazonS3.deleteBucketReplicationConfiguration(DeleteBucketReplicationConfigurationRequest request) |
void |
AmazonS3.deleteBucketReplicationConfiguration(DeleteBucketReplicationConfigurationRequest request)
Deletes the replication configuration for the given Amazon S3 bucket.
|
void |
AmazonS3Client.deleteBucketReplicationConfiguration(String bucketName) |
void |
AbstractAmazonS3.deleteBucketReplicationConfiguration(String bucketName) |
void |
AmazonS3.deleteBucketReplicationConfiguration(String bucketName)
Deletes the replication configuration for the given Amazon S3 bucket.
|
void |
AmazonS3Client.deleteBucketWebsiteConfiguration(DeleteBucketWebsiteConfigurationRequest deleteBucketWebsiteConfigurationRequest) |
void |
AbstractAmazonS3.deleteBucketWebsiteConfiguration(DeleteBucketWebsiteConfigurationRequest deleteBucketWebsiteConfigurationRequest) |
void |
AmazonS3.deleteBucketWebsiteConfiguration(DeleteBucketWebsiteConfigurationRequest deleteBucketWebsiteConfigurationRequest)
This operation removes the website configuration for a bucket.
|
void |
AmazonS3Client.deleteBucketWebsiteConfiguration(String bucketName) |
void |
AbstractAmazonS3.deleteBucketWebsiteConfiguration(String bucketName) |
void |
AmazonS3.deleteBucketWebsiteConfiguration(String bucketName)
This operation removes the website configuration for a bucket.
|
void |
AmazonS3Client.deleteLegalHold(DeleteLegalHoldRequest deleteLegalHoldRequest) |
void |
AmazonS3.deleteLegalHold(DeleteLegalHoldRequest deleteLegalHoldRequest)
Deletes a legal hold for the specified object in the specified bucket.
|
void |
AmazonS3Client.deleteLegalHold(String bucketName,
String key,
String legalHoldId) |
void |
AmazonS3.deleteLegalHold(String bucketName,
String key,
String legalHoldId)
Deletes a legal hold for the specified object in the specified bucket.
|
void |
AmazonS3Client.deleteObject(DeleteObjectRequest deleteObjectRequest) |
void |
AbstractAmazonS3.deleteObject(DeleteObjectRequest deleteObjectRequest) |
void |
AmazonS3.deleteObject(DeleteObjectRequest deleteObjectRequest)
Deletes the specified object in the specified bucket.
|
void |
AmazonS3Client.deleteObject(String bucketName,
String key) |
void |
AbstractAmazonS3.deleteObject(String bucketName,
String key) |
void |
AmazonS3.deleteObject(String bucketName,
String key)
Deletes the specified object in the specified bucket.
|
DeleteObjectsResult |
AbstractAmazonS3.deleteObjects(DeleteObjectsRequest deleteObjectsRequest) |
DeleteObjectsResult |
AmazonS3.deleteObjects(DeleteObjectsRequest deleteObjectsRequest)
Deletes multiple objects in a single bucket from S3.
|
void |
AmazonS3Client.deleteVersion(DeleteVersionRequest deleteVersionRequest) |
void |
AbstractAmazonS3.deleteVersion(DeleteVersionRequest deleteVersionRequest) |
void |
AmazonS3.deleteVersion(DeleteVersionRequest deleteVersionRequest)
Deletes a specific version of an object in the specified bucket.
|
void |
AmazonS3Client.deleteVersion(String bucketName,
String key,
String versionId) |
void |
AbstractAmazonS3.deleteVersion(String bucketName,
String key,
String versionId) |
void |
AmazonS3.deleteVersion(String bucketName,
String key,
String versionId)
Deletes a specific version of the specified object in the specified
bucket.
|
boolean |
AmazonS3Client.doesBucketExist(String bucketName) |
boolean |
AbstractAmazonS3.doesBucketExist(String bucketName) |
boolean |
AmazonS3.doesBucketExist(String bucketName)
Deprecated.
By
AmazonS3.doesBucketExistV2(String) which will correctly throw an exception when
credentials are invalid instead of returning true. See
Issue #1256. |
boolean |
AmazonS3Client.doesBucketExistV2(String bucketName) |
boolean |
AbstractAmazonS3.doesBucketExistV2(String bucketName) |
boolean |
AmazonS3.doesBucketExistV2(String bucketName)
Checks if the specified bucket exists.
|
boolean |
AmazonS3Client.doesObjectExist(String bucketName,
String objectName) |
boolean |
AbstractAmazonS3.doesObjectExist(String bucketName,
String objectName) |
boolean |
AmazonS3.doesObjectExist(String bucketName,
String objectName) |
PresignedUrlDownloadResult |
AmazonS3Client.download(PresignedUrlDownloadRequest presignedUrlDownloadRequest) |
void |
AmazonS3Client.download(PresignedUrlDownloadRequest presignedUrlDownloadRequest,
File destinationFile) |
void |
AmazonS3Client.extendObjectRetention(ExtendObjectRetentionRequest extendObjectRetentionRequest) |
void |
AmazonS3.extendObjectRetention(ExtendObjectRetentionRequest extendObjectRetentionRequest)
Extends the retention period of a protected object in a protected vault.
|
void |
AmazonS3Client.extendObjectRetention(String bucketName,
String key,
Long additionalRetentionPeriod,
Long extendRetentionFromCurrentTime,
Date newRetentionExpirationDate,
Long newRetentionPeriod) |
void |
AmazonS3.extendObjectRetention(String bucketName,
String key,
Long additionalRetentionPeriod,
Long extendRetentionFromCurrentTime,
Date newRetentionExpirationDate,
Long newRetentionPeriod)
Extends the retention period of a protected object in a protected vault.
|
URL |
AbstractAmazonS3.generatePresignedUrl(GeneratePresignedUrlRequest generatePresignedUrlRequest) |
URL |
AmazonS3.generatePresignedUrl(GeneratePresignedUrlRequest generatePresignedUrlRequest)
Returns a pre-signed URL for accessing an Amazon S3 resource.
|
URL |
AmazonS3Client.generatePresignedUrl(String bucketName,
String key,
Date expiration) |
URL |
AbstractAmazonS3.generatePresignedUrl(String bucketName,
String key,
Date expiration) |
URL |
AmazonS3.generatePresignedUrl(String bucketName,
String key,
Date expiration)
Returns a pre-signed URL for accessing an Amazon S3 resource.
|
URL |
AmazonS3Client.generatePresignedUrl(String bucketName,
String key,
Date expiration,
HttpMethod method) |
URL |
AbstractAmazonS3.generatePresignedUrl(String bucketName,
String key,
Date expiration,
HttpMethod method) |
URL |
AmazonS3.generatePresignedUrl(String bucketName,
String key,
Date expiration,
HttpMethod method)
Returns a pre-signed URL for accessing an Amazon S3 resource.
|
AccessControlList |
AmazonS3Client.getBucketAcl(GetBucketAclRequest getBucketAclRequest) |
AccessControlList |
AbstractAmazonS3.getBucketAcl(GetBucketAclRequest getBucketAclRequest) |
AccessControlList |
AmazonS3.getBucketAcl(GetBucketAclRequest getBucketAclRequest)
Gets the
AccessControlList (ACL) for the specified Amazon S3
bucket. |
AccessControlList |
AmazonS3Client.getBucketAcl(String bucketName)
Gets the
AccessControlList (ACL) for the specified Amazon S3 bucket. |
AccessControlList |
AbstractAmazonS3.getBucketAcl(String bucketName) |
AccessControlList |
AmazonS3.getBucketAcl(String bucketName)
Gets the
AccessControlList (ACL) for the specified Amazon S3 bucket. |
FASPConnectionInfo |
AmazonS3Client.getBucketFaspConnectionInfo(GetBucketFaspConnectionInfoRequest getBucketFaspConnectionInfoRequest) |
FASPConnectionInfo |
AmazonS3.getBucketFaspConnectionInfo(GetBucketFaspConnectionInfoRequest getBucketFASPConnectionInfoRequest)
Gets the FASP Connection Info for a particular bucket.
|
FASPConnectionInfo |
AmazonS3Client.getBucketFaspConnectionInfo(String bucketName) |
FASPConnectionInfo |
AmazonS3.getBucketFaspConnectionInfo(String bucketName)
Gets the FASP Connection Info for a particular bucket.
|
BucketProtectionConfiguration |
AmazonS3Client.getBucketProtection(String bucketName) |
BucketProtectionConfiguration |
AmazonS3.getBucketProtection(String bucketName)
Gets the protection configuration for the specified bucket.
|
BucketProtectionConfiguration |
AmazonS3Client.getBucketProtectionConfiguration(GetBucketProtectionConfigurationRequest getBucketProtectionRequest) |
BucketProtectionConfiguration |
AmazonS3.getBucketProtectionConfiguration(GetBucketProtectionConfigurationRequest getBucketProtectionRequest) |
BucketReplicationConfiguration |
AmazonS3Client.getBucketReplicationConfiguration(GetBucketReplicationConfigurationRequest getBucketReplicationConfigurationRequest) |
BucketReplicationConfiguration |
AbstractAmazonS3.getBucketReplicationConfiguration(GetBucketReplicationConfigurationRequest getBucketReplicationConfigurationRequest) |
BucketReplicationConfiguration |
AmazonS3.getBucketReplicationConfiguration(GetBucketReplicationConfigurationRequest getBucketReplicationConfigurationRequest)
Retrieves the replication configuration for the given Amazon S3 bucket.
|
BucketReplicationConfiguration |
AmazonS3Client.getBucketReplicationConfiguration(String bucketName) |
BucketReplicationConfiguration |
AbstractAmazonS3.getBucketReplicationConfiguration(String bucketName) |
BucketReplicationConfiguration |
AmazonS3.getBucketReplicationConfiguration(String bucketName)
Retrieves the replication configuration for the given Amazon S3 bucket.
|
BucketVersioningConfiguration |
AmazonS3Client.getBucketVersioningConfiguration(GetBucketVersioningConfigurationRequest getBucketVersioningConfigurationRequest) |
BucketVersioningConfiguration |
AbstractAmazonS3.getBucketVersioningConfiguration(GetBucketVersioningConfigurationRequest getBucketVersioningConfigurationRequest) |
BucketVersioningConfiguration |
AmazonS3.getBucketVersioningConfiguration(GetBucketVersioningConfigurationRequest getBucketVersioningConfigurationRequest)
Returns the versioning configuration for the specified bucket.
|
BucketVersioningConfiguration |
AmazonS3Client.getBucketVersioningConfiguration(String bucketName) |
BucketVersioningConfiguration |
AbstractAmazonS3.getBucketVersioningConfiguration(String bucketName) |
BucketVersioningConfiguration |
AmazonS3.getBucketVersioningConfiguration(String bucketName)
Returns the versioning configuration for the specified bucket.
|
BucketWebsiteConfiguration |
AmazonS3Client.getBucketWebsiteConfiguration(GetBucketWebsiteConfigurationRequest getBucketWebsiteConfigurationRequest) |
BucketWebsiteConfiguration |
AbstractAmazonS3.getBucketWebsiteConfiguration(GetBucketWebsiteConfigurationRequest getBucketWebsiteConfigurationRequest) |
BucketWebsiteConfiguration |
AmazonS3.getBucketWebsiteConfiguration(GetBucketWebsiteConfigurationRequest getBucketWebsiteConfigurationRequest)
Returns the website configuration for the specified bucket.
|
BucketWebsiteConfiguration |
AmazonS3Client.getBucketWebsiteConfiguration(String bucketName) |
BucketWebsiteConfiguration |
AbstractAmazonS3.getBucketWebsiteConfiguration(String bucketName) |
BucketWebsiteConfiguration |
AmazonS3.getBucketWebsiteConfiguration(String bucketName)
Returns the website configuration for the specified bucket.
|
S3Object |
AmazonS3Client.getObject(GetObjectRequest getObjectRequest) |
S3Object |
AbstractAmazonS3.getObject(GetObjectRequest getObjectRequest) |
S3Object |
AmazonS3.getObject(GetObjectRequest getObjectRequest)
Retrieves objects from Amazon S3.
|
ObjectMetadata |
AmazonS3Client.getObject(GetObjectRequest getObjectRequest,
File destinationFile) |
ObjectMetadata |
AbstractAmazonS3.getObject(GetObjectRequest getObjectRequest,
File destinationFile) |
ObjectMetadata |
AmazonS3.getObject(GetObjectRequest getObjectRequest,
File destinationFile)
Retrieves objects from Amazon S3.
|
S3Object |
AmazonS3Client.getObject(String bucketName,
String key) |
S3Object |
AbstractAmazonS3.getObject(String bucketName,
String key) |
S3Object |
AmazonS3.getObject(String bucketName,
String key)
Retrieves objects from Amazon S3.
|
AccessControlList |
AbstractAmazonS3.getObjectAcl(GetObjectAclRequest getObjectAclRequest) |
AccessControlList |
AmazonS3.getObjectAcl(GetObjectAclRequest getObjectAclRequest)
Gets the
AccessControlList (ACL) for the specified object in Amazon S3. |
AccessControlList |
AmazonS3Client.getObjectAcl(String bucketName,
String key) |
AccessControlList |
AbstractAmazonS3.getObjectAcl(String bucketName,
String key) |
AccessControlList |
AmazonS3.getObjectAcl(String bucketName,
String key)
Gets the
AccessControlList (ACL) for the specified object in Amazon S3. |
AccessControlList |
AmazonS3Client.getObjectAcl(String bucketName,
String key,
String versionId) |
AccessControlList |
AbstractAmazonS3.getObjectAcl(String bucketName,
String key,
String versionId) |
AccessControlList |
AmazonS3.getObjectAcl(String bucketName,
String key,
String versionId)
Gets the
AccessControlList (ACL) for the specified object
with the specified version in Amazon S3. |
String |
AmazonS3Client.getObjectAsString(String bucketName,
String key) |
String |
AbstractAmazonS3.getObjectAsString(String bucketName,
String key) |
String |
AmazonS3.getObjectAsString(String bucketName,
String key)
Retrieves and decodes the contents of an S3 object to a String.
|
ObjectMetadata |
AmazonS3Client.getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest) |
ObjectMetadata |
AbstractAmazonS3.getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest) |
ObjectMetadata |
AmazonS3.getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest)
The HEAD action retrieves metadata from an object without returning the object itself.
|
ObjectMetadata |
AmazonS3Client.getObjectMetadata(String bucketName,
String key) |
ObjectMetadata |
AbstractAmazonS3.getObjectMetadata(String bucketName,
String key) |
ObjectMetadata |
AmazonS3.getObjectMetadata(String bucketName,
String key)
Gets the metadata for the specified Amazon S3 object without
actually fetching the object itself.
|
Owner |
AmazonS3Client.getS3AccountOwner() |
Owner |
AbstractAmazonS3.getS3AccountOwner() |
Owner |
AmazonS3.getS3AccountOwner()
Gets the current owner of the Amazon Web Services account
that the authenticated sender of the request is using.
|
Owner |
AmazonS3Client.getS3AccountOwner(GetS3AccountOwnerRequest getS3AccountOwnerRequest) |
Owner |
AbstractAmazonS3.getS3AccountOwner(GetS3AccountOwnerRequest getS3AccountOwnerRequest) |
Owner |
AmazonS3.getS3AccountOwner(GetS3AccountOwnerRequest getS3AccountOwnerRequest)
Gets the current owner of the Amazon Web Services account
that the authenticated sender of the request is using.
|
HeadBucketResult |
AmazonS3Client.headBucket(HeadBucketRequest headBucketRequest) |
HeadBucketResult |
AbstractAmazonS3.headBucket(HeadBucketRequest headBucketRequest) |
HeadBucketResult |
AmazonS3.headBucket(HeadBucketRequest headBucketRequest)
This action is useful to determine if a bucket exists and you have permission to access it.
|
InitiateMultipartUploadResult |
AmazonS3Client.initiateMultipartUpload(InitiateMultipartUploadRequest initiateMultipartUploadRequest) |
InitiateMultipartUploadResult |
AbstractAmazonS3.initiateMultipartUpload(InitiateMultipartUploadRequest request) |
InitiateMultipartUploadResult |
AmazonS3.initiateMultipartUpload(InitiateMultipartUploadRequest request)
Initiates a multipart upload and returns an InitiateMultipartUploadResult
which contains an upload ID.
|
List<Bucket> |
AmazonS3Client.listBuckets() |
List<Bucket> |
AbstractAmazonS3.listBuckets() |
List<Bucket> |
AmazonS3.listBuckets()
Returns a list of all buckets owned by the authenticated sender of the request.
|
List<Bucket> |
AmazonS3Client.listBuckets(ListBucketsRequest listBucketsRequest) |
List<Bucket> |
AbstractAmazonS3.listBuckets(ListBucketsRequest listBucketsRequest) |
List<Bucket> |
AmazonS3.listBuckets(ListBucketsRequest listBucketsRequest)
Returns a list of all buckets owned by the authenticated sender of the request.
|
ListBucketsExtendedResponse |
AmazonS3Client.listBucketsExtended() |
ListBucketsExtendedResponse |
AmazonS3.listBucketsExtended()
Returns a list of all Cloud Object Storage (COS) S3 buckets that the
authenticated sender of the request owns.
|
ListBucketsExtendedResponse |
AmazonS3Client.listBucketsExtended(ListBucketsExtendedRequest listBucketsExtendedRequest) |
ListBucketsExtendedResponse |
AmazonS3.listBucketsExtended(ListBucketsExtendedRequest listBucketsExtendedRequest)
Returns a list of all Cloud Object Storage (COS) S3 buckets that the
authenticated sender of the request owns.
|
ListLegalHoldsResult |
AmazonS3Client.listLegalHolds(ListLegalHoldsRequest listLegalHoldsRequest) |
ListLegalHoldsResult |
AmazonS3.listLegalHolds(ListLegalHoldsRequest listLegalHoldsRequest)
Returns a list of legal holds for the specified key in the specified bucket.
|
ListLegalHoldsResult |
AmazonS3Client.listLegalHolds(String bucketName,
String key) |
ListLegalHoldsResult |
AmazonS3.listLegalHolds(String bucketName,
String key)
Returns a list of legal holds for the specified key in the specified bucket.
|
MultipartUploadListing |
AmazonS3Client.listMultipartUploads(ListMultipartUploadsRequest listMultipartUploadsRequest) |
MultipartUploadListing |
AbstractAmazonS3.listMultipartUploads(ListMultipartUploadsRequest request) |
MultipartUploadListing |
AmazonS3.listMultipartUploads(ListMultipartUploadsRequest request)
Lists in-progress multipart uploads.
|
ObjectListing |
AmazonS3Client.listNextBatchOfObjects(ListNextBatchOfObjectsRequest listNextBatchOfObjectsRequest) |
ObjectListing |
AbstractAmazonS3.listNextBatchOfObjects(ListNextBatchOfObjectsRequest listNextBatchOfObjectsRequest) |
ObjectListing |
AmazonS3.listNextBatchOfObjects(ListNextBatchOfObjectsRequest listNextBatchOfObjectsRequest)
Provides an easy way to continue a truncated object listing and retrieve
the next page of results.
|
ObjectListing |
AmazonS3Client.listNextBatchOfObjects(ObjectListing previousObjectListing) |
ObjectListing |
AbstractAmazonS3.listNextBatchOfObjects(ObjectListing previousObjectListing) |
ObjectListing |
AmazonS3.listNextBatchOfObjects(ObjectListing previousObjectListing)
Provides an easy way to continue a truncated object listing and retrieve
the next page of results.
|
VersionListing |
AbstractAmazonS3.listNextBatchOfVersions(com.ibm.cloud.objectstorage.services.s3.model.ListNextBatchOfVersionsRequest listNextBatchOfVersionsRequest) |
VersionListing |
AmazonS3.listNextBatchOfVersions(com.ibm.cloud.objectstorage.services.s3.model.ListNextBatchOfVersionsRequest listNextBatchOfVersionsRequest)
Provides an easy way to continue a truncated
VersionListing and retrieve
the next page of results. |
VersionListing |
AmazonS3Client.listNextBatchOfVersions(VersionListing previousVersionListing) |
VersionListing |
AbstractAmazonS3.listNextBatchOfVersions(VersionListing previousVersionListing) |
VersionListing |
AmazonS3.listNextBatchOfVersions(VersionListing previousVersionListing)
Provides an easy way to continue a truncated
VersionListing and retrieve
the next page of results. |
ObjectListing |
AmazonS3Client.listObjects(ListObjectsRequest listObjectsRequest) |
ObjectListing |
AbstractAmazonS3.listObjects(ListObjectsRequest listObjectsRequest) |
ObjectListing |
AmazonS3.listObjects(ListObjectsRequest listObjectsRequest)
Returns a list of summary information about the objects in the specified
bucket.
|
ObjectListing |
AmazonS3Client.listObjects(String bucketName) |
ObjectListing |
AbstractAmazonS3.listObjects(String bucketName) |
ObjectListing |
AmazonS3.listObjects(String bucketName)
Returns a list of summary information about the objects in the specified
buckets.
|
ObjectListing |
AmazonS3Client.listObjects(String bucketName,
String prefix) |
ObjectListing |
AbstractAmazonS3.listObjects(String bucketName,
String prefix) |
ObjectListing |
AmazonS3.listObjects(String bucketName,
String prefix)
Returns a list of summary information about the objects in the specified
bucket.
|
ListObjectsV2Result |
AmazonS3Client.listObjectsV2(ListObjectsV2Request listObjectsV2Request) |
ListObjectsV2Result |
AbstractAmazonS3.listObjectsV2(ListObjectsV2Request listObjectsV2Request) |
ListObjectsV2Result |
AmazonS3.listObjectsV2(ListObjectsV2Request listObjectsV2Request) |
ListObjectsV2Result |
AmazonS3Client.listObjectsV2(String bucketName) |
ListObjectsV2Result |
AbstractAmazonS3.listObjectsV2(String bucketName) |
ListObjectsV2Result |
AmazonS3.listObjectsV2(String bucketName) |
ListObjectsV2Result |
AmazonS3Client.listObjectsV2(String bucketName,
String prefix) |
ListObjectsV2Result |
AbstractAmazonS3.listObjectsV2(String bucketName,
String prefix) |
ListObjectsV2Result |
AmazonS3.listObjectsV2(String bucketName,
String prefix) |
PartListing |
AmazonS3Client.listParts(ListPartsRequest listPartsRequest) |
PartListing |
AbstractAmazonS3.listParts(ListPartsRequest request) |
PartListing |
AmazonS3.listParts(ListPartsRequest request)
Lists the parts that have been uploaded for a specific multipart upload.
|
VersionListing |
AmazonS3Client.listVersions(com.ibm.cloud.objectstorage.services.s3.model.ListVersionsRequest listVersionsRequest) |
VersionListing |
AbstractAmazonS3.listVersions(com.ibm.cloud.objectstorage.services.s3.model.ListVersionsRequest listVersionsRequest) |
VersionListing |
AmazonS3.listVersions(com.ibm.cloud.objectstorage.services.s3.model.ListVersionsRequest listVersionsRequest)
Returns a list of summary information about the versions in the specified
bucket.
|
VersionListing |
AmazonS3Client.listVersions(String bucketName,
String prefix) |
VersionListing |
AbstractAmazonS3.listVersions(String bucketName,
String prefix) |
VersionListing |
AmazonS3.listVersions(String bucketName,
String prefix)
Returns a list of summary information about the versions in the specified
bucket.
|
VersionListing |
AmazonS3Client.listVersions(String bucketName,
String prefix,
String keyMarker,
String versionIdMarker,
String delimiter,
Integer maxKeys) |
VersionListing |
AbstractAmazonS3.listVersions(String bucketName,
String prefix,
String keyMarker,
String versionIdMarker,
String delimiter,
Integer maxResults) |
VersionListing |
AmazonS3.listVersions(String bucketName,
String prefix,
String keyMarker,
String versionIdMarker,
String delimiter,
Integer maxResults)
Returns a list of summary information about the versions in the specified
bucket.
|
PutObjectResult |
AmazonS3Client.putObject(PutObjectRequest putObjectRequest) |
PutObjectResult |
AbstractAmazonS3.putObject(PutObjectRequest putObjectRequest) |
PutObjectResult |
AmazonS3.putObject(PutObjectRequest putObjectRequest)
Uploads a new object to the specified Amazon S3 bucket.
|
PutObjectResult |
AmazonS3Client.putObject(String bucketName,
String key,
File file) |
PutObjectResult |
AbstractAmazonS3.putObject(String bucketName,
String key,
File file) |
PutObjectResult |
AmazonS3.putObject(String bucketName,
String key,
File file)
Uploads the specified file to Amazon S3 under the specified bucket and
key name.
|
PutObjectResult |
AmazonS3Client.putObject(String bucketName,
String key,
InputStream input,
ObjectMetadata metadata) |
PutObjectResult |
AbstractAmazonS3.putObject(String bucketName,
String key,
InputStream input,
ObjectMetadata metadata) |
PutObjectResult |
AmazonS3.putObject(String bucketName,
String key,
InputStream input,
ObjectMetadata metadata)
Uploads the specified input stream and object metadata to Amazon S3 under
the specified bucket and key name.
|
PutObjectResult |
AmazonS3Client.putObject(String bucketName,
String key,
String content) |
PutObjectResult |
AbstractAmazonS3.putObject(String bucketName,
String key,
String content) |
PutObjectResult |
AmazonS3.putObject(String bucketName,
String key,
String content)
Encodes a String into the contents of an S3 object.
|
void |
AmazonS3Client.setBucketAcl(SetBucketAclRequest setBucketAclRequest) |
void |
AbstractAmazonS3.setBucketAcl(SetBucketAclRequest setBucketAclRequest) |
void |
AmazonS3.setBucketAcl(SetBucketAclRequest setBucketAclRequest)
Sets the
AccessControlList for the specified Amazon S3 bucket. |
void |
AmazonS3Client.setBucketAcl(String bucketName,
AccessControlList acl) |
void |
AbstractAmazonS3.setBucketAcl(String bucketName,
AccessControlList acl) |
void |
AmazonS3.setBucketAcl(String bucketName,
AccessControlList acl)
Sets the
AccessControlList for the specified Amazon S3 bucket. |
void |
AmazonS3Client.setBucketAcl(String bucketName,
CannedAccessControlList cannedAcl) |
void |
AbstractAmazonS3.setBucketAcl(String bucketName,
CannedAccessControlList cannedAcl) |
void |
AmazonS3.setBucketAcl(String bucketName,
CannedAccessControlList acl)
Sets the
CannedAccessControlList for the specified Amazon S3 bucket using one of
the pre-configured CannedAccessControlLists. |
void |
AmazonS3Client.setBucketAcl(String bucketName,
CannedAccessControlList cannedAcl,
RequestMetricCollector requestMetricCollector)
Same as
AmazonS3Client.setBucketAcl(String, CannedAccessControlList)
but allows specifying a request metric collector. |
void |
AmazonS3Client.setBucketProtection(String bucketName,
BucketProtectionConfiguration protectionConfiguration) |
void |
AmazonS3.setBucketProtection(String bucketName,
BucketProtectionConfiguration protectionConfiguration) |
void |
AmazonS3Client.setBucketProtectionConfiguration(SetBucketProtectionConfigurationRequest setBucketProtectionConfigurationRequest) |
void |
AmazonS3.setBucketProtectionConfiguration(SetBucketProtectionConfigurationRequest setBucketProtectionRequest)
Set the protection configuration for the specified bucket.
|
void |
AmazonS3Client.setBucketReplicationConfiguration(SetBucketReplicationConfigurationRequest setBucketReplicationConfigurationRequest) |
void |
AbstractAmazonS3.setBucketReplicationConfiguration(SetBucketReplicationConfigurationRequest setBucketReplicationConfigurationRequest) |
void |
AmazonS3.setBucketReplicationConfiguration(SetBucketReplicationConfigurationRequest setBucketReplicationConfigurationRequest)
Creates a replication configuration or replaces an existing one.
|
void |
AmazonS3Client.setBucketReplicationConfiguration(String bucketName,
BucketReplicationConfiguration configuration) |
void |
AbstractAmazonS3.setBucketReplicationConfiguration(String bucketName,
BucketReplicationConfiguration configuration) |
void |
AmazonS3.setBucketReplicationConfiguration(String bucketName,
BucketReplicationConfiguration configuration)
Creates a replication configuration or replaces an existing one.
|
void |
AmazonS3Client.setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest setBucketVersioningConfigurationRequest) |
void |
AbstractAmazonS3.setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest setBucketVersioningConfigurationRequest) |
void |
AmazonS3.setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest setBucketVersioningConfigurationRequest)
Sets the versioning configuration for the specified bucket.
|
void |
AmazonS3Client.setBucketWebsiteConfiguration(SetBucketWebsiteConfigurationRequest setBucketWebsiteConfigurationRequest) |
void |
AbstractAmazonS3.setBucketWebsiteConfiguration(SetBucketWebsiteConfigurationRequest setBucketWebsiteConfigurationRequest) |
void |
AmazonS3.setBucketWebsiteConfiguration(SetBucketWebsiteConfigurationRequest setBucketWebsiteConfigurationRequest)
Sets the website configuration for the specified bucket.
|
void |
AmazonS3Client.setBucketWebsiteConfiguration(String bucketName,
BucketWebsiteConfiguration configuration) |
void |
AbstractAmazonS3.setBucketWebsiteConfiguration(String bucketName,
BucketWebsiteConfiguration configuration) |
void |
AmazonS3.setBucketWebsiteConfiguration(String bucketName,
BucketWebsiteConfiguration configuration)
Sets the website configuration for the specified bucket.
|
void |
AmazonS3Client.setObjectAcl(SetObjectAclRequest setObjectAclRequest) |
void |
AbstractAmazonS3.setObjectAcl(SetObjectAclRequest setObjectAclRequest) |
void |
AmazonS3.setObjectAcl(SetObjectAclRequest setObjectAclRequest)
Sets the
AccessControlList for the specified Amazon S3 object
with an optional version ID. |
void |
AmazonS3Client.setObjectAcl(String bucketName,
String key,
AccessControlList acl) |
void |
AbstractAmazonS3.setObjectAcl(String bucketName,
String key,
AccessControlList acl) |
void |
AmazonS3.setObjectAcl(String bucketName,
String key,
AccessControlList acl)
Sets the
AccessControlList for the specified object in Amazon S3. |
void |
AmazonS3Client.setObjectAcl(String bucketName,
String key,
CannedAccessControlList acl) |
void |
AbstractAmazonS3.setObjectAcl(String bucketName,
String key,
CannedAccessControlList acl) |
void |
AmazonS3.setObjectAcl(String bucketName,
String key,
CannedAccessControlList acl)
Sets the
CannedAccessControlList for the specified object in
Amazon S3 using one
of the pre-configured CannedAccessControlLists. |
void |
AmazonS3Client.setObjectAcl(String bucketName,
String key,
String versionId,
AccessControlList acl) |
void |
AbstractAmazonS3.setObjectAcl(String bucketName,
String key,
String versionId,
AccessControlList acl) |
void |
AmazonS3.setObjectAcl(String bucketName,
String key,
String versionId,
AccessControlList acl)
Sets the
CannedAccessControlList for the specified object
with the specified version in Amazon S3. |
void |
AmazonS3Client.setObjectAcl(String bucketName,
String key,
String versionId,
AccessControlList acl,
RequestMetricCollector requestMetricCollector)
Same as
AmazonS3Client.setObjectAcl(String, String, String, AccessControlList)
but allows specifying a request metric collector. |
void |
AmazonS3Client.setObjectAcl(String bucketName,
String key,
String versionId,
CannedAccessControlList acl) |
void |
AbstractAmazonS3.setObjectAcl(String bucketName,
String key,
String versionId,
CannedAccessControlList acl) |
void |
AmazonS3.setObjectAcl(String bucketName,
String key,
String versionId,
CannedAccessControlList acl)
Sets the
CannedAccessControlList for the specified object with the specified
version ID in Amazon S3 using one of the pre-configured
CannedAccessControlLists. |
void |
AmazonS3Client.setObjectRedirectLocation(String bucketName,
String key,
String newRedirectLocation) |
void |
AbstractAmazonS3.setObjectRedirectLocation(String bucketName,
String key,
String newRedirectLocation) |
void |
AmazonS3.setObjectRedirectLocation(String bucketName,
String key,
String newRedirectLocation)
Deprecated.
this operation will not retain the ACL's or SSE parameters
associated with the given Amazon S3 object. Use
AmazonS3.copyObject(CopyObjectRequest)
instead. |
UploadPartResult |
AmazonS3Client.uploadPart(UploadPartRequest uploadPartRequest) |
UploadPartResult |
AbstractAmazonS3.uploadPart(UploadPartRequest request) |
UploadPartResult |
AmazonS3.uploadPart(UploadPartRequest request)
Uploads a part in a multipart upload.
|
| Modifier and Type | Method and Description |
|---|---|
void |
S3QueryStringSigner.sign(SignableRequest<?> request,
AWSCredentials credentials) |
| Modifier and Type | Method and Description |
|---|---|
CompleteMultipartUploadResult |
CryptoModuleDispatcher.completeMultipartUploadSecurely(CompleteMultipartUploadRequest req) |
InitiateMultipartUploadResult |
CryptoModuleDispatcher.initiateMultipartUploadSecurely(InitiateMultipartUploadRequest req) |
UploadPartResult |
CryptoModuleDispatcher.uploadPartSecurely(UploadPartRequest req) |
| Modifier and Type | Class and Description |
|---|---|
class |
AmazonS3Exception
Provides an extension of the AmazonServiceException
for errors reported by Amazon S3 while
processing a request.
|
class |
MultiObjectDeleteException
Exception for partial or total failure of the multi-object delete API,
including the errors that occurred.
|
| Modifier and Type | Class and Description |
|---|---|
class |
FileLockException
Failed to lock a file.
|
class |
PauseException
Failed to complete a pause operation.
|
| Modifier and Type | Class and Description |
|---|---|
class |
WaiterTimedOutException |
class |
WaiterUnrecoverableException |
Copyright © 2024. All rights reserved.