s3/aws.sdk.kotlin.services.s3.model

Package-level declarations

Types

Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration in the Amazon S3 User Guide.

AbortMultipartUploadRequest

class AbortMultipartUploadRequest

AbortMultipartUploadResponse

class AbortMultipartUploadResponse

AccelerateConfiguration

class AccelerateConfiguration

Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see Amazon S3 Transfer Acceleration in the Amazon S3 User Guide.

AccessControlPolicy

class AccessControlPolicy

Contains the elements that set the ACL permissions for an object per grantee.

AccessControlTranslation

class AccessControlTranslation

A container for information about access control for replicas.

AnalyticsAndOperator

class AnalyticsAndOperator

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates in any combination, and an object must match all of the predicates for the filter to apply.

AnalyticsConfiguration

class AnalyticsConfiguration

Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.

AnalyticsExportDestination

class AnalyticsExportDestination

Where to publish the analytics results.

AnalyticsFilter

sealed class AnalyticsFilter

The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.

AnalyticsS3BucketDestination

class AnalyticsS3BucketDestination

Contains information about where to publish the analytics results.

AnalyticsS3ExportFileFormat

sealed class AnalyticsS3ExportFileFormat

ArchiveStatus

sealed class ArchiveStatus

Bucket

class Bucket

In terms of implementation, a Bucket is a resource.

BucketAccelerateStatus

sealed class BucketAccelerateStatus

BucketAlreadyExists

class BucketAlreadyExists : S3Exception

The requested bucket name is not available. The bucket namespace is shared by all users of the system. Select a different name and try again.

BucketAlreadyOwnedByYou

class BucketAlreadyOwnedByYou : S3Exception

The bucket you tried to create already exists, and you own it. Amazon S3 returns this error in all Amazon Web Services Regions except in the North Virginia Region. For legacy compatibility, if you re-create an existing bucket that you already own in the North Virginia Region, Amazon S3 returns 200 OK and resets the bucket access control lists (ACLs).

BucketCannedAcl

sealed class BucketCannedAcl

BucketInfo

class BucketInfo

Specifies the information about the bucket that will be created. For more information about directory buckets, see Directory buckets in the Amazon S3 User Guide.

BucketLifecycleConfiguration

class BucketLifecycleConfiguration

Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see Object Lifecycle Management in the Amazon S3 User Guide.

BucketLocationConstraint

sealed class BucketLocationConstraint

BucketLoggingStatus

class BucketLoggingStatus

Container for logging status information.

BucketLogsPermission

sealed class BucketLogsPermission

BucketType

sealed class BucketType

BucketVersioningStatus

sealed class BucketVersioningStatus

Checksum

class Checksum

Contains all the possible checksum or digest values for an object.

ChecksumAlgorithm

sealed class ChecksumAlgorithm

ChecksumMode

sealed class ChecksumMode

ChecksumType

sealed class ChecksumType

CommonPrefix

class CommonPrefix

Container for all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter. CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix. For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/.

CompletedMultipartUpload

class CompletedMultipartUpload

The container for the completed multipart upload details.

CompletedPart

class CompletedPart

Details of the parts that were uploaded.

CompleteMultipartUploadRequest

class CompleteMultipartUploadRequest

CompleteMultipartUploadResponse

class CompleteMultipartUploadResponse

CompressionType

sealed class CompressionType

Condition

class Condition

A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.

ContinuationEvent

class ContinuationEvent

CopyObjectRequest

class CopyObjectRequest

CopyObjectResponse

class CopyObjectResponse

CopyObjectResult

class CopyObjectResult

Container for all response elements.

CopyPartResult

class CopyPartResult

Container for all response elements.

CorsConfiguration

class CorsConfiguration

Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

CorsRule

class CorsRule

Specifies a cross-origin access rule for an Amazon S3 bucket.

CreateBucketConfiguration

class CreateBucketConfiguration

The configuration information for the bucket.

CreateBucketMetadataConfigurationRequest

class CreateBucketMetadataConfigurationRequest

CreateBucketMetadataConfigurationResponse

class CreateBucketMetadataConfigurationResponse

CreateBucketMetadataTableConfigurationRequest

class CreateBucketMetadataTableConfigurationRequest

CreateBucketMetadataTableConfigurationResponse

class CreateBucketMetadataTableConfigurationResponse

CreateBucketRequest

class CreateBucketRequest

CreateBucketResponse

class CreateBucketResponse

CreateMultipartUploadRequest

class CreateMultipartUploadRequest

CreateMultipartUploadResponse

class CreateMultipartUploadResponse

CreateSessionRequest

class CreateSessionRequest

CreateSessionResponse

class CreateSessionResponse

CsvInput

class CsvInput

Describes how an uncompressed comma-separated values (CSV)-formatted input object is formatted.

CsvOutput

class CsvOutput

Describes how uncompressed comma-separated values (CSV)-formatted results are formatted.

DataRedundancy

sealed class DataRedundancy

DefaultRetention

class DefaultRetention

The container element for optionally specifying the default Object Lock retention settings for new objects placed in the specified bucket.

Delete

class Delete

Container for the objects to delete.

DeleteBucketAnalyticsConfigurationRequest

class DeleteBucketAnalyticsConfigurationRequest

DeleteBucketAnalyticsConfigurationResponse

class DeleteBucketAnalyticsConfigurationResponse

DeleteBucketCorsRequest

class DeleteBucketCorsRequest

DeleteBucketCorsResponse

class DeleteBucketCorsResponse

DeleteBucketEncryptionRequest

class DeleteBucketEncryptionRequest

DeleteBucketEncryptionResponse

class DeleteBucketEncryptionResponse

DeleteBucketIntelligentTieringConfigurationRequest

class DeleteBucketIntelligentTieringConfigurationRequest

DeleteBucketIntelligentTieringConfigurationResponse

class DeleteBucketIntelligentTieringConfigurationResponse

DeleteBucketInventoryConfigurationRequest

class DeleteBucketInventoryConfigurationRequest

DeleteBucketInventoryConfigurationResponse

class DeleteBucketInventoryConfigurationResponse

DeleteBucketLifecycleRequest

class DeleteBucketLifecycleRequest

DeleteBucketLifecycleResponse

class DeleteBucketLifecycleResponse

DeleteBucketMetadataConfigurationRequest

class DeleteBucketMetadataConfigurationRequest

DeleteBucketMetadataConfigurationResponse

class DeleteBucketMetadataConfigurationResponse

DeleteBucketMetadataTableConfigurationRequest

class DeleteBucketMetadataTableConfigurationRequest

DeleteBucketMetadataTableConfigurationResponse

class DeleteBucketMetadataTableConfigurationResponse

DeleteBucketMetricsConfigurationRequest

class DeleteBucketMetricsConfigurationRequest

DeleteBucketMetricsConfigurationResponse

class DeleteBucketMetricsConfigurationResponse

DeleteBucketOwnershipControlsRequest

class DeleteBucketOwnershipControlsRequest

DeleteBucketOwnershipControlsResponse

class DeleteBucketOwnershipControlsResponse

DeleteBucketPolicyRequest

class DeleteBucketPolicyRequest

DeleteBucketPolicyResponse

class DeleteBucketPolicyResponse

DeleteBucketReplicationRequest

class DeleteBucketReplicationRequest

DeleteBucketReplicationResponse

class DeleteBucketReplicationResponse

DeleteBucketRequest

class DeleteBucketRequest

DeleteBucketResponse

class DeleteBucketResponse

DeleteBucketTaggingRequest

class DeleteBucketTaggingRequest

DeleteBucketTaggingResponse

class DeleteBucketTaggingResponse

DeleteBucketWebsiteRequest

class DeleteBucketWebsiteRequest

DeleteBucketWebsiteResponse

class DeleteBucketWebsiteResponse

DeletedObject

class DeletedObject

Information about the deleted object.

DeleteMarkerEntry

class DeleteMarkerEntry

Information about the delete marker.

DeleteMarkerReplication

class DeleteMarkerReplication

Specifies whether Amazon S3 replicates delete markers. If you specify a Filter in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication``Status must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see Basic Rule Configuration.

DeleteMarkerReplicationStatus

sealed class DeleteMarkerReplicationStatus

DeleteObjectRequest

class DeleteObjectRequest

DeleteObjectResponse

class DeleteObjectResponse

DeleteObjectsRequest

class DeleteObjectsRequest

DeleteObjectsResponse

class DeleteObjectsResponse

DeleteObjectTaggingRequest

class DeleteObjectTaggingRequest

DeleteObjectTaggingResponse

class DeleteObjectTaggingResponse

DeletePublicAccessBlockRequest

class DeletePublicAccessBlockRequest

DeletePublicAccessBlockResponse

class DeletePublicAccessBlockResponse

Destination

class Destination

Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC).

DestinationResult

class DestinationResult

The destination information for the S3 Metadata configuration.

EncodingType

sealed class EncodingType

Encoding type used by Amazon S3 to encode the object keys in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser can't parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that aren't supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. For more information about characters to avoid in object key names, see Object key naming guidelines.

Encryption

class Encryption

Contains the type of server-side encryption used.

EncryptionConfiguration

class EncryptionConfiguration

Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.

EncryptionTypeMismatch

class EncryptionTypeMismatch : S3Exception

The existing object was created with a different encryption type. Subsequent write requests must include the appropriate encryption parameters in the request or while creating the session.

EndEvent

class EndEvent

A message that indicates the request is complete and no more messages will be sent. You should not assume that the request is complete until the client receives an EndEvent.

Error

class Error

Container for all error elements.

ErrorDetails

class ErrorDetails

If an S3 Metadata V1 CreateBucketMetadataTableConfiguration or V2 CreateBucketMetadataConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code and error message.

ErrorDocument

class ErrorDocument

The error information.

Event

sealed class Event

The bucket event for which to send notifications.

EventBridgeConfiguration

class EventBridgeConfiguration

A container for specifying the configuration for Amazon EventBridge.

ExistingObjectReplication

class ExistingObjectReplication

Optional configuration to replicate existing source bucket objects.

ExistingObjectReplicationStatus

sealed class ExistingObjectReplicationStatus

ExpirationState

sealed class ExpirationState

ExpirationStatus

sealed class ExpirationStatus

ExpressionType

sealed class ExpressionType

FileHeaderInfo

sealed class FileHeaderInfo

FilterRule

class FilterRule

Specifies the Amazon S3 object key name to filter on. An object key name is the name assigned to an object in your Amazon S3 bucket. You specify whether to filter on the suffix or prefix of the object key name. A prefix is a specific string of characters at the beginning of an object key name, which you can use to organize objects. For example, you can start the key names of related objects with a prefix, such as 2023- or engineering/. Then, you can use FilterRule to find objects in a bucket with key names that have the same prefix. A suffix is similar to a prefix, but it is at the end of the object key name instead of at the beginning.

FilterRuleName

sealed class FilterRuleName

GetBucketAccelerateConfigurationRequest

class GetBucketAccelerateConfigurationRequest

GetBucketAccelerateConfigurationResponse

class GetBucketAccelerateConfigurationResponse

GetBucketAclRequest

class GetBucketAclRequest

GetBucketAclResponse

class GetBucketAclResponse

GetBucketAnalyticsConfigurationRequest

class GetBucketAnalyticsConfigurationRequest

GetBucketAnalyticsConfigurationResponse

class GetBucketAnalyticsConfigurationResponse

GetBucketCorsRequest

class GetBucketCorsRequest

GetBucketCorsResponse

class GetBucketCorsResponse

GetBucketEncryptionRequest

class GetBucketEncryptionRequest

GetBucketEncryptionResponse

class GetBucketEncryptionResponse

GetBucketIntelligentTieringConfigurationRequest

class GetBucketIntelligentTieringConfigurationRequest

GetBucketIntelligentTieringConfigurationResponse

class GetBucketIntelligentTieringConfigurationResponse

GetBucketInventoryConfigurationRequest

class GetBucketInventoryConfigurationRequest

GetBucketInventoryConfigurationResponse

class GetBucketInventoryConfigurationResponse

GetBucketLifecycleConfigurationRequest

class GetBucketLifecycleConfigurationRequest

GetBucketLifecycleConfigurationResponse

class GetBucketLifecycleConfigurationResponse

GetBucketLocationRequest

class GetBucketLocationRequest

GetBucketLocationResponse

class GetBucketLocationResponse

GetBucketLoggingRequest

class GetBucketLoggingRequest

GetBucketLoggingResponse

class GetBucketLoggingResponse

GetBucketMetadataConfigurationRequest

class GetBucketMetadataConfigurationRequest

GetBucketMetadataConfigurationResponse

class GetBucketMetadataConfigurationResponse

GetBucketMetadataConfigurationResult

class GetBucketMetadataConfigurationResult

The S3 Metadata configuration for a general purpose bucket.

GetBucketMetadataTableConfigurationRequest

class GetBucketMetadataTableConfigurationRequest

GetBucketMetadataTableConfigurationResponse

class GetBucketMetadataTableConfigurationResponse

GetBucketMetadataTableConfigurationResult

class GetBucketMetadataTableConfigurationResult

The V1 S3 Metadata configuration for a general purpose bucket.

GetBucketMetricsConfigurationRequest

class GetBucketMetricsConfigurationRequest

GetBucketMetricsConfigurationResponse

class GetBucketMetricsConfigurationResponse

GetBucketNotificationConfigurationRequest

class GetBucketNotificationConfigurationRequest

GetBucketNotificationConfigurationResponse

class GetBucketNotificationConfigurationResponse

A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.

GetBucketOwnershipControlsRequest

class GetBucketOwnershipControlsRequest

GetBucketOwnershipControlsResponse

class GetBucketOwnershipControlsResponse

GetBucketPolicyRequest

class GetBucketPolicyRequest

GetBucketPolicyResponse

class GetBucketPolicyResponse

GetBucketPolicyStatusRequest

class GetBucketPolicyStatusRequest

GetBucketPolicyStatusResponse

class GetBucketPolicyStatusResponse

GetBucketReplicationRequest

class GetBucketReplicationRequest

GetBucketReplicationResponse

class GetBucketReplicationResponse

GetBucketRequestPaymentRequest

class GetBucketRequestPaymentRequest

GetBucketRequestPaymentResponse

class GetBucketRequestPaymentResponse

GetBucketTaggingRequest

class GetBucketTaggingRequest

GetBucketTaggingResponse

class GetBucketTaggingResponse

GetBucketVersioningRequest

class GetBucketVersioningRequest

GetBucketVersioningResponse

class GetBucketVersioningResponse

GetBucketWebsiteRequest

class GetBucketWebsiteRequest

GetBucketWebsiteResponse

class GetBucketWebsiteResponse

GetObjectAclRequest

class GetObjectAclRequest

GetObjectAclResponse

class GetObjectAclResponse

GetObjectAttributesParts

class GetObjectAttributesParts

A collection of parts associated with a multipart upload.

GetObjectAttributesRequest

class GetObjectAttributesRequest

GetObjectAttributesResponse

class GetObjectAttributesResponse

GetObjectLegalHoldRequest

class GetObjectLegalHoldRequest

GetObjectLegalHoldResponse

class GetObjectLegalHoldResponse

GetObjectLockConfigurationRequest

class GetObjectLockConfigurationRequest

GetObjectLockConfigurationResponse

class GetObjectLockConfigurationResponse

GetObjectRequest

class GetObjectRequest

GetObjectResponse

class GetObjectResponse

GetObjectRetentionRequest

class GetObjectRetentionRequest

GetObjectRetentionResponse

class GetObjectRetentionResponse

GetObjectTaggingRequest

class GetObjectTaggingRequest

GetObjectTaggingResponse

class GetObjectTaggingResponse

GetObjectTorrentRequest

class GetObjectTorrentRequest

GetObjectTorrentResponse

class GetObjectTorrentResponse

GetPublicAccessBlockRequest

class GetPublicAccessBlockRequest

GetPublicAccessBlockResponse

class GetPublicAccessBlockResponse

GlacierJobParameters

class GlacierJobParameters

Container for S3 Glacier job parameters.

Grant

class Grant

Container for grant information.

Grantee

class Grantee

Container for the person being granted permissions.

HeadBucketRequest

class HeadBucketRequest

HeadBucketResponse

class HeadBucketResponse

HeadObjectRequest

class HeadObjectRequest

HeadObjectResponse

class HeadObjectResponse

IdempotencyParameterMismatch

class IdempotencyParameterMismatch : S3Exception

Parameters on this idempotent request are inconsistent with parameters used in previous request(s).

IndexDocument

class IndexDocument

Container for the Suffix element.

Initiator

class Initiator

Container element that identifies who initiated the multipart upload.

InputSerialization

class InputSerialization

Describes the serialization format of the object.

IntelligentTieringAccessTier

sealed class IntelligentTieringAccessTier

IntelligentTieringAndOperator

class IntelligentTieringAndOperator

A container for specifying S3 Intelligent-Tiering filters. The filters determine the subset of objects to which the rule applies.

IntelligentTieringConfiguration

class IntelligentTieringConfiguration

Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.

IntelligentTieringFilter

class IntelligentTieringFilter

The Filter is used to identify objects that the S3 Intelligent-Tiering configuration applies to.

IntelligentTieringStatus

sealed class IntelligentTieringStatus

InvalidObjectState

class InvalidObjectState : S3Exception

Object is archived and inaccessible until restored.

InvalidRequest

class InvalidRequest : S3Exception

You may receive this error in multiple cases. Depending on the reason for the error, you may receive one of the messages below:

InvalidWriteOffset

class InvalidWriteOffset : S3Exception

The write offset value that you specified does not match the current object size.

InventoryConfiguration

class InventoryConfiguration

Specifies the S3 Inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory in the Amazon S3 API Reference.

InventoryConfigurationState

sealed class InventoryConfigurationState

InventoryDestination

class InventoryDestination

Specifies the S3 Inventory configuration for an Amazon S3 bucket.

InventoryEncryption

class InventoryEncryption

Contains the type of server-side encryption used to encrypt the S3 Inventory results.

InventoryFilter

class InventoryFilter

Specifies an S3 Inventory filter. The inventory only includes objects that meet the filter's criteria.

InventoryFormat

sealed class InventoryFormat

InventoryFrequency

sealed class InventoryFrequency

InventoryIncludedObjectVersions

sealed class InventoryIncludedObjectVersions

InventoryOptionalField

sealed class InventoryOptionalField

InventoryS3BucketDestination

class InventoryS3BucketDestination

Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where S3 Inventory results are published.

InventorySchedule

class InventorySchedule

Specifies the schedule for generating S3 Inventory results.

InventoryTableConfiguration

class InventoryTableConfiguration

The inventory table configuration for an S3 Metadata configuration.

InventoryTableConfigurationResult

class InventoryTableConfigurationResult

The inventory table configuration for an S3 Metadata configuration.

InventoryTableConfigurationUpdates

class InventoryTableConfigurationUpdates

The specified updates to the S3 Metadata inventory table configuration.

JournalTableConfiguration

class JournalTableConfiguration

The journal table configuration for an S3 Metadata configuration.

JournalTableConfigurationResult

class JournalTableConfigurationResult

The journal table configuration for the S3 Metadata configuration.

JournalTableConfigurationUpdates

class JournalTableConfigurationUpdates

The specified updates to the S3 Metadata journal table configuration.

JsonInput

class JsonInput

Specifies JSON as object's input serialization format.

JsonOutput

class JsonOutput

Specifies JSON as request's output serialization format.

JsonType

sealed class JsonType

LambdaFunctionConfiguration

class LambdaFunctionConfiguration

A container for specifying the configuration for Lambda notifications.

LifecycleExpiration

class LifecycleExpiration

Container for the expiration for the lifecycle of the object.

LifecycleRule

class LifecycleRule

A lifecycle rule for individual objects in an Amazon S3 bucket.

LifecycleRuleAndOperator

class LifecycleRuleAndOperator

This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates. The Lifecycle Rule will apply to any object matching all of the predicates configured inside the And operator.

LifecycleRuleFilter

class LifecycleRuleFilter

The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter can have exactly one of Prefix, Tag, ObjectSizeGreaterThan, ObjectSizeLessThan, or And specified. If the Filter element is left empty, the Lifecycle Rule applies to all objects in the bucket.

ListBucketAnalyticsConfigurationsRequest

class ListBucketAnalyticsConfigurationsRequest

ListBucketAnalyticsConfigurationsResponse

class ListBucketAnalyticsConfigurationsResponse

ListBucketIntelligentTieringConfigurationsRequest

class ListBucketIntelligentTieringConfigurationsRequest

ListBucketIntelligentTieringConfigurationsResponse

class ListBucketIntelligentTieringConfigurationsResponse

ListBucketInventoryConfigurationsRequest

class ListBucketInventoryConfigurationsRequest

ListBucketInventoryConfigurationsResponse

class ListBucketInventoryConfigurationsResponse

ListBucketMetricsConfigurationsRequest

class ListBucketMetricsConfigurationsRequest

ListBucketMetricsConfigurationsResponse

class ListBucketMetricsConfigurationsResponse

ListBucketsRequest

class ListBucketsRequest

ListBucketsResponse

class ListBucketsResponse

ListDirectoryBucketsRequest

class ListDirectoryBucketsRequest

ListDirectoryBucketsResponse

class ListDirectoryBucketsResponse

ListMultipartUploadsRequest

class ListMultipartUploadsRequest

ListMultipartUploadsResponse

class ListMultipartUploadsResponse

ListObjectsRequest

class ListObjectsRequest

ListObjectsResponse

class ListObjectsResponse

ListObjectsV2Request

class ListObjectsV2Request

ListObjectsV2Response

class ListObjectsV2Response

ListObjectVersionsRequest

class ListObjectVersionsRequest

ListObjectVersionsResponse

class ListObjectVersionsResponse

ListPartsRequest

class ListPartsRequest

ListPartsResponse

class ListPartsResponse

LocationInfo

class LocationInfo

Specifies the location where the bucket will be created.

LocationType

sealed class LocationType

LoggingEnabled

class LoggingEnabled

Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see PUT Bucket logging in the Amazon S3 API Reference.

MetadataConfiguration

class MetadataConfiguration

The S3 Metadata configuration for a general purpose bucket.

MetadataConfigurationResult

class MetadataConfigurationResult

The S3 Metadata configuration for a general purpose bucket.

MetadataDirective

sealed class MetadataDirective

MetadataEntry

class MetadataEntry

A metadata key-value pair to store with an object.

MetadataTableConfiguration

class MetadataTableConfiguration

The V1 S3 Metadata configuration for a general purpose bucket.

MetadataTableConfigurationResult

class MetadataTableConfigurationResult

The V1 S3 Metadata configuration for a general purpose bucket. The destination table bucket must be in the same Region and Amazon Web Services account as the general purpose bucket. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket.

MetadataTableEncryptionConfiguration

class MetadataTableEncryptionConfiguration

The encryption settings for an S3 Metadata journal table or inventory table configuration.

Metrics

class Metrics

A container specifying replication metrics-related settings enabling replication metrics and events.

MetricsAndOperator

class MetricsAndOperator

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.

MetricsConfiguration

class MetricsConfiguration

Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see PutBucketMetricsConfiguration.

MetricsFilter

sealed class MetricsFilter

Specifies a metrics configuration filter. The metrics configuration only includes objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator). For more information, see PutBucketMetricsConfiguration.

MetricsStatus

sealed class MetricsStatus

MfaDelete

sealed class MfaDelete

MfaDeleteStatus

sealed class MfaDeleteStatus

MultipartUpload

class MultipartUpload

Container for the MultipartUpload for the Amazon S3 object.

NoncurrentVersionExpiration

class NoncurrentVersionExpiration

Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.

NoncurrentVersionTransition

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. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage class at a specific period in the object's lifetime.

NoSuchBucket

class NoSuchBucket : S3Exception

The specified bucket does not exist.

NoSuchKey

class NoSuchKey : S3Exception

The specified key does not exist.

NoSuchUpload

class NoSuchUpload : S3Exception

The specified multipart upload does not exist.

NotFound

class NotFound : S3Exception

The specified content does not exist.

NotificationConfiguration

class NotificationConfiguration

A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.

NotificationConfigurationFilter

class NotificationConfigurationFilter

Specifies object key name filtering rules. For information about key name filtering, see Configuring event notifications using object key name filtering in the Amazon S3 User Guide.

Object

class Object

An object consists of data and its descriptive metadata.

ObjectAlreadyInActiveTierError

class ObjectAlreadyInActiveTierError : S3Exception

This action is not allowed against this storage tier.

ObjectAttributes

sealed class ObjectAttributes

ObjectCannedAcl

sealed class ObjectCannedAcl

ObjectIdentifier

class ObjectIdentifier

Object Identifier is unique value to identify objects.

ObjectLockConfiguration

class ObjectLockConfiguration

The container element for Object Lock configuration parameters.

ObjectLockEnabled

sealed class ObjectLockEnabled

ObjectLockLegalHold

class ObjectLockLegalHold

A legal hold configuration for an object.

ObjectLockLegalHoldStatus

sealed class ObjectLockLegalHoldStatus

ObjectLockMode

sealed class ObjectLockMode

ObjectLockRetention

class ObjectLockRetention

A Retention configuration for an object.

ObjectLockRetentionMode

sealed class ObjectLockRetentionMode

ObjectLockRule

class ObjectLockRule

The container element for an Object Lock rule.

ObjectNotInActiveTierError

class ObjectNotInActiveTierError : S3Exception

The source object of the COPY action is not in the active tier and is only stored in Amazon S3 Glacier.

ObjectOwnership

sealed class ObjectOwnership

The container element for object ownership for a bucket's ownership controls.

ObjectPart

class ObjectPart

A container for elements related to an individual part.

ObjectStorageClass

sealed class ObjectStorageClass

ObjectVersion

class ObjectVersion

The version of an object.

ObjectVersionStorageClass

sealed class ObjectVersionStorageClass

OptionalObjectAttributes

sealed class OptionalObjectAttributes

OutputLocation

class OutputLocation

Describes the location where the restore job's output is stored.

OutputSerialization

class OutputSerialization

Describes how results of the Select job are serialized.

Owner

class Owner

End of support notice: Beginning October 1, 2025, Amazon S3 will stop returning DisplayName. Update your applications to use canonical IDs (unique identifier for Amazon Web Services accounts), Amazon Web Services account ID (12 digit identifier) or IAM ARNs (full resource naming) as a direct replacement of DisplayName.

OwnerOverride

sealed class OwnerOverride

OwnershipControls

class OwnershipControls

The container element for a bucket's ownership controls.

OwnershipControlsRule

class OwnershipControlsRule

The container element for an ownership control rule.

ParquetInput

class ParquetInput

Container for Parquet.

Part

class Part

Container for elements related to a part.

PartitionDateSource

sealed class PartitionDateSource

PartitionedPrefix

class PartitionedPrefix

Amazon S3 keys for log objects are partitioned in the following format:

Payer

sealed class Payer

Permission

sealed class Permission

PolicyStatus

class PolicyStatus

The container element for a bucket's policy status.

Progress

class Progress

This data type contains information about progress of an operation.

ProgressEvent

class ProgressEvent

This data type contains information about the progress event of an operation.

Protocol

sealed class Protocol

PublicAccessBlockConfiguration

class PublicAccessBlockConfiguration

The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide.

PutBucketAccelerateConfigurationRequest

class PutBucketAccelerateConfigurationRequest

PutBucketAccelerateConfigurationResponse

class PutBucketAccelerateConfigurationResponse

PutBucketAclRequest

class PutBucketAclRequest

PutBucketAclResponse

class PutBucketAclResponse

PutBucketAnalyticsConfigurationRequest

class PutBucketAnalyticsConfigurationRequest

PutBucketAnalyticsConfigurationResponse

class PutBucketAnalyticsConfigurationResponse

PutBucketCorsRequest

class PutBucketCorsRequest

PutBucketCorsResponse

class PutBucketCorsResponse

PutBucketEncryptionRequest

class PutBucketEncryptionRequest

PutBucketEncryptionResponse

class PutBucketEncryptionResponse

PutBucketIntelligentTieringConfigurationRequest

class PutBucketIntelligentTieringConfigurationRequest

PutBucketIntelligentTieringConfigurationResponse

class PutBucketIntelligentTieringConfigurationResponse

PutBucketInventoryConfigurationRequest

class PutBucketInventoryConfigurationRequest

PutBucketInventoryConfigurationResponse

class PutBucketInventoryConfigurationResponse

PutBucketLifecycleConfigurationRequest

class PutBucketLifecycleConfigurationRequest

PutBucketLifecycleConfigurationResponse

class PutBucketLifecycleConfigurationResponse

PutBucketLoggingRequest

class PutBucketLoggingRequest

PutBucketLoggingResponse

class PutBucketLoggingResponse

PutBucketMetricsConfigurationRequest

class PutBucketMetricsConfigurationRequest

PutBucketMetricsConfigurationResponse

class PutBucketMetricsConfigurationResponse

PutBucketNotificationConfigurationRequest

class PutBucketNotificationConfigurationRequest

PutBucketNotificationConfigurationResponse

class PutBucketNotificationConfigurationResponse

PutBucketOwnershipControlsRequest

class PutBucketOwnershipControlsRequest

PutBucketOwnershipControlsResponse

class PutBucketOwnershipControlsResponse

PutBucketPolicyRequest

class PutBucketPolicyRequest

PutBucketPolicyResponse

class PutBucketPolicyResponse

PutBucketReplicationRequest

class PutBucketReplicationRequest

PutBucketReplicationResponse

class PutBucketReplicationResponse

PutBucketRequestPaymentRequest

class PutBucketRequestPaymentRequest

PutBucketRequestPaymentResponse

class PutBucketRequestPaymentResponse

PutBucketTaggingRequest

class PutBucketTaggingRequest

PutBucketTaggingResponse

class PutBucketTaggingResponse

PutBucketVersioningRequest

class PutBucketVersioningRequest

PutBucketVersioningResponse

class PutBucketVersioningResponse

PutBucketWebsiteRequest

class PutBucketWebsiteRequest

PutBucketWebsiteResponse

class PutBucketWebsiteResponse

PutObjectAclRequest

class PutObjectAclRequest

PutObjectAclResponse

class PutObjectAclResponse

PutObjectLegalHoldRequest

class PutObjectLegalHoldRequest

PutObjectLegalHoldResponse

class PutObjectLegalHoldResponse

PutObjectLockConfigurationRequest

class PutObjectLockConfigurationRequest

PutObjectLockConfigurationResponse

class PutObjectLockConfigurationResponse

PutObjectRequest

class PutObjectRequest

PutObjectResponse

class PutObjectResponse

PutObjectRetentionRequest

class PutObjectRetentionRequest

PutObjectRetentionResponse

class PutObjectRetentionResponse

PutObjectTaggingRequest

class PutObjectTaggingRequest

PutObjectTaggingResponse

class PutObjectTaggingResponse

PutPublicAccessBlockRequest

class PutPublicAccessBlockRequest

PutPublicAccessBlockResponse

class PutPublicAccessBlockResponse

QueueConfiguration

class QueueConfiguration

Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.

QuoteFields

sealed class QuoteFields

RecordExpiration

class RecordExpiration

The journal table record expiration settings for a journal table in an S3 Metadata configuration.

RecordsEvent

class RecordsEvent

The container for the records event.

Redirect

class Redirect

Specifies how requests are redirected. In the event of an error, you can specify a different error code to return.

RedirectAllRequestsTo

class RedirectAllRequestsTo

Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.

RenameObjectRequest

class RenameObjectRequest

RenameObjectResponse

class RenameObjectResponse

ReplicaModifications

class ReplicaModifications

A filter that you can specify for selection for modifications on replicas. Amazon S3 doesn't replicate replica modifications by default. In the latest version of replication configuration (when Filter is specified), you can specify this element and set the status to Enabled to replicate modifications on replicas.

ReplicaModificationsStatus

sealed class ReplicaModificationsStatus

ReplicationConfiguration

class ReplicationConfiguration

A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.

ReplicationRule

class ReplicationRule

Specifies which Amazon S3 objects to replicate and where to store the replicas.

ReplicationRuleAndOperator

class ReplicationRuleAndOperator

A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter.

ReplicationRuleFilter

class ReplicationRuleFilter

A filter that identifies the subset of objects to which the replication rule applies. A Filter must specify exactly one Prefix, Tag, or an And child element.

ReplicationRuleStatus

sealed class ReplicationRuleStatus

ReplicationStatus

sealed class ReplicationStatus

ReplicationTime

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. Must be specified together with a Metrics block.

ReplicationTimeStatus

sealed class ReplicationTimeStatus

ReplicationTimeValue

class ReplicationTimeValue

A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics EventThreshold.

RequestCharged

sealed class RequestCharged

If present, indicates that the requester was successfully charged for the request. For more information, see Using Requester Pays buckets for storage transfers and usage in the Amazon Simple Storage Service user guide.

RequestPayer

sealed class RequestPayer

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

RequestPaymentConfiguration

class RequestPaymentConfiguration

Container for Payer.

RequestProgress

class RequestProgress

Container for specifying if periodic QueryProgress messages should be sent.

RestoreObjectRequest

class RestoreObjectRequest

RestoreObjectResponse

class RestoreObjectResponse

RestoreRequest

class RestoreRequest

Container for restore job parameters.

RestoreRequestType

sealed class RestoreRequestType

RestoreStatus

class RestoreStatus

Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objects in the Amazon S3 User Guide.

RoutingRule

class RoutingRule

Specifies the redirect behavior and when a redirect is applied. For more information about routing rules, see Configuring advanced conditional redirects in the Amazon S3 User Guide.

S3ErrorMetadata

class S3ErrorMetadata : AwsErrorMetadata

S3Exception

open class S3Exception : AwsServiceException

Base class for all service related exceptions thrown by the S3 client

S3KeyFilter

class S3KeyFilter

A container for object key name prefix and suffix filtering rules.

S3Location

class S3Location

Describes an Amazon S3 location that will receive the results of the restore request.

S3TablesBucketType

sealed class S3TablesBucketType

S3TablesDestination

class S3TablesDestination

The destination information for a V1 S3 Metadata configuration. The destination table bucket must be in the same Region and Amazon Web Services account as the general purpose bucket. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket.

S3TablesDestinationResult

class S3TablesDestinationResult

ScanRange

class ScanRange

Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. This parameter is optional, but when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.

SelectObjectContentEventStream

sealed class SelectObjectContentEventStream

The container for selecting objects from a content event stream.

SelectObjectContentRequest

class SelectObjectContentRequest

Learn Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more

SelectObjectContentResponse

class SelectObjectContentResponse

SelectParameters

class SelectParameters

Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more

ServerSideEncryption

sealed class ServerSideEncryption

ServerSideEncryptionByDefault

class ServerSideEncryptionByDefault

Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. For more information, see PutBucketEncryption.

ServerSideEncryptionConfiguration

class ServerSideEncryptionConfiguration

Specifies the default server-side-encryption configuration.

ServerSideEncryptionRule

class ServerSideEncryptionRule

Specifies the default server-side encryption configuration.

SessionCredentials

class SessionCredentials

The established temporary security credentials of the session.

SessionMode

sealed class SessionMode

SimplePrefix

class SimplePrefix

To use simple format for S3 keys for log objects, set SimplePrefix to an empty object.

SourceSelectionCriteria

class SourceSelectionCriteria

A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer managed key stored in Amazon Web Services Key Management Service (SSE-KMS).

Ssekms

class Ssekms

Specifies the use of SSE-KMS to encrypt delivered inventory reports.

SseKmsEncryptedObjects

class SseKmsEncryptedObjects

A container for filter information for the selection of S3 objects encrypted with Amazon Web Services KMS.

SseKmsEncryptedObjectsStatus

sealed class SseKmsEncryptedObjectsStatus

Sses3

class Sses3

Specifies the use of SSE-S3 to encrypt delivered inventory reports.

Stats

class Stats

Container for the stats details.

StatsEvent

class StatsEvent

Container for the Stats Event.

StorageClass

sealed class StorageClass

StorageClassAnalysis

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.

StorageClassAnalysisDataExport

class StorageClassAnalysisDataExport

Container for data related to the storage class analysis for an Amazon S3 bucket for export.

StorageClassAnalysisSchemaVersion

sealed class StorageClassAnalysisSchemaVersion

TableSseAlgorithm

sealed class TableSseAlgorithm

Tag

class Tag

A container of a key value name pair.

Tagging

class Tagging

Container for TagSet elements.

TaggingDirective

sealed class TaggingDirective

TargetGrant

class TargetGrant

Container for granting information.

TargetObjectKeyFormat

class TargetObjectKeyFormat

Amazon S3 key format for log objects. Only one format, PartitionedPrefix or SimplePrefix, is allowed.

Tier

sealed class Tier

Tiering

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.

TooManyParts

class TooManyParts : S3Exception

You have attempted to add more parts than the maximum of 10000 that are allowed for this object. You can use the CopyObject operation to copy this object to another and then add more data to the newly copied object.

TopicConfiguration

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.

Transition

class Transition

Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle in the Amazon S3 User Guide.