| Modifier and Type | Class and Description |
|---|---|
class |
AwsRequest
Base class for all AWS Service requests.
|
class |
AwsResponse
Base class for all AWS Service responses.
|
| Modifier and Type | Method and Description |
|---|---|
SdkPojo |
EventStreamTaggedUnionPojoSupplier.apply(SdkHttpFullResponse sdkHttpFullResponse) |
| Modifier and Type | Method and Description |
|---|---|
EventStreamTaggedUnionPojoSupplier.Builder |
EventStreamTaggedUnionPojoSupplier.Builder.defaultSdkPojoSupplier(Supplier<SdkPojo> defaultPojoSupplier)
Registers the default
SdkPojo supplier. |
EventStreamTaggedUnionPojoSupplier.Builder |
EventStreamTaggedUnionPojoSupplier.Builder.putSdkPojoSupplier(String type,
Supplier<SdkPojo> pojoSupplier)
|
| Modifier and Type | Interface and Description |
|---|---|
static interface |
AwsServiceException.Builder |
| Modifier and Type | Class and Description |
|---|---|
class |
AwsServiceException
Extension of
SdkServiceException that represents an error response returned
by an Amazon web service. |
protected static class |
AwsServiceException.BuilderImpl |
| Modifier and Type | Class and Description |
|---|---|
class |
SdkPojoBuilder<T extends SdkPojo>
A builder for an immutable
SdkPojo with no fields. |
| Modifier and Type | Class and Description |
|---|---|
class |
SdkPojoBuilder<T extends SdkPojo>
A builder for an immutable
SdkPojo with no fields. |
class |
SdkRequest
The base class for all SDK requests.
|
class |
SdkResponse
The base class for all SDK responses.
|
| Modifier and Type | Method and Description |
|---|---|
Supplier<SdkPojo> |
SdkField.constructor() |
| Modifier and Type | Method and Description |
|---|---|
SdkField.Builder<TypeT> |
SdkField.Builder.constructor(Supplier<SdkPojo> constructor)
Sets a
Supplier which will create a new MUTABLE instance of the POJO. |
| Modifier and Type | Interface and Description |
|---|---|
static interface |
SdkServiceException.Builder |
| Modifier and Type | Class and Description |
|---|---|
class |
SdkServiceException
Extension of SdkException that represents an error response returned by
the requested downstream service.
|
protected static class |
SdkServiceException.BuilderImpl |
| Modifier and Type | Class and Description |
|---|---|
class |
VoidSdkResponse
Dummy implementation of
SdkResponse. |
static class |
VoidSdkResponse.Builder |
| Modifier and Type | Field and Description |
|---|---|
static MarshallingType<SdkPojo> |
MarshallingType.SDK_POJO |
| Modifier and Type | Method and Description |
|---|---|
Supplier<SdkPojo> |
ExceptionMetadata.exceptionBuilderSupplier()
Returns the Supplier to get the builder class for the exception.
|
| Modifier and Type | Method and Description |
|---|---|
MarshalledT |
ProtocolMarshaller.marshall(SdkPojo pojo) |
| Modifier and Type | Method and Description |
|---|---|
ExceptionMetadata.Builder |
ExceptionMetadata.Builder.exceptionBuilderSupplier(Supplier<SdkPojo> exceptionBuilderSupplier) |
| Modifier and Type | Method and Description |
|---|---|
<T extends SdkPojo> |
BaseAwsJsonProtocolFactory.createResponseHandler(JsonOperationMetadata operationMetadata,
Function<SdkHttpFullResponse,SdkPojo> pojoSupplier)
Creates a new response handler with the given
JsonOperationMetadata and a supplier of the POJO response
type. |
<T extends SdkPojo> |
BaseAwsJsonProtocolFactory.createResponseHandler(JsonOperationMetadata operationMetadata,
Supplier<SdkPojo> pojoSupplier)
Creates a new response handler with the given
JsonOperationMetadata and a supplier of the POJO response
type. |
| Modifier and Type | Method and Description |
|---|---|
<T extends SdkPojo> |
BaseAwsJsonProtocolFactory.createResponseHandler(JsonOperationMetadata operationMetadata,
Function<SdkHttpFullResponse,SdkPojo> pojoSupplier)
Creates a new response handler with the given
JsonOperationMetadata and a supplier of the POJO response
type. |
<T extends SdkPojo> |
BaseAwsJsonProtocolFactory.createResponseHandler(JsonOperationMetadata operationMetadata,
Supplier<SdkPojo> pojoSupplier)
Creates a new response handler with the given
JsonOperationMetadata and a supplier of the POJO response
type. |
SubclassT |
BaseAwsJsonProtocolFactory.Builder.defaultServiceExceptionSupplier(Supplier<SdkPojo> exceptionBuilderSupplier)
A supplier for the services base exception builder.
|
| Modifier and Type | Field and Description |
|---|---|
static JsonMarshaller<SdkPojo> |
SimpleTypeJsonMarshaller.SDK_POJO |
| Modifier and Type | Method and Description |
|---|---|
SdkHttpFullRequest |
NullAsEmptyBodyProtocolRequestMarshaller.marshall(SdkPojo pojo) |
SdkHttpFullRequest |
JsonProtocolMarshaller.marshall(SdkPojo pojo) |
| Modifier and Type | Class and Description |
|---|---|
class |
JsonResponseHandler<T extends SdkPojo>
Default implementation of HttpResponseHandler that handles a successful response from a
service and unmarshalls the result using a JSON unmarshaller.
|
| Modifier and Type | Method and Description |
|---|---|
<TypeT extends SdkPojo> |
JsonProtocolUnmarshaller.unmarshall(SdkPojo sdkPojo,
SdkHttpFullResponse response) |
<TypeT extends SdkPojo> |
JsonProtocolUnmarshaller.unmarshall(SdkPojo sdkPojo,
SdkHttpFullResponse response,
JsonNode jsonContent) |
| Modifier and Type | Method and Description |
|---|---|
<TypeT extends SdkPojo> |
JsonProtocolUnmarshaller.unmarshall(SdkPojo sdkPojo,
SdkHttpFullResponse response) |
<TypeT extends SdkPojo> |
JsonProtocolUnmarshaller.unmarshall(SdkPojo sdkPojo,
SdkHttpFullResponse response,
JsonNode jsonContent) |
| Modifier and Type | Method and Description |
|---|---|
AwsJsonProtocolErrorUnmarshaller.Builder |
AwsJsonProtocolErrorUnmarshaller.Builder.defaultExceptionSupplier(Supplier<SdkPojo> defaultExceptionSupplier)
Default exception type if "error code" does not match any known modeled exception.
|
| Constructor and Description |
|---|
JsonResponseHandler(JsonProtocolUnmarshaller unmarshaller,
Function<SdkHttpFullResponse,SdkPojo> pojoSupplier,
boolean needsConnectionLeftOpen,
boolean isPayloadJson)
Constructs a new response handler that will use the specified JSON unmarshaller to unmarshall
the service response and uses the specified response element path to find the root of the
business data in the service's response.
|
| Modifier and Type | Method and Description |
|---|---|
<T extends AwsResponse> |
AwsQueryProtocolFactory.createResponseHandler(Supplier<SdkPojo> pojoSupplier)
Creates the success response handler to unmarshall the response into a POJO.
|
SubclassT |
AwsQueryProtocolFactory.Builder.defaultServiceExceptionSupplier(Supplier<SdkPojo> exceptionBuilderSupplier)
A supplier for the services base exception builder.
|
| Modifier and Type | Method and Description |
|---|---|
SdkHttpFullRequest |
QueryProtocolMarshaller.marshall(SdkPojo pojo) |
| Modifier and Type | Method and Description |
|---|---|
<TypeT extends SdkPojo> |
QueryProtocolUnmarshaller.unmarshall(SdkPojo sdkPojo,
SdkHttpFullResponse response) |
<TypeT extends SdkPojo> |
QueryProtocolUnmarshaller.unmarshall(SdkPojo sdkPojo,
XmlElement resultRoot,
SdkHttpFullResponse response)
This method is also used to unmarshall exceptions.
|
| Modifier and Type | Method and Description |
|---|---|
<TypeT extends SdkPojo> |
QueryProtocolUnmarshaller.unmarshall(SdkPojo sdkPojo,
SdkHttpFullResponse response) |
<TypeT extends SdkPojo> |
QueryProtocolUnmarshaller.unmarshall(SdkPojo sdkPojo,
XmlElement resultRoot,
SdkHttpFullResponse response)
This method is also used to unmarshall exceptions.
|
| Modifier and Type | Method and Description |
|---|---|
AwsXmlErrorUnmarshaller.Builder |
AwsXmlErrorUnmarshaller.Builder.defaultExceptionSupplier(Supplier<SdkPojo> defaultExceptionSupplier)
Default exception type if "error code" does not match any known modeled exception.
|
| Constructor and Description |
|---|
AwsQueryResponseHandler(QueryProtocolUnmarshaller unmarshaller,
Function<SdkHttpFullResponse,SdkPojo> pojoSupplier) |
| Modifier and Type | Method and Description |
|---|---|
<TypeT extends SdkPojo> |
XmlErrorUnmarshaller.unmarshall(SdkPojo sdkPojo,
XmlElement resultRoot,
SdkHttpFullResponse response) |
| Modifier and Type | Method and Description |
|---|---|
<TypeT extends SdkPojo> |
XmlErrorUnmarshaller.unmarshall(SdkPojo sdkPojo,
XmlElement resultRoot,
SdkHttpFullResponse response) |
| Modifier and Type | Method and Description |
|---|---|
AwsXmlErrorProtocolUnmarshaller.Builder |
AwsXmlErrorProtocolUnmarshaller.Builder.defaultExceptionSupplier(Supplier<SdkPojo> defaultExceptionSupplier)
Default exception type if "error code" does not match any known modeled exception.
|
| Modifier and Type | Method and Description |
|---|---|
<T extends SdkPojo> |
AwsXmlProtocolFactory.createResponseHandler(Function<SdkHttpFullResponse,SdkPojo> pojoSupplier,
XmlOperationMetadata staxOperationMetadata) |
<T extends SdkPojo> |
AwsXmlProtocolFactory.createResponseHandler(Supplier<SdkPojo> pojoSupplier,
XmlOperationMetadata staxOperationMetadata) |
| Modifier and Type | Method and Description |
|---|---|
<T extends AwsResponse> |
AwsXmlProtocolFactory.createCombinedResponseHandler(Supplier<SdkPojo> pojoSupplier,
XmlOperationMetadata staxOperationMetadata) |
<T extends AwsResponse> |
AwsS3ProtocolFactory.createCombinedResponseHandler(Supplier<SdkPojo> pojoSupplier,
XmlOperationMetadata staxOperationMetadata) |
<T extends SdkPojo> |
AwsXmlProtocolFactory.createResponseHandler(Function<SdkHttpFullResponse,SdkPojo> pojoSupplier,
XmlOperationMetadata staxOperationMetadata) |
<T extends SdkPojo> |
AwsXmlProtocolFactory.createResponseHandler(Supplier<SdkPojo> pojoSupplier,
XmlOperationMetadata staxOperationMetadata) |
protected <T extends AwsResponse> |
AwsXmlProtocolFactory.createResponseTransformer(Supplier<SdkPojo> pojoSupplier) |
SubclassT |
AwsXmlProtocolFactory.Builder.defaultServiceExceptionSupplier(Supplier<SdkPojo> exceptionBuilderSupplier)
A supplier for the services base exception builder.
|
| Modifier and Type | Field and Description |
|---|---|
static XmlMarshaller<SdkPojo> |
XmlPayloadMarshaller.SDK_POJO |
| Modifier and Type | Method and Description |
|---|---|
SdkHttpFullRequest |
XmlProtocolMarshaller.marshall(SdkPojo pojo) |
| Modifier and Type | Class and Description |
|---|---|
class |
XmlResponseHandler<T extends SdkPojo>
Response handler for REST-XML services (Cloudfront, Route53, and S3).
|
| Modifier and Type | Method and Description |
|---|---|
<TypeT extends SdkPojo> |
XmlProtocolUnmarshaller.unmarshall(SdkPojo sdkPojo,
SdkHttpFullResponse response) |
<TypeT extends SdkPojo> |
XmlProtocolUnmarshaller.unmarshall(SdkPojo sdkPojo,
XmlElement resultRoot,
SdkHttpFullResponse response)
This method is also used to unmarshall exceptions.
|
| Modifier and Type | Method and Description |
|---|---|
static SdkPojo |
XmlPayloadUnmarshaller.unmarshallSdkPojo(XmlUnmarshallerContext context,
List<XmlElement> content,
SdkField<SdkPojo> field) |
| Modifier and Type | Method and Description |
|---|---|
static Optional<SdkField<?>> |
XmlResponseParserUtils.getBlobTypePayloadMemberToUnmarshal(SdkPojo sdkPojo)
Gets the Member which is a Payload and which is of Blob Type.
|
static XmlElement |
XmlResponseParserUtils.parse(SdkPojo sdkPojo,
SdkHttpFullResponse response)
Parse an XML response if one is expected and available.
|
<TypeT extends SdkPojo> |
XmlProtocolUnmarshaller.unmarshall(SdkPojo sdkPojo,
SdkHttpFullResponse response) |
<TypeT extends SdkPojo> |
XmlProtocolUnmarshaller.unmarshall(SdkPojo sdkPojo,
XmlElement resultRoot,
SdkHttpFullResponse response)
This method is also used to unmarshall exceptions.
|
| Modifier and Type | Method and Description |
|---|---|
AwsXmlErrorTransformer.Builder |
AwsXmlErrorTransformer.Builder.defaultExceptionSupplier(Supplier<SdkPojo> defaultExceptionSupplier)
Default exception type if "error code" does not match any known modeled exception.
|
static SdkPojo |
XmlPayloadUnmarshaller.unmarshallSdkPojo(XmlUnmarshallerContext context,
List<XmlElement> content,
SdkField<SdkPojo> field) |
| Constructor and Description |
|---|
AwsXmlPredicatedResponseHandler(Function<SdkHttpFullResponse,SdkPojo> pojoSupplier,
Function<AwsXmlUnmarshallingContext,OutputT> successResponseTransformer,
Function<AwsXmlUnmarshallingContext,? extends SdkException> errorResponseTransformer,
Function<AwsXmlUnmarshallingContext,AwsXmlUnmarshallingContext> decorateContextWithError,
boolean needsConnectionLeftOpen)
Standard constructor
|
AwsXmlResponseTransformer(XmlProtocolUnmarshaller unmarshaller,
Function<SdkHttpFullResponse,SdkPojo> pojoSupplier) |
XmlResponseHandler(XmlProtocolUnmarshaller unmarshaller,
Function<SdkHttpFullResponse,SdkPojo> pojoSupplier,
boolean needsConnectionLeftOpen) |
| Modifier and Type | Class and Description |
|---|---|
class |
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.
|
class |
AbortMultipartUploadRequest |
class |
AbortMultipartUploadResponse |
class |
AccelerateConfiguration
Configures the transfer acceleration state for an Amazon S3 bucket.
|
class |
AccessControlPolicy
Contains the elements that set the ACL permissions for an object per grantee.
|
class |
AccessControlTranslation
A container for information about access control for replicas.
|
class |
AddLegalHoldRequest
Request object representing the parameters required to add a legal hold on an object
in IBM Cloud Object Storage.
|
class |
AnalyticsAndOperator
A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.
|
class |
AnalyticsConfiguration
Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
|
class |
AnalyticsExportDestination
Where to publish the analytics results.
|
class |
AnalyticsFilter
The filter used to describe a set of objects for analyses.
|
class |
AnalyticsS3BucketDestination
Contains information about where to publish the analytics results.
|
class |
Bucket
In terms of implementation, a Bucket is a resource.
|
class |
BucketAlreadyExistsException
The requested bucket name is not available.
|
class |
BucketAlreadyOwnedByYouException
The bucket you tried to create already exists, and you own it.
|
class |
BucketInfo
Specifies the information about the bucket that will be created.
|
class |
BucketLifecycleConfiguration
Specifies the lifecycle configuration for objects in an Amazon S3 bucket.
|
class |
BucketLoggingStatus
Container for logging status information.
|
class |
BucketProtectionConfiguration
Represents the protection configuration for a bucket.
|
class |
BucketProtectionResponse |
class |
Checksum
Contains all the possible checksum or digest values for an object.
|
class |
CommonPrefix
Container for all (if there are any) keys between Prefix and the next occurrence of the string specified by a
delimiter.
|
class |
CompletedMultipartUpload
The container for the completed multipart upload details.
|
class |
CompletedPart
Details of the parts that were uploaded.
|
class |
CompleteMultipartUploadRequest |
class |
CompleteMultipartUploadResponse |
class |
Condition
A container for describing a condition that must be met for the specified redirect to apply.
|
class |
ContentList |
class |
ContinuationEvent
|
protected static class |
ContinuationEvent.BuilderImpl |
class |
CopyObjectRequest |
class |
CopyObjectResponse |
class |
CopyObjectResult
Container for all response elements.
|
class |
CopyPartResult
Container for all response elements.
|
class |
CORSConfiguration
Describes the cross-origin access configuration for objects in an Amazon S3 bucket.
|
class |
CORSRule
Specifies a cross-origin access rule for an Amazon S3 bucket.
|
class |
CreateBucketConfiguration
The configuration information for the bucket.
|
class |
CreateBucketMetadataTableConfigurationRequest |
class |
CreateBucketMetadataTableConfigurationResponse |
class |
CreateBucketRequest |
class |
CreateBucketResponse |
class |
CreateMultipartUploadRequest |
class |
CreateMultipartUploadResponse |
class |
CreateSessionRequest |
class |
CreateSessionResponse |
class |
CSVInput
Describes how an uncompressed comma-separated values (CSV)-formatted input object is formatted.
|
class |
CSVOutput
Describes how uncompressed comma-separated values (CSV)-formatted results are formatted.
|
class |
DefaultRetention
The container element for optionally specifying the default Object Lock retention settings for new objects placed in
the specified bucket.
|
class |
Delete
Container for the objects to delete.
|
class |
DeleteBucketAnalyticsConfigurationRequest |
class |
DeleteBucketAnalyticsConfigurationResponse |
class |
DeleteBucketCorsRequest |
class |
DeleteBucketCorsResponse |
class |
DeleteBucketEncryptionRequest |
class |
DeleteBucketEncryptionResponse |
class |
DeleteBucketIntelligentTieringConfigurationRequest |
class |
DeleteBucketIntelligentTieringConfigurationResponse |
class |
DeleteBucketInventoryConfigurationRequest |
class |
DeleteBucketInventoryConfigurationResponse |
class |
DeleteBucketLifecycleRequest |
class |
DeleteBucketLifecycleResponse |
class |
DeleteBucketMetadataTableConfigurationRequest |
class |
DeleteBucketMetadataTableConfigurationResponse |
class |
DeleteBucketMetricsConfigurationRequest |
class |
DeleteBucketMetricsConfigurationResponse |
class |
DeleteBucketOwnershipControlsRequest |
class |
DeleteBucketOwnershipControlsResponse |
class |
DeleteBucketPolicyRequest |
class |
DeleteBucketPolicyResponse |
class |
DeleteBucketReplicationRequest |
class |
DeleteBucketReplicationResponse |
class |
DeleteBucketRequest |
class |
DeleteBucketResponse |
class |
DeleteBucketTaggingRequest |
class |
DeleteBucketTaggingResponse |
class |
DeleteBucketWebsiteRequest |
class |
DeleteBucketWebsiteResponse |
class |
DeletedObject
Information about the deleted object.
|
class |
DeleteLegalHoldRequest
Request object containing all the options for deleting a legal hold from an object.
|
class |
DeleteMarkerEntry
Information about the delete marker.
|
class |
DeleteMarkerReplication
Specifies whether Amazon S3 replicates delete markers.
|
class |
DeleteObjectRequest |
class |
DeleteObjectResponse |
class |
DeleteObjectsRequest |
class |
DeleteObjectsResponse |
class |
DeleteObjectTaggingRequest |
class |
DeleteObjectTaggingResponse |
class |
DeletePublicAccessBlockRequest |
class |
DeletePublicAccessBlockResponse |
class |
Destination
Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3
Replication Time Control (S3 RTC).
|
class |
Encryption
Contains the type of server-side encryption used.
|
class |
EncryptionConfiguration
Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.
|
class |
EncryptionTypeMismatchException
The existing object was created with a different encryption type.
|
class |
EndEvent
A message that indicates the request is complete and no more messages will be sent.
|
protected static class |
EndEvent.BuilderImpl |
class |
ErrorDetails
If the
CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the
table, this structure contains the error code and error message. |
class |
ErrorDocument
The error information.
|
class |
EventBridgeConfiguration
A container for specifying the configuration for Amazon EventBridge.
|
class |
ExistingObjectReplication
Optional configuration to replicate existing source bucket objects.
|
class |
ExtendObjectRetentionRequest
IBM specific: Request object containing all the options for extending the retention period of a protected object.
|
class |
FilterRule
Specifies the Amazon S3 object key name to filter on.
|
class |
GetBucketAccelerateConfigurationRequest |
class |
GetBucketAccelerateConfigurationResponse |
class |
GetBucketAclRequest |
class |
GetBucketAclResponse |
class |
GetBucketAnalyticsConfigurationRequest |
class |
GetBucketAnalyticsConfigurationResponse |
class |
GetBucketCorsRequest |
class |
GetBucketCorsResponse |
class |
GetBucketEncryptionRequest |
class |
GetBucketEncryptionResponse |
class |
GetBucketIntelligentTieringConfigurationRequest |
class |
GetBucketIntelligentTieringConfigurationResponse |
class |
GetBucketInventoryConfigurationRequest |
class |
GetBucketInventoryConfigurationResponse |
class |
GetBucketLifecycleConfigurationRequest |
class |
GetBucketLifecycleConfigurationResponse |
class |
GetBucketLocationRequest |
class |
GetBucketLocationResponse |
class |
GetBucketLoggingRequest |
class |
GetBucketLoggingResponse |
class |
GetBucketMetadataTableConfigurationRequest |
class |
GetBucketMetadataTableConfigurationResponse |
class |
GetBucketMetadataTableConfigurationResult
The metadata table configuration for a general purpose bucket.
|
class |
GetBucketMetricsConfigurationRequest |
class |
GetBucketMetricsConfigurationResponse |
class |
GetBucketNotificationConfigurationRequest |
class |
GetBucketNotificationConfigurationResponse
A container for specifying the notification configuration of the bucket.
|
class |
GetBucketOwnershipControlsRequest |
class |
GetBucketOwnershipControlsResponse |
class |
GetBucketPolicyRequest |
class |
GetBucketPolicyResponse |
class |
GetBucketPolicyStatusRequest |
class |
GetBucketPolicyStatusResponse |
class |
GetBucketProtectionConfigurationRequest
Request object for the parameters to get a bucket's protection configuration.
|
class |
GetBucketProtectionConfigurationResponse |
class |
GetBucketReplicationRequest |
class |
GetBucketReplicationResponse |
class |
GetBucketRequestPaymentRequest |
class |
GetBucketRequestPaymentResponse |
class |
GetBucketTaggingRequest |
class |
GetBucketTaggingResponse |
class |
GetBucketVersioningRequest |
class |
GetBucketVersioningResponse |
class |
GetBucketWebsiteRequest |
class |
GetBucketWebsiteResponse |
class |
GetObjectAclRequest |
class |
GetObjectAclResponse |
class |
GetObjectAttributesParts
A collection of parts associated with a multipart upload.
|
class |
GetObjectAttributesRequest |
class |
GetObjectAttributesResponse |
class |
GetObjectLegalHoldRequest |
class |
GetObjectLegalHoldResponse |
class |
GetObjectLockConfigurationRequest |
class |
GetObjectLockConfigurationResponse |
class |
GetObjectRequest |
class |
GetObjectResponse |
class |
GetObjectRetentionRequest |
class |
GetObjectRetentionResponse |
class |
GetObjectTaggingRequest |
class |
GetObjectTaggingResponse |
class |
GetObjectTorrentRequest |
class |
GetObjectTorrentResponse |
class |
GetPublicAccessBlockRequest |
class |
GetPublicAccessBlockResponse |
class |
GetUrlRequest
Request to generate a URL representing an object in Amazon S3.
|
class |
GlacierJobParameters
Container for S3 Glacier job parameters.
|
class |
Grant
Container for grant information.
|
class |
Grantee
Container for the person being granted permissions.
|
class |
HeadBucketRequest |
class |
HeadBucketResponse |
class |
HeadObjectRequest |
class |
HeadObjectResponse |
class |
IndexDocument
Container for the
Suffix element. |
class |
Initiator
Container element that identifies who initiated the multipart upload.
|
class |
InputSerialization
Describes the serialization format of the object.
|
class |
IntelligentTieringAndOperator
A container for specifying S3 Intelligent-Tiering filters.
|
class |
IntelligentTieringConfiguration
Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.
|
class |
IntelligentTieringFilter
The
Filter is used to identify objects that the S3 Intelligent-Tiering configuration applies to. |
class |
InvalidObjectStateException
Object is archived and inaccessible until restored.
|
class |
InvalidRequestException
You may receive this error in multiple cases.
|
class |
InvalidWriteOffsetException
The write offset value that you specified does not match the current object size.
|
class |
InventoryConfiguration
Specifies the inventory configuration for an Amazon S3 bucket.
|
class |
InventoryDestination
Specifies the inventory configuration for an Amazon S3 bucket.
|
class |
InventoryEncryption
Contains the type of server-side encryption used to encrypt the inventory results.
|
class |
InventoryFilter
Specifies an inventory filter.
|
class |
InventoryS3BucketDestination
Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are
published.
|
class |
InventorySchedule
Specifies the schedule for generating inventory results.
|
class |
JSONInput
Specifies JSON as object's input serialization format.
|
class |
JSONOutput
Specifies JSON as request's output serialization format.
|
class |
LambdaFunctionConfiguration
A container for specifying the configuration for Lambda notifications.
|
class |
LegalHold |
class |
LifecycleExpiration
Container for the expiration for the lifecycle of the object.
|
class |
LifecycleRule
A lifecycle rule for individual objects in an Amazon S3 bucket.
|
class |
LifecycleRuleAndOperator
This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates.
|
class |
LifecycleRuleFilter
The
Filter is used to identify objects that a Lifecycle Rule applies to. |
class |
ListBucketAnalyticsConfigurationsRequest |
class |
ListBucketAnalyticsConfigurationsResponse |
class |
ListBucketIntelligentTieringConfigurationsRequest |
class |
ListBucketIntelligentTieringConfigurationsResponse |
class |
ListBucketInventoryConfigurationsRequest |
class |
ListBucketInventoryConfigurationsResponse |
class |
ListBucketMetricsConfigurationsRequest |
class |
ListBucketMetricsConfigurationsResponse |
class |
ListBucketReplicationFailuresRequest |
class |
ListBucketReplicationFailuresResponse |
class |
ListBucketsExtendedRequest
Request to retrieve a listing of buckets from Cloud Object Storage.
|
class |
ListBucketsExtendedResponse |
class |
ListBucketsRequest |
class |
ListBucketsResponse |
class |
ListDirectoryBucketsRequest |
class |
ListDirectoryBucketsResponse |
class |
ListLegalHoldsRequest
Request object containing all the options for listing legal holds
associated with a specific object in a Cloud Object Storage (COS) bucket.
|
class |
ListLegalHoldsResponse
Response object returned from
S3Client.listLegalHolds(ListLegalHoldsRequest)
operation. |
class |
ListMultipartUploadsRequest |
class |
ListMultipartUploadsResponse |
class |
ListObjectsRequest |
class |
ListObjectsResponse |
class |
ListObjectsV2Request |
class |
ListObjectsV2Response |
class |
ListObjectVersionsRequest |
class |
ListObjectVersionsResponse |
class |
ListPartsRequest |
class |
ListPartsResponse |
class |
LocationInfo
Specifies the location where the bucket will be created.
|
class |
LoggingEnabled
Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket.
|
class |
MetadataEntry
A metadata key-value pair to store with an object.
|
class |
MetadataTableConfiguration
The metadata table configuration for a general purpose bucket.
|
class |
MetadataTableConfigurationResult
The metadata table configuration for a general purpose bucket.
|
class |
Metrics
A container specifying replication metrics-related settings enabling replication metrics and events.
|
class |
MetricsAndOperator
A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.
|
class |
MetricsConfiguration
Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from
an Amazon S3 bucket.
|
class |
MetricsFilter
Specifies a metrics configuration filter.
|
class |
MultipartUpload
Container for the
MultipartUpload for the Amazon S3 object. |
class |
NoncurrentVersionExpiration
Specifies when noncurrent object versions expire.
|
class |
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. |
class |
NoSuchBucketException
The specified bucket does not exist.
|
class |
NoSuchKeyException
The specified key does not exist.
|
class |
NoSuchUploadException
The specified multipart upload does not exist.
|
class |
NotificationConfiguration
A container for specifying the notification configuration of the bucket.
|
class |
NotificationConfigurationFilter
Specifies object key name filtering rules.
|
class |
ObjectAlreadyInActiveTierErrorException
This action is not allowed against this storage tier.
|
class |
ObjectIdentifier
Object Identifier is unique value to identify objects.
|
class |
ObjectLockConfiguration
The container element for Object Lock configuration parameters.
|
class |
ObjectLockLegalHold
A legal hold configuration for an object.
|
class |
ObjectLockRetention
A Retention configuration for an object.
|
class |
ObjectLockRule
The container element for an Object Lock rule.
|
class |
ObjectNotInActiveTierErrorException
The source object of the COPY action is not in the active tier and is only stored in Amazon S3 Glacier.
|
class |
ObjectPart
A container for elements related to an individual part.
|
class |
ObjectSyncAttempted |
class |
ObjectVersion
The version of an object.
|
class |
OutputLocation
Describes the location where the restore job's output is stored.
|
class |
OutputSerialization
Describes how results of the Select job are serialized.
|
class |
Owner
Container for the owner's display name and ID.
|
class |
OwnershipControls
The container element for a bucket's ownership controls.
|
class |
OwnershipControlsRule
The container element for an ownership control rule.
|
class |
ParquetInput
Container for Parquet.
|
class |
Part
Container for elements related to a part.
|
class |
PartitionedPrefix
Amazon S3 keys for log objects are partitioned in the following format:
|
class |
PolicyStatus
The container element for a bucket's policy status.
|
class |
Progress
This data type contains information about progress of an operation.
|
class |
ProgressEvent
This data type contains information about the progress event of an operation.
|
protected static class |
ProgressEvent.BuilderImpl |
class |
PublicAccessBlockConfiguration
The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket.
|
class |
PutBucketAccelerateConfigurationRequest |
class |
PutBucketAccelerateConfigurationResponse |
class |
PutBucketAclRequest |
class |
PutBucketAclResponse |
class |
PutBucketAnalyticsConfigurationRequest |
class |
PutBucketAnalyticsConfigurationResponse |
class |
PutBucketCorsRequest |
class |
PutBucketCorsResponse |
class |
PutBucketEncryptionRequest |
class |
PutBucketEncryptionResponse |
class |
PutBucketIntelligentTieringConfigurationRequest |
class |
PutBucketIntelligentTieringConfigurationResponse |
class |
PutBucketInventoryConfigurationRequest |
class |
PutBucketInventoryConfigurationResponse |
class |
PutBucketLifecycleConfigurationRequest |
class |
PutBucketLifecycleConfigurationResponse |
class |
PutBucketLoggingRequest |
class |
PutBucketLoggingResponse |
class |
PutBucketMetricsConfigurationRequest |
class |
PutBucketMetricsConfigurationResponse |
class |
PutBucketNotificationConfigurationRequest |
class |
PutBucketNotificationConfigurationResponse |
class |
PutBucketOwnershipControlsRequest |
class |
PutBucketOwnershipControlsResponse |
class |
PutBucketPolicyRequest |
class |
PutBucketPolicyResponse |
class |
PutBucketProtectionConfigurationRequest
Request object to set protection configuration to a bucket.
|
class |
PutBucketReplicationReattemptRequest |
class |
PutBucketReplicationRequest |
class |
PutBucketReplicationResponse |
class |
PutBucketRequestPaymentRequest |
class |
PutBucketRequestPaymentResponse |
class |
PutBucketTaggingRequest |
class |
PutBucketTaggingResponse |
class |
PutBucketVersioningRequest |
class |
PutBucketVersioningResponse |
class |
PutBucketWebsiteRequest |
class |
PutBucketWebsiteResponse |
class |
PutObjectAclRequest |
class |
PutObjectAclResponse |
class |
PutObjectLegalHoldRequest |
class |
PutObjectLegalHoldResponse |
class |
PutObjectLockConfigurationRequest |
class |
PutObjectLockConfigurationResponse |
class |
PutObjectRequest |
class |
PutObjectResponse |
class |
PutObjectRetentionRequest |
class |
PutObjectRetentionResponse |
class |
PutObjectTaggingRequest |
class |
PutObjectTaggingResponse |
class |
PutPublicAccessBlockRequest |
class |
PutPublicAccessBlockResponse |
class |
QueueConfiguration
Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon
S3 detects specified events.
|
class |
RecordsEvent
The container for the records event.
|
protected static class |
RecordsEvent.BuilderImpl |
class |
Redirect
Specifies how requests are redirected.
|
class |
RedirectAllRequestsTo
Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.
|
class |
ReplicaModifications
A filter that you can specify for selection for modifications on replicas.
|
class |
ReplicationConfiguration
A container for replication rules.
|
class |
ReplicationRule
Specifies which Amazon S3 objects to replicate and where to store the replicas.
|
class |
ReplicationRuleAndOperator
A container for specifying rule filters.
|
class |
ReplicationRuleFilter
A filter that identifies the subset of objects to which the replication rule applies.
|
class |
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.
|
class |
ReplicationTimeValue
A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics
EventThreshold. |
class |
RequestPaymentConfiguration
Container for Payer.
|
class |
RequestProgress
Container for specifying if periodic
QueryProgress messages should be sent. |
class |
RestoreObjectRequest |
class |
RestoreObjectResponse |
class |
RestoreRequest
Container for restore job parameters.
|
class |
RestoreStatus
Specifies the restoration status of an object.
|
class |
Retention |
class |
RoutingRule
Specifies the redirect behavior and when a redirect is applied.
|
class |
S3Error
Container for all error elements.
|
class |
S3Exception |
protected static class |
S3Exception.BuilderImpl |
class |
S3KeyFilter
A container for object key name prefix and suffix filtering rules.
|
class |
S3Location
Describes an Amazon S3 location that will receive the results of the restore request.
|
class |
S3Object
An object consists of data and its descriptive metadata.
|
class |
S3Request |
class |
S3Response |
class |
S3TablesDestination
The destination information for the metadata table configuration.
|
class |
S3TablesDestinationResult
The destination information for the metadata table configuration.
|
class |
ScanRange
Specifies the byte range of the object to get the records from.
|
class |
SelectObjectContentRequest
|
class |
SelectObjectContentResponse |
class |
SelectParameters
|
class |
ServerSideEncryptionByDefault
Describes the default server-side encryption to apply to new objects in the bucket.
|
class |
ServerSideEncryptionConfiguration
Specifies the default server-side-encryption configuration.
|
class |
ServerSideEncryptionRule
Specifies the default server-side encryption configuration.
|
class |
SessionCredentials
The established temporary security credentials of the session.
|
class |
SimplePrefix
To use simple format for S3 keys for log objects, set SimplePrefix to an empty object.
|
class |
SourceSelectionCriteria
A container that describes additional filters for identifying the source objects that you want to replicate.
|
class |
SSEKMS
Specifies the use of SSE-KMS to encrypt delivered inventory reports.
|
class |
SseKmsEncryptedObjects
A container for filter information for the selection of S3 objects encrypted with Amazon Web Services KMS.
|
class |
SSES3
Specifies the use of SSE-S3 to encrypt delivered inventory reports.
|
class |
Stats
Container for the stats details.
|
class |
StatsEvent
Container for the Stats Event.
|
protected static class |
StatsEvent.BuilderImpl |
class |
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.
|
class |
StorageClassAnalysisDataExport
Container for data related to the storage class analysis for an Amazon S3 bucket for export.
|
class |
Tag
A container of a key value name pair.
|
class |
Tagging
Container for
TagSet elements. |
class |
TargetGrant
Container for granting information.
|
class |
TargetObjectKeyFormat
Amazon S3 key format for log objects.
|
class |
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.
|
class |
TooManyPartsException
You have attempted to add more parts than the maximum of 10000 that are allowed for this object.
|
class |
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.
|
class |
Transition
Specifies when an object transitions to a specified storage class.
|
class |
UploadPartCopyRequest |
class |
UploadPartCopyResponse |
class |
UploadPartRequest |
class |
UploadPartResponse |
class |
VersioningConfiguration
Describes the versioning state of an Amazon S3 bucket.
|
class |
VoidHttpResponse
A response class representing void response
|
class |
WebsiteConfiguration
Specifies website configuration parameters for an Amazon S3 bucket.
|
class |
WriteGetObjectResponseRequest |
class |
WriteGetObjectResponseResponse |
| Modifier and Type | Interface and Description |
|---|---|
static interface |
DefaultCont.Builder |
static interface |
DefaultEnd.Builder |
static interface |
DefaultProgress.Builder |
static interface |
DefaultRecords.Builder |
static interface |
DefaultStats.Builder |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultCont
A specialization of
com.ibm.cos.v2.services.s3.model.ContinuationEvent that represents the
SelectObjectContentEventStream$Cont event. |
class |
DefaultEnd
A specialization of
com.ibm.cos.v2.services.s3.model.EndEvent that represents the
SelectObjectContentEventStream$End event. |
class |
DefaultProgress
A specialization of
com.ibm.cos.v2.services.s3.model.ProgressEvent that represents the
SelectObjectContentEventStream$Progress event. |
class |
DefaultRecords
A specialization of
com.ibm.cos.v2.services.s3.model.RecordsEvent that represents the
SelectObjectContentEventStream$Records event. |
class |
DefaultStats
A specialization of
com.ibm.cos.v2.services.s3.model.StatsEvent that represents the
SelectObjectContentEventStream$Stats event. |
Copyright © 2026. All rights reserved.