Modules
Utility helpers for working with S3
Structs
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 Policy in the Amazon S3 User Guide.
Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see Amazon S3 Transfer Acceleration in the Amazon S3 User Guide.
Contains the elements that set the ACL permissions for an object per grantee.
A container for information about access control for replicas.
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.
Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
Where to publish the analytics results.
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.
Contains information about where to publish the analytics results.
In terms of implementation, a Bucket is a resource. An Amazon S3 bucket name is globally unique, and the namespace is shared by all AWS accounts.
Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see Object Lifecycle Management in the Amazon S3 User Guide.
Container for logging status information.
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.
Specifies a cross-origin access rule for an Amazon S3 bucket.
Describes how an uncompressed comma-separated values (CSV)-formatted input object is formatted.
Describes how uncompressed comma-separated values (CSV)-formatted results are formatted.
Container for specifying the AWS Lambda notification configuration.
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/.
The container for the completed multipart upload details.
Details of the parts that were uploaded.
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.
Container for all response elements.
Container for all response elements.
The configuration information for the bucket.
The container element for specifying the default Object Lock retention settings for new objects placed in the specified bucket.
-
The
DefaultRetentionsettings require both a mode and a period. -
The
DefaultRetentionperiod can be eitherDaysorYearsbut you must select one. You cannot specifyDaysandYearsat the same time.
Container for the objects to delete.
Information about the delete marker.
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.
For more information about delete marker replication, see Basic Rule Configuration.
If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see Backward Compatibility.
Information about the deleted object.
Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC).
Contains the type of server-side encryption used.
Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.
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.
The error information.
Optional configuration to replicate existing source bucket objects. For more information, see Replicating Existing Objects in the Amazon S3 User Guide.
Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or prefix of the key name.
Container for S3 Glacier job parameters.
Container for grant information.
Container for the person being granted permissions.
Container for the Suffix element.
Container element that identifies who initiated the multipart upload.
Describes the serialization format of the object.
A container for specifying S3 Intelligent-Tiering filters. The filters determine the subset of objects to which the rule applies.
Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.
For information about the S3 Intelligent-Tiering storage class, see Storage class for automatically optimizing frequently and infrequently accessed objects.
The Filter is used to identify objects that the S3 Intelligent-Tiering configuration applies to.
Specifies the inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory in the Amazon S3 API Reference.
Specifies the inventory configuration for an Amazon S3 bucket.
Contains the type of server-side encryption used to encrypt the inventory results.
Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.
Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.
Specifies the schedule for generating inventory results.
Specifies JSON as object's input serialization format.
Specifies JSON as request's output serialization format.
A container for specifying the configuration for AWS Lambda notifications.
Container for lifecycle rules. You can add as many as 1000 rules.
Container for the expiration for the lifecycle of the object.
A lifecycle rule for individual objects in an Amazon S3 bucket.
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.
The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix, Tag, or And specified.
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.
A metadata key-value pair to store with an object.
A container specifying replication metrics-related settings enabling replication metrics and events.
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.
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 PUT Bucket metrics in the Amazon S3 API Reference.
Specifies a metrics configuration filter. The metrics configuration only includes objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator).
Container for the MultipartUpload for the Amazon S3 object.
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.
Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, 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, or DEEP_ARCHIVE storage class at a specific period in the object's lifetime.
A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.
Specifies object key name filtering rules. For information about key name filtering, see Configuring Event Notifications in the Amazon S3 User Guide.
An object consists of data and its descriptive metadata.
Object Identifier is unique value to identify objects.
The container element for Object Lock configuration parameters.
A Legal Hold configuration for an object.
A Retention configuration for an object.
The container element for an Object Lock rule.
The version of an object.
Describes the location where the restore job's output is stored.
Describes how results of the Select job are serialized.
Container for the owner's display name and ID.
The container element for a bucket's ownership controls.
The container element for an ownership control rule.
Container for Parquet.
Container for elements related to a part.
The container element for a bucket's policy status.
This data type contains information about progress of an operation.
This data type contains information about the progress event of an operation.
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.
Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.
This data type is deprecated. Use QueueConfiguration for the same purposes. This data type specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.
The container for the records event.
Specifies how requests are redirected. In the event of an error, you can specify a different error code to return.
Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.
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.
If you don't specify the Filter element, Amazon S3 assumes that the replication configuration is the earlier version, V1. In the earlier version, this element is not allowed.
A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.
Specifies which Amazon S3 objects to replicate and where to store the replicas.
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.
For example:
-
If you specify both a
Prefixand aTagfilter, wrap these filters in anAndtag. -
If you specify a filter based on multiple tags, wrap the
Tagelements in anAndtag.
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.
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.
A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics EventThreshold.
Container for Payer.
Container for specifying if periodic QueryProgress messages should be sent.
Container for restore job parameters.
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.
Specifies lifecycle rules for an Amazon S3 bucket. For more information, see Put Bucket Lifecycle Configuration in the Amazon S3 API Reference. For examples, see Put Bucket Lifecycle Configuration Examples.
A client for the Amazon S3 API.
Container for all error elements.
A container for object key name prefix and suffix filtering rules.
Describes an Amazon S3 location that will receive the results of the restore request.
Specifies the use of SSE-KMS to encrypt delivered inventory reports.
Specifies the use of SSE-S3 to encrypt delivered inventory reports.
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.
Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. In the request, along with the SQL expression, you must specify a data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records. It returns only records that match the specified SQL expression. You must also specify the data serialization format for the response. For more information, see S3Select API Documentation.
Describes the parameters for Select job types.
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 PUT Bucket encryption in the Amazon S3 API Reference.
Specifies the default server-side-encryption configuration.
Specifies the default server-side encryption configuration.
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 master key (CMK) stored in AWS Key Management Service (SSE-KMS).
A container for filter information for the selection of S3 objects encrypted with AWS KMS.
Container for the stats details.
Container for the Stats Event.
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.
Container for data related to the storage class analysis for an Amazon S3 bucket for export.
A container of a key value name pair.
Container for TagSet elements.
Container for granting information.
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.
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.
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. This data type is deprecated. Use TopicConfiguration instead.
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.
Describes the versioning state of an Amazon S3 bucket. For more information, see PUT Bucket versioning in the Amazon S3 API Reference.
Specifies website configuration parameters for an Amazon S3 bucket.
Enums
Errors returned by AbortMultipartUpload
Errors returned by CompleteMultipartUpload
Errors returned by CopyObject
Errors returned by CreateBucket
Errors returned by CreateMultipartUpload
Errors returned by DeleteBucketAnalyticsConfiguration
Errors returned by DeleteBucketCors
Errors returned by DeleteBucketEncryption
Errors returned by DeleteBucket
Errors returned by DeleteBucketIntelligentTieringConfiguration
Errors returned by DeleteBucketInventoryConfiguration
Errors returned by DeleteBucketLifecycle
Errors returned by DeleteBucketMetricsConfiguration
Errors returned by DeleteBucketOwnershipControls
Errors returned by DeleteBucketPolicy
Errors returned by DeleteBucketReplication
Errors returned by DeleteBucketTagging
Errors returned by DeleteBucketWebsite
Errors returned by DeleteObject
Errors returned by DeleteObjectTagging
Errors returned by DeleteObjects
Errors returned by DeletePublicAccessBlock
Errors returned by GetBucketAccelerateConfiguration
Errors returned by GetBucketAcl
Errors returned by GetBucketAnalyticsConfiguration
Errors returned by GetBucketCors
Errors returned by GetBucketEncryption
Errors returned by GetBucketIntelligentTieringConfiguration
Errors returned by GetBucketInventoryConfiguration
Errors returned by GetBucketLifecycleConfiguration
Errors returned by GetBucketLifecycle
Errors returned by GetBucketLocation
Errors returned by GetBucketLogging
Errors returned by GetBucketMetricsConfiguration
Errors returned by GetBucketNotificationConfiguration
Errors returned by GetBucketNotification
Errors returned by GetBucketOwnershipControls
Errors returned by GetBucketPolicy
Errors returned by GetBucketPolicyStatus
Errors returned by GetBucketReplication
Errors returned by GetBucketRequestPayment
Errors returned by GetBucketTagging
Errors returned by GetBucketVersioning
Errors returned by GetBucketWebsite
Errors returned by GetObjectAcl
Errors returned by GetObject
Errors returned by GetObjectLegalHold
Errors returned by GetObjectLockConfiguration
Errors returned by GetObjectRetention
Errors returned by GetObjectTagging
Errors returned by GetObjectTorrent
Errors returned by GetPublicAccessBlock
Errors returned by HeadBucket
Errors returned by HeadObject
Errors returned by ListBucketAnalyticsConfigurations
Errors returned by ListBucketIntelligentTieringConfigurations
Errors returned by ListBucketInventoryConfigurations
Errors returned by ListBucketMetricsConfigurations
Errors returned by ListBuckets
Errors returned by ListMultipartUploads
Errors returned by ListObjectVersions
Errors returned by ListObjects
Errors returned by ListObjectsV2
Errors returned by ListParts
Errors returned by PutBucketAccelerateConfiguration
Errors returned by PutBucketAcl
Errors returned by PutBucketAnalyticsConfiguration
Errors returned by PutBucketCors
Errors returned by PutBucketEncryption
Errors returned by PutBucketIntelligentTieringConfiguration
Errors returned by PutBucketInventoryConfiguration
Errors returned by PutBucketLifecycleConfiguration
Errors returned by PutBucketLifecycle
Errors returned by PutBucketLogging
Errors returned by PutBucketMetricsConfiguration
Errors returned by PutBucketNotificationConfiguration
Errors returned by PutBucketNotification
Errors returned by PutBucketOwnershipControls
Errors returned by PutBucketPolicy
Errors returned by PutBucketReplication
Errors returned by PutBucketRequestPayment
Errors returned by PutBucketTagging
Errors returned by PutBucketVersioning
Errors returned by PutBucketWebsite
Errors returned by PutObjectAcl
Errors returned by PutObject
Errors returned by PutObjectLegalHold
Errors returned by PutObjectLockConfiguration
Errors returned by PutObjectRetention
Errors returned by PutObjectTagging
Errors returned by PutPublicAccessBlock
Errors returned by RestoreObject
Errors returned by SelectObjectContent
The container for selecting objects from a content event stream.
Errors returned by UploadPartCopy
Errors returned by UploadPart
Errors returned by WriteGetObjectResponse
Traits
Trait representing the capabilities of the Amazon S3 API. Amazon S3 clients implement this trait.