| Class | Description |
|---|---|
| AbortIncompleteMultipartUpload |
Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently
removing all parts of the upload.
|
| AbortMultipartUploadRequest | |
| AbortMultipartUploadResponse | |
| AccelerateConfiguration |
Configures the transfer acceleration state for an Amazon S3 bucket.
|
| AccessControlPolicy |
Contains the elements that set the ACL permissions for an object per grantee.
|
| AccessControlTranslation |
A container for information about access control for replicas.
|
| AddLegalHoldRequest |
Request object representing the parameters required to add a legal hold on an object
in IBM Cloud Object Storage.
|
| AnalyticsAndOperator |
A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.
|
| AnalyticsConfiguration |
Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
|
| AnalyticsExportDestination |
Where to publish the analytics results.
|
| AnalyticsFilter |
The filter used to describe a set of objects for analyses.
|
| AnalyticsS3BucketDestination |
Contains information about where to publish the analytics results.
|
| Bucket |
In terms of implementation, a Bucket is a resource.
|
| BucketInfo |
Specifies the information about the bucket that will be created.
|
| BucketLifecycleConfiguration |
Specifies the lifecycle configuration for objects in an Amazon S3 bucket.
|
| BucketLoggingStatus |
Container for logging status information.
|
| BucketProtectionConfiguration |
Represents the protection configuration for a bucket.
|
| BucketProtectionResponse | |
| Checksum |
Contains all the possible checksum or digest values for an object.
|
| CommonPrefix |
Container for all (if there are any) keys between Prefix and the next occurrence of the string specified by a
delimiter.
|
| CompletedMultipartUpload |
The container for the completed multipart upload details.
|
| CompletedPart |
Details of the parts that were uploaded.
|
| CompleteMultipartUploadRequest | |
| CompleteMultipartUploadResponse | |
| Condition |
A container for describing a condition that must be met for the specified redirect to apply.
|
| ContentList | |
| ContinuationEvent |
|
| ContinuationEvent.BuilderImpl | |
| CopyObjectRequest | |
| CopyObjectResponse | |
| CopyObjectResult |
Container for all response elements.
|
| CopyPartResult |
Container for all response elements.
|
| CORSConfiguration |
Describes the cross-origin access configuration for objects in an Amazon S3 bucket.
|
| CORSRule |
Specifies a cross-origin access rule for an Amazon S3 bucket.
|
| CreateBucketConfiguration |
The configuration information for the bucket.
|
| CreateBucketMetadataTableConfigurationRequest | |
| CreateBucketMetadataTableConfigurationResponse | |
| CreateBucketRequest | |
| CreateBucketResponse | |
| CreateMultipartUploadRequest | |
| CreateMultipartUploadResponse | |
| CreateSessionRequest | |
| CreateSessionResponse | |
| CSVInput |
Describes how an uncompressed comma-separated values (CSV)-formatted input object is formatted.
|
| CSVOutput |
Describes how uncompressed comma-separated values (CSV)-formatted results are formatted.
|
| DefaultRetention |
The container element for optionally specifying the default Object Lock retention settings for new objects placed in
the specified bucket.
|
| Delete |
Container for the objects to delete.
|
| DeleteBucketAnalyticsConfigurationRequest | |
| DeleteBucketAnalyticsConfigurationResponse | |
| DeleteBucketCorsRequest | |
| DeleteBucketCorsResponse | |
| DeleteBucketEncryptionRequest | |
| DeleteBucketEncryptionResponse | |
| DeleteBucketIntelligentTieringConfigurationRequest | |
| DeleteBucketIntelligentTieringConfigurationResponse | |
| DeleteBucketInventoryConfigurationRequest | |
| DeleteBucketInventoryConfigurationResponse | |
| DeleteBucketLifecycleRequest | |
| DeleteBucketLifecycleResponse | |
| DeleteBucketMetadataTableConfigurationRequest | |
| DeleteBucketMetadataTableConfigurationResponse | |
| DeleteBucketMetricsConfigurationRequest | |
| DeleteBucketMetricsConfigurationResponse | |
| DeleteBucketOwnershipControlsRequest | |
| DeleteBucketOwnershipControlsResponse | |
| DeleteBucketPolicyRequest | |
| DeleteBucketPolicyResponse | |
| DeleteBucketReplicationRequest | |
| DeleteBucketReplicationResponse | |
| DeleteBucketRequest | |
| DeleteBucketResponse | |
| DeleteBucketTaggingRequest | |
| DeleteBucketTaggingResponse | |
| DeleteBucketWebsiteRequest | |
| DeleteBucketWebsiteResponse | |
| DeletedObject |
Information about the deleted object.
|
| DeleteLegalHoldRequest |
Request object containing all the options for deleting a legal hold from an object.
|
| DeleteMarkerEntry |
Information about the delete marker.
|
| DeleteMarkerReplication |
Specifies whether Amazon S3 replicates delete markers.
|
| DeleteObjectRequest | |
| DeleteObjectResponse | |
| DeleteObjectsRequest | |
| DeleteObjectsResponse | |
| DeleteObjectTaggingRequest | |
| DeleteObjectTaggingResponse | |
| DeletePublicAccessBlockRequest | |
| DeletePublicAccessBlockResponse | |
| Destination |
Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3
Replication Time Control (S3 RTC).
|
| Encryption |
Contains the type of server-side encryption used.
|
| EncryptionConfiguration |
Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.
|
| EncryptionType |
A set of attributes primarily used to define the encryption type of an s3 request.
|
| EndEvent |
A message that indicates the request is complete and no more messages will be sent.
|
| EndEvent.BuilderImpl | |
| ErrorDetails |
If the
CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the
table, this structure contains the error code and error message. |
| ErrorDocument |
The error information.
|
| EventBridgeConfiguration |
A container for specifying the configuration for Amazon EventBridge.
|
| ExistingObjectReplication |
Optional configuration to replicate existing source bucket objects.
|
| ExtendObjectRetentionRequest |
IBM specific: Request object containing all the options for extending the retention period of a protected object.
|
| FilterRule |
Specifies the Amazon S3 object key name to filter on.
|
| GetBucketAccelerateConfigurationRequest | |
| GetBucketAccelerateConfigurationResponse | |
| GetBucketAclRequest | |
| GetBucketAclResponse | |
| GetBucketAnalyticsConfigurationRequest | |
| GetBucketAnalyticsConfigurationResponse | |
| GetBucketCorsRequest | |
| GetBucketCorsResponse | |
| GetBucketEncryptionRequest | |
| GetBucketEncryptionResponse | |
| GetBucketIntelligentTieringConfigurationRequest | |
| GetBucketIntelligentTieringConfigurationResponse | |
| GetBucketInventoryConfigurationRequest | |
| GetBucketInventoryConfigurationResponse | |
| GetBucketLifecycleConfigurationRequest | |
| GetBucketLifecycleConfigurationResponse | |
| GetBucketLocationRequest | |
| GetBucketLocationResponse | |
| GetBucketLoggingRequest | |
| GetBucketLoggingResponse | |
| GetBucketMetadataTableConfigurationRequest | |
| GetBucketMetadataTableConfigurationResponse | |
| GetBucketMetadataTableConfigurationResult |
The metadata table configuration for a general purpose bucket.
|
| GetBucketMetricsConfigurationRequest | |
| GetBucketMetricsConfigurationResponse | |
| GetBucketNotificationConfigurationRequest | |
| GetBucketNotificationConfigurationResponse |
A container for specifying the notification configuration of the bucket.
|
| GetBucketOwnershipControlsRequest | |
| GetBucketOwnershipControlsResponse | |
| GetBucketPolicyRequest | |
| GetBucketPolicyResponse | |
| GetBucketPolicyStatusRequest | |
| GetBucketPolicyStatusResponse | |
| GetBucketProtectionConfigurationRequest |
Request object for the parameters to get a bucket's protection configuration.
|
| GetBucketProtectionConfigurationResponse | |
| GetBucketReplicationRequest | |
| GetBucketReplicationResponse | |
| GetBucketRequestPaymentRequest | |
| GetBucketRequestPaymentResponse | |
| GetBucketTaggingRequest | |
| GetBucketTaggingResponse | |
| GetBucketVersioningRequest | |
| GetBucketVersioningResponse | |
| GetBucketWebsiteRequest | |
| GetBucketWebsiteResponse | |
| GetObjectAclRequest | |
| GetObjectAclResponse | |
| GetObjectAttributesParts |
A collection of parts associated with a multipart upload.
|
| GetObjectAttributesRequest | |
| GetObjectAttributesResponse | |
| GetObjectLegalHoldRequest | |
| GetObjectLegalHoldResponse | |
| GetObjectLockConfigurationRequest | |
| GetObjectLockConfigurationResponse | |
| GetObjectRequest | |
| GetObjectResponse | |
| GetObjectRetentionRequest | |
| GetObjectRetentionResponse | |
| GetObjectTaggingRequest | |
| GetObjectTaggingResponse | |
| GetObjectTorrentRequest | |
| GetObjectTorrentResponse | |
| GetPublicAccessBlockRequest | |
| GetPublicAccessBlockResponse | |
| GetUrlRequest |
Request to generate a URL representing an object in Amazon S3.
|
| GlacierJobParameters |
Container for S3 Glacier job parameters.
|
| Grant |
Container for grant information.
|
| Grantee |
Container for the person being granted permissions.
|
| HeadBucketRequest | |
| HeadBucketResponse | |
| HeadObjectRequest | |
| HeadObjectResponse | |
| IBMAclGrantee |
This is a helper class provides predefined group grantees for commonly used ACLs
|
| IndexDocument |
Container for the
Suffix element. |
| Initiator |
Container element that identifies who initiated the multipart upload.
|
| InputSerialization |
Describes the serialization format of the object.
|
| IntelligentTieringAndOperator |
A container for specifying S3 Intelligent-Tiering filters.
|
| IntelligentTieringConfiguration |
Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.
|
| IntelligentTieringFilter |
The
Filter is used to identify objects that the S3 Intelligent-Tiering configuration applies to. |
| InventoryConfiguration |
Specifies the inventory configuration for an Amazon S3 bucket.
|
| InventoryDestination |
Specifies the inventory configuration for an Amazon S3 bucket.
|
| InventoryEncryption |
Contains the type of server-side encryption used to encrypt the inventory results.
|
| InventoryFilter |
Specifies an inventory filter.
|
| InventoryS3BucketDestination |
Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are
published.
|
| InventorySchedule |
Specifies the schedule for generating inventory results.
|
| JSONInput |
Specifies JSON as object's input serialization format.
|
| JSONOutput |
Specifies JSON as request's output serialization format.
|
| LambdaFunctionConfiguration |
A container for specifying the configuration for Lambda notifications.
|
| LegalHold | |
| LifecycleExpiration |
Container for the expiration for the lifecycle of the object.
|
| LifecycleRule |
A lifecycle rule for individual objects in an Amazon S3 bucket.
|
| LifecycleRuleAndOperator |
This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates.
|
| LifecycleRuleFilter |
The
Filter is used to identify objects that a Lifecycle Rule applies to. |
| ListBucketAnalyticsConfigurationsRequest | |
| ListBucketAnalyticsConfigurationsResponse | |
| ListBucketIntelligentTieringConfigurationsRequest | |
| ListBucketIntelligentTieringConfigurationsResponse | |
| ListBucketInventoryConfigurationsRequest | |
| ListBucketInventoryConfigurationsResponse | |
| ListBucketMetricsConfigurationsRequest | |
| ListBucketMetricsConfigurationsResponse | |
| ListBucketReplicationFailuresRequest | |
| ListBucketReplicationFailuresResponse | |
| ListBucketsExtendedRequest |
Request to retrieve a listing of buckets from Cloud Object Storage.
|
| ListBucketsExtendedResponse | |
| ListBucketsRequest | |
| ListBucketsResponse | |
| ListDirectoryBucketsRequest | |
| ListDirectoryBucketsResponse | |
| ListLegalHoldsRequest |
Request object containing all the options for listing legal holds
associated with a specific object in a Cloud Object Storage (COS) bucket.
|
| ListLegalHoldsResponse |
Response object returned from
S3Client.listLegalHolds(ListLegalHoldsRequest)
operation. |
| ListMultipartUploadsRequest | |
| ListMultipartUploadsResponse | |
| ListObjectsRequest | |
| ListObjectsResponse | |
| ListObjectsV2Request | |
| ListObjectsV2Response | |
| ListObjectVersionsRequest | |
| ListObjectVersionsResponse | |
| ListPartsRequest | |
| ListPartsResponse | |
| LocationInfo |
Specifies the location where the bucket will be created.
|
| LoggingEnabled |
Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket.
|
| MetadataEntry |
A metadata key-value pair to store with an object.
|
| MetadataTableConfiguration |
The metadata table configuration for a general purpose bucket.
|
| MetadataTableConfigurationResult |
The metadata table configuration for a general purpose bucket.
|
| Metrics |
A container specifying replication metrics-related settings enabling replication metrics and events.
|
| MetricsAndOperator |
A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.
|
| MetricsConfiguration |
Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from
an Amazon S3 bucket.
|
| MetricsFilter |
Specifies a metrics configuration filter.
|
| MultipartUpload |
Container for the
MultipartUpload for the Amazon S3 object. |
| NoncurrentVersionExpiration |
Specifies when noncurrent object versions expire.
|
| NoncurrentVersionTransition |
Container for the transition rule that describes when noncurrent objects transition to the
STANDARD_IA,
ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, or
DEEP_ARCHIVE storage class. |
| NotificationConfiguration |
A container for specifying the notification configuration of the bucket.
|
| NotificationConfigurationFilter |
Specifies object key name filtering rules.
|
| ObjectIdentifier |
Object Identifier is unique value to identify objects.
|
| ObjectLockConfiguration |
The container element for Object Lock configuration parameters.
|
| ObjectLockLegalHold |
A legal hold configuration for an object.
|
| ObjectLockRetention |
A Retention configuration for an object.
|
| ObjectLockRule |
The container element for an Object Lock rule.
|
| ObjectPart |
A container for elements related to an individual part.
|
| ObjectSyncAttempted | |
| ObjectVersion |
The version of an object.
|
| OutputLocation |
Describes the location where the restore job's output is stored.
|
| OutputSerialization |
Describes how results of the Select job are serialized.
|
| Owner |
Container for the owner's display name and ID.
|
| OwnershipControls |
The container element for a bucket's ownership controls.
|
| OwnershipControlsRule |
The container element for an ownership control rule.
|
| ParquetInput |
Container for Parquet.
|
| Part |
Container for elements related to a part.
|
| PartitionedPrefix |
Amazon S3 keys for log objects are partitioned in the following format:
|
| PolicyStatus |
The container element for a bucket's policy status.
|
| Progress |
This data type contains information about progress of an operation.
|
| ProgressEvent |
This data type contains information about the progress event of an operation.
|
| ProgressEvent.BuilderImpl | |
| PublicAccessBlockConfiguration |
The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket.
|
| PutBucketAccelerateConfigurationRequest | |
| PutBucketAccelerateConfigurationResponse | |
| PutBucketAclRequest | |
| PutBucketAclResponse | |
| PutBucketAnalyticsConfigurationRequest | |
| PutBucketAnalyticsConfigurationResponse | |
| PutBucketCorsRequest | |
| PutBucketCorsResponse | |
| PutBucketEncryptionRequest | |
| PutBucketEncryptionResponse | |
| PutBucketIntelligentTieringConfigurationRequest | |
| PutBucketIntelligentTieringConfigurationResponse | |
| PutBucketInventoryConfigurationRequest | |
| PutBucketInventoryConfigurationResponse | |
| PutBucketLifecycleConfigurationRequest | |
| PutBucketLifecycleConfigurationResponse | |
| PutBucketLoggingRequest | |
| PutBucketLoggingResponse | |
| PutBucketMetricsConfigurationRequest | |
| PutBucketMetricsConfigurationResponse | |
| PutBucketNotificationConfigurationRequest | |
| PutBucketNotificationConfigurationResponse | |
| PutBucketOwnershipControlsRequest | |
| PutBucketOwnershipControlsResponse | |
| PutBucketPolicyRequest | |
| PutBucketPolicyResponse | |
| PutBucketProtectionConfigurationRequest |
Request object to set protection configuration to a bucket.
|
| PutBucketReplicationReattemptRequest | |
| PutBucketReplicationRequest | |
| PutBucketReplicationResponse | |
| PutBucketRequestPaymentRequest | |
| PutBucketRequestPaymentResponse | |
| PutBucketTaggingRequest | |
| PutBucketTaggingResponse | |
| PutBucketVersioningRequest | |
| PutBucketVersioningResponse | |
| PutBucketWebsiteRequest | |
| PutBucketWebsiteResponse | |
| PutObjectAclRequest | |
| PutObjectAclResponse | |
| PutObjectLegalHoldRequest | |
| PutObjectLegalHoldResponse | |
| PutObjectLockConfigurationRequest | |
| PutObjectLockConfigurationResponse | |
| PutObjectRequest | |
| PutObjectResponse | |
| PutObjectRetentionRequest | |
| PutObjectRetentionResponse | |
| PutObjectTaggingRequest | |
| PutObjectTaggingResponse | |
| PutPublicAccessBlockRequest | |
| PutPublicAccessBlockResponse | |
| QueueConfiguration |
Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon
S3 detects specified events.
|
| RecordsEvent |
The container for the records event.
|
| RecordsEvent.BuilderImpl | |
| Redirect |
Specifies how requests are redirected.
|
| RedirectAllRequestsTo |
Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.
|
| ReplicaModifications |
A filter that you can specify for selection for modifications on replicas.
|
| ReplicationConfiguration |
A container for replication rules.
|
| ReplicationRule |
Specifies which Amazon S3 objects to replicate and where to store the replicas.
|
| ReplicationRuleAndOperator |
A container for specifying rule filters.
|
| ReplicationRuleFilter |
A filter that identifies the subset of objects to which the replication rule applies.
|
| ReplicationTime |
A container specifying S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is enabled
and the time when all objects and operations on objects must be replicated.
|
| ReplicationTimeValue |
A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics
EventThreshold. |
| RequestPaymentConfiguration |
Container for Payer.
|
| RequestProgress |
Container for specifying if periodic
QueryProgress messages should be sent. |
| RestoreObjectRequest | |
| RestoreObjectResponse | |
| RestoreRequest |
Container for restore job parameters.
|
| RestoreStatus |
Specifies the restoration status of an object.
|
| Retention | |
| RoutingRule |
Specifies the redirect behavior and when a redirect is applied.
|
| S3Error |
Container for all error elements.
|
| S3Exception.BuilderImpl | |
| S3KeyFilter |
A container for object key name prefix and suffix filtering rules.
|
| S3Location |
Describes an Amazon S3 location that will receive the results of the restore request.
|
| S3Object |
An object consists of data and its descriptive metadata.
|
| S3Request | |
| S3Request.BuilderImpl | |
| S3Response | |
| S3Response.BuilderImpl | |
| S3ResponseMetadata | |
| S3TablesDestination |
The destination information for the metadata table configuration.
|
| S3TablesDestinationResult |
The destination information for the metadata table configuration.
|
| ScanRange |
Specifies the byte range of the object to get the records from.
|
| SelectObjectContentRequest |
|
| SelectObjectContentResponse | |
| SelectParameters |
|
| ServerSideEncryptionByDefault |
Describes the default server-side encryption to apply to new objects in the bucket.
|
| ServerSideEncryptionConfiguration |
Specifies the default server-side-encryption configuration.
|
| ServerSideEncryptionRule |
Specifies the default server-side encryption configuration.
|
| SessionCredentials |
The established temporary security credentials of the session.
|
| SimplePrefix |
To use simple format for S3 keys for log objects, set SimplePrefix to an empty object.
|
| SourceSelectionCriteria |
A container that describes additional filters for identifying the source objects that you want to replicate.
|
| SSEKMS |
Specifies the use of SSE-KMS to encrypt delivered inventory reports.
|
| SseKmsEncryptedObjects |
A container for filter information for the selection of S3 objects encrypted with Amazon Web Services KMS.
|
| SSES3 |
Specifies the use of SSE-S3 to encrypt delivered inventory reports.
|
| Stats |
Container for the stats details.
|
| StatsEvent |
Container for the Stats Event.
|
| StatsEvent.BuilderImpl | |
| StorageClassAnalysis |
Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between
different storage classes for an Amazon S3 bucket.
|
| StorageClassAnalysisDataExport |
Container for data related to the storage class analysis for an Amazon S3 bucket for export.
|
| Tag |
A container of a key value name pair.
|
| Tagging |
Container for
TagSet elements. |
| TargetGrant |
Container for granting information.
|
| TargetObjectKeyFormat |
Amazon S3 key format for log objects.
|
| Tiering |
The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the
most cost-effective storage access tier, without additional operational overhead.
|
| TopicConfiguration |
A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service
(Amazon SNS) topic when Amazon S3 detects specified events.
|
| Transition |
Specifies when an object transitions to a specified storage class.
|
| UploadPartCopyRequest | |
| UploadPartCopyResponse | |
| UploadPartRequest | |
| UploadPartResponse | |
| VersioningConfiguration |
Describes the versioning state of an Amazon S3 bucket.
|
| VoidHttpResponse |
A response class representing void response
|
| WebsiteConfiguration |
Specifies website configuration parameters for an Amazon S3 bucket.
|
| WriteGetObjectResponseRequest | |
| WriteGetObjectResponseResponse |
| Exception | Description |
|---|---|
| BucketAlreadyExistsException |
The requested bucket name is not available.
|
| BucketAlreadyOwnedByYouException |
The bucket you tried to create already exists, and you own it.
|
| EncryptionTypeMismatchException |
The existing object was created with a different encryption type.
|
| InvalidObjectStateException |
Object is archived and inaccessible until restored.
|
| InvalidRequestException |
You may receive this error in multiple cases.
|
| InvalidWriteOffsetException |
The write offset value that you specified does not match the current object size.
|
| NoSuchBucketException |
The specified bucket does not exist.
|
| NoSuchKeyException |
The specified key does not exist.
|
| NoSuchUploadException |
The specified multipart upload does not exist.
|
| ObjectAlreadyInActiveTierErrorException |
This action is not allowed against this storage tier.
|
| ObjectNotInActiveTierErrorException |
The source object of the COPY action is not in the active tier and is only stored in Amazon S3 Glacier.
|
| S3Exception | |
| TooManyPartsException |
You have attempted to add more parts than the maximum of 10000 that are allowed for this object.
|
Copyright © 2026. All rights reserved.