AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Name | Description | |
---|---|---|
AbortMultipartUploadRequest |
Container for the parameters to the AbortMultipartUpload operation. This action aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts. To verify that all parts have been removed, so you don't get charged for the part storage, you should call the ListParts action and ensure that the parts list is empty. For information about permissions required to use the multipart upload, see Multipart Upload and Permissions.
The following operations are related to |
|
AbortMultipartUploadResponse |
Returns information about the AbortMultipartUpload response metadata. The AbortMultipartUpload operation has a void result type. |
|
AccelerateConfiguration |
Bucket accelerate configuration. |
|
AccessControlTranslation |
A container for information about access control for replicas. |
|
AnalyticsAndOperator |
Class for AnalyticsAndOperator 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. |
|
AnalyticsConfiguration |
Class for AnalyticsConfiguration |
|
AnalyticsExportDestination |
Class for AnalyticsExportDestination |
|
AnalyticsFilter |
Filter class for Metrics. |
|
AnalyticsFilterPredicate |
Filter Predicate abstract class for specific filter types to be derived from. |
|
AnalyticsNAryOperator |
Abstract class that can be used over logical filter predicates,i.e. AND/OR. |
|
AnalyticsPrefixPredicate |
Class for AnalyticsPrefixPredicate The prefix used when evaluating a metrics filter. |
|
AnalyticsS3BucketDestination |
Class for AnalyticsS3BucketDestination |
|
AnalyticsTagPredicate |
Class for MetricsTagPredicate The tag used when evaluating a metrics filter. |
|
BucketAlreadyExistsException |
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. |
|
BucketAlreadyOwnedByYouException |
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). |
|
BucketInfo |
Contains information about the Bucket |
|
ByteRange |
This class represents the byte range for a range GET from S3. |
|
Checksum |
Contains all the possible checksum or digest values for an object. |
|
CompleteMultipartUploadRequest |
Container for the parameters to the CompleteMultipartUpload operation. Completes a multipart upload by assembling previously uploaded parts.
You first initiate the multipart upload and then upload all parts using the UploadPart
operation or the UploadPartCopy
operation. After successfully uploading all relevant parts of an upload, you call
this
The processing of a CompleteMultipartUpload request could take several minutes to
finalize. After Amazon S3 begins processing the request, it sends an HTTP response
header that specifies a
Note that if
You can't use For more information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide. Directory buckets - For directory buckets, you must make requests for this
API operation to the Zonal endpoint. These endpoints support virtual-hosted-style
requests in the format
The following operations are related to |
|
CompleteMultipartUploadResponse |
Returns information about the CompleteMultipartUpload response and response metadata. |
|
ContinuationEvent |
The Continuation Event. |
|
CopyObjectRequest |
Container for the parameters to the CopyObject operation.
Creates a copy of an object that is already stored in Amazon S3.
You can store individual objects of up to 5 TB in Amazon S3. You create a copy of
your object up to 5 GB in size in a single atomic action using this API. However,
to copy an object greater than 5 GB, you must use the multipart upload Upload Part
- Copy (UploadPartCopy) API. For more information, see Copy
Object Using the REST Multipart Upload API.
You can copy individual objects between general purpose buckets, between directory buckets, and between general purpose buckets and directory buckets. Directory buckets - For directory buckets, you must make requests for this
API operation to the Zonal endpoint. These endpoints support virtual-hosted-style
requests in the format Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account.
Amazon S3 transfer acceleration does not support cross-Region copies. If you request
a cross-Region copy using a transfer acceleration endpoint, you get a
The following operations are related to |
|
CopyObjectResponse |
Returns information about the CopyObject response and response metadata. |
|
CopyPartRequest |
Container for the parameters to the CopyPart operation.
Uploads a part by copying data from an existing object as data source. To specify
the data source, you add the request header For information about maximum and minimum part sizes and other multipart upload specifications, see Multipart upload limits in the Amazon S3 User Guide. Instead of copying data from an existing object as part data, you might use the UploadPart action to upload new data as a part of an object in your request. You must initiate a multipart upload before you can upload any part. In response to your initiate request, Amazon S3 returns the upload ID, a unique identifier that you must include in your upload part request. For conceptual information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide. For information about copying objects using a single atomic action vs. a multipart upload, see Operations on Objects in the Amazon S3 User Guide. Directory buckets - For directory buckets, you must make requests for this
API operation to the Zonal endpoint. These endpoints support virtual-hosted-style
requests in the format
The following operations are related to |
|
CopyPartResponse |
Returns information about the CopyPart response and response metadata. |
|
CORSConfiguration |
A collection of up to 100 cross-origin resource sharing (CORS) rules. |
|
CORSRule |
C O R S Rule |
|
CreateSessionRequest |
Container for the parameters to the CreateSession operation. |
|
CreateSessionResponse |
This is the response object from the CreateSession operation. |
|
CSVInput |
Describes how a CSV-formatted input object is formatted. |
|
CSVOutput |
Describes how CSV-formatted results are formatted. |
|
DefaultRetention |
The container element for optionally specifying the default Object Lock retention settings for new objects placed in the specified bucket.
|
|
DeleteBucketAnalyticsConfigurationRequest |
Container for the parameters to the DeleteBucketAnalyticsConfiguration operation. Deletes an analytics configuration for the bucket (specified by the analytics configuration ID). |
|
DeleteBucketAnalyticsConfigurationResponse |
Returns information about the DeleteBucketAnalyticsConfiguration response metadata. The DeleteBucketAnalyticsConfiguration operation has a void result type. |
|
DeleteBucketEncryptionRequest |
Request object for the DeleteBucketEncryption operation. Request Deletes the server-side encryption configuration from the bucket. |
|
DeleteBucketEncryptionResponse |
Returns information about the DeleteBucketEncryption response metadata. The DeleteBucketEncryption operation has a void result type. |
|
DeleteBucketIntelligentTieringConfigurationRequest |
Container for the parameters to the DeleteBucketIntelligentTieringConfiguration operation. Deletes the S3 Intelligent-Tiering configuration from the specified bucket. 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 performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities. The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to |
|
DeleteBucketIntelligentTieringConfigurationResponse |
Returns information about the DeleteBucketIntelligentTieringConfiguration response metadata. The DeleteBucketMetricsConfiguration operation has a void result type. |
|
DeleteBucketInventoryConfigurationRequest |
Container for the parameters to the DeleteInventoryConfiguration operation. Deletes an inventory configuration (identified by the inventory ID) from the bucket. |
|
DeleteBucketInventoryConfigurationResponse |
Returns information about the DeleteInventoryConfiguration response metadata. The DeleteInventoryConfiguration operation has a void result type. |
|
DeleteBucketMetricsConfigurationRequest |
Container for the parameters to the DeleteBucketMetricsConfiguration operation. Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket. |
|
DeleteBucketMetricsConfigurationResponse |
Returns information about the DeleteBucketMetricsConfiguration response metadata. The DeleteBucketMetricsConfiguration operation has a void result type. |
|
DeleteBucketOwnershipControlsRequest |
Container for the parameters to the DeleteBucketOwnershipControlsRequest operation. |
|
DeleteBucketOwnershipControlsResponse |
Returns information about the DeleteBucketOwnershipControls response metadata. The DeleteBucketOwnershipControls operation has a void result type. |
|
DeleteBucketPolicyRequest |
Container for the parameters to the DeleteBucketPolicy operation.
Deletes the policy of a specified bucket.
Directory buckets - For directory buckets, you must make requests for this
API operation to the Regional endpoint. These endpoints support path-style requests
in the format
The following operations are related to |
|
DeleteBucketPolicyResponse |
Returns information about the DeleteBucketPolicy response metadata. The DeleteBucketPolicy operation has a void result type. |
|
DeleteBucketReplicationRequest |
Container for the parameters to the DeleteBucketReplication operation. Deletes the replication configuration from the bucket.
To use this operation, you must have permissions to perform the It can take a while for the deletion of a replication configuration to fully propagate. For information about replication configuration, see Replication in the Amazon S3 User Guide.
The following operations are related to |
|
DeleteBucketReplicationResponse |
Returns information about the DeleteBucketReplication response metadata. The DeleteBucketReplication operation has a void result type. |
|
DeleteBucketRequest |
Container for the parameters to the DeleteBucket operation.
Deletes the S3 bucket. All objects (including all object versions and delete markers)
in the bucket must be deleted before the bucket itself can be deleted.
Directory buckets - If multipart uploads in a directory bucket are in progress,
you can't delete the bucket until all the in-progress multipart uploads are aborted
or completed.
Directory buckets - For directory buckets, you must make requests for this
API operation to the Regional endpoint. These endpoints support path-style requests
in the format
The following operations are related to |
|
DeleteBucketResponse |
Returns information about the DeleteBucket response metadata. The DeleteBucket operation has a void result type. |
|
DeleteBucketTaggingRequest |
The parameters to request deletion of a tag set from a bucket. |
|
DeleteBucketTaggingResponse |
Returns information about the DeleteBucketTagging response metadata. The DeleteBucketTagging operation has a void result type. |
|
DeleteBucketWebsiteRequest |
Container for the parameters to the DeleteBucketWebsite operation. This operation removes the website configuration from the bucket. |
|
DeleteBucketWebsiteResponse |
Returns information about the DeleteBucketWebsite response metadata. The DeleteBucketWebsite operation has a void result type. |
|
DeleteCORSConfigurationRequest |
Container for the parameters to the DeleteCORSConfiguration operation. Deletes the cors configuration information set for the bucket. |
|
DeleteCORSConfigurationResponse |
Returns information about the DeleteCORSConfiguration response metadata. The DeleteCORSConfiguration operation has a void result type. |
|
DeletedObject |
Contains information about a successful delete operation against a specific S3 object. |
|
DeleteError |
Container for all error elements. |
|
DeleteLifecycleConfigurationRequest |
Container for the parameters to the DeleteLifecycleConfiguration operation.
This operation is not supported by directory buckets.
Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.
To use this operation, you must have permission to perform the There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems. For more information about the object expiration, see Elements to Describe Lifecycle Actions. Related actions include: |
|
DeleteLifecycleConfigurationResponse |
Returns information about the DeleteLifecycleConfiguration response metadata. The DeleteLifecycleConfiguration operation has a void result type. |
|
DeleteMarkerReplication |
Specifies whether Amazon S3 replicates delete markers.
If you specify a 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. |
|
DeleteObjectRequest |
Container for the parameters to the DeleteObject operation. Removes an object from a bucket. The behavior depends on the bucket's versioning state:
To remove a specific version, you must use the
If the object you want to delete is in a bucket where the bucket versioning configuration
is MFA Delete enabled, you must include the Directory buckets - MFA delete is not supported by directory buckets.
You can delete objects by explicitly calling DELETE Object or calling (PutBucketLifecycle)
to enable Amazon S3 to remove them for you. If you want to block users or accounts
from removing or deleting objects from your bucket, you must deny them the Directory buckets - S3 Lifecycle is not supported by directory buckets.
The following action is related to |
|
DeleteObjectResponse |
Returns information about the DeleteObject response and response metadata. |
|
DeleteObjectsRequest |
Container for the parameters to the DeleteObjects operation. This operation enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this operation provides a suitable alternative to sending individual delete requests, reducing per-request overhead. The request can contain a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete operation and returns the result of that delete, success or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted.
The operation supports two modes for the response: verbose and quiet. By default, the operation uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete operation encountered an error. For a successful deletion in a quiet mode, the operation does not return any information about the delete in the response body. When performing this action on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete in the Amazon S3 User Guide. Directory buckets - MFA delete is not supported by directory buckets.
The following operations are related to |
|
DeleteObjectsResponse |
Returns information about the DeleteObjects response and response metadata. |
|
DeleteObjectTaggingRequest |
Container for the parameters to the DeleteObjectTagging operation.
This operation is not supported by directory buckets.
Removes the entire tag set from the specified object. For more information about managing object tags, see Object Tagging.
To use this operation, you must have permission to perform the
To delete tags of a specific object version, add the
The following operations are related to |
|
DeleteObjectTaggingResponse |
Returns information about the DeleteObjectTagging response and response metadata. |
|
DeletePublicAccessBlockRequest |
Container for the parameters to the DeletePublicAccessBlock operation.
This operation is not supported by directory buckets.
Removes the
The following operations are related to |
|
DeletePublicAccessBlockResponse |
This is the response object from the DeletePublicAccessBlock operation. |
|
EncryptionConfiguration |
Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects. If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requester’s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner. |
|
EndEvent |
The End Event. |
|
EventBridgeConfiguration |
A container for specifying the configuration for Amazon EventBridge. |
|
ExistingObjectReplication |
Optional configuration to replicate existing source bucket objects. This parameter is no longer supported. To replicate existing objects, see Replicating existing objects with S3 Batch Replication in the Amazon S3 User Guide. |
|
Expiration |
Defines the expiration policy for a given object. |
|
Filter |
Bucket Represents a set of filter criteria that limits the objects that can trigger event notifications |
|
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 |
|
GetACLRequest |
Container for the parameters to the GetACL operation.
This operation is not supported by directory buckets.
This implementation of the When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
When you use this API operation with an Object Lambda access point, provide the alias
of the Object Lambda access point in place of the bucket name. If the Object Lambda
access point alias in a request is not valid, the error code
If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests
to read ACLs are still supported and return the
The following operations are related to |
|
GetACLResponse |
Returns information about the GetACL response and response metadata. |
|
GetBucketAccelerateConfigurationRequest |
Container for the parameters to the GetBucketAccelerateConfiguration operation.
This operation is not supported by directory buckets.
This implementation of the GET action uses the
To use this operation, you must have permission to perform the
You set the Transfer Acceleration state of an existing bucket to
A GET For more information about transfer acceleration, see Transfer Acceleration in the Amazon S3 User Guide.
The following operations are related to |
|
GetBucketAccelerateConfigurationResponse |
The response class for GetBucketAccelerateConfiguration operation. |
|
GetBucketAnalyticsConfigurationRequest |
Container for the parameters to the GetBucketAnalyticsConfiguration operation.
This operation is not supported by directory buckets.
This implementation of the GET action returns an analytics configuration (identified by the analytics configuration ID) from the bucket.
To use this operation, you must have permissions to perform the For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis in the Amazon S3 User Guide.
The following operations are related to |
|
GetBucketAnalyticsConfigurationResponse |
GetBucketAnalyticsConfigurationResponse Response |
|
GetBucketEncryptionRequest |
Container for the parameters to the GetBucketEncryption operation.
This operation is not supported by directory buckets.
Returns the default encryption configuration for an Amazon S3 bucket. By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). For information about the bucket default encryption feature, see Amazon S3 Bucket Default Encryption in the Amazon S3 User Guide.
To use this operation, you must have permission to perform the
The following operations are related to |
|
GetBucketEncryptionResponse |
GetBucketEncryptionResponse Response |
|
GetBucketIntelligentTieringConfigurationRequest |
Container for the parameters to the GetBucketIntelligentTieringConfiguration operation.
This operation is not supported by directory buckets.
Gets the S3 Intelligent-Tiering configuration from the specified bucket. 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 performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities. The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to |
|
GetBucketIntelligentTieringConfigurationResponse |
Response object for the GetBucketIntelligentTieringConfiguration operation. |
|
GetBucketInventoryConfigurationRequest |
Container for the parameters to the GetBucketInventoryConfiguration operation.
This operation is not supported by directory buckets.
Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.
To use this operation, you must have permissions to perform the For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
The following operations are related to |
|
GetBucketInventoryConfigurationResponse |
GetInventoryConfigurationResponse Response |
|
GetBucketLocationRequest |
Container for the parameters to the GetBucketLocation operation.
This operation is not supported by directory buckets.
Returns the Region the bucket resides in. You set the bucket's Region using the When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
When you use this API operation with an Object Lambda access point, provide the alias
of the Object Lambda access point in place of the bucket name. If the Object Lambda
access point alias in a request is not valid, the error code We recommend that you use HeadBucket to return the Region that a bucket resides in. For backward compatibility, Amazon S3 continues to support GetBucketLocation.
The following operations are related to |
|
GetBucketLocationResponse |
Returns information about the GetBucketLocation response and response metadata. |
|
GetBucketLoggingRequest |
Container for the parameters to the GetBucketLogging operation.
This operation is not supported by directory buckets.
Returns the logging status of a bucket and the permissions users have to view and modify that status.
The following operations are related to |
|
GetBucketLoggingResponse |
Returns information about the GetBucketLogging response and response metadata. |
|
GetBucketMetricsConfigurationRequest |
Container for the parameters to the GetBucketMetricsConfiguration operation.
This operation is not supported by directory buckets.
Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.
To use this operation, you must have permissions to perform the For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to |
|
GetBucketMetricsConfigurationResponse |
GetBucketMetricsConfiguration Response |
|
GetBucketNotificationRequest |
Container for the parameters to the GetBucketNotification operation.
This operation is not supported by directory buckets.
Returns the notification configuration of a bucket.
If notifications are not enabled on the bucket, the action returns an empty
By default, you must be the bucket owner to read the notification configuration of
a bucket. However, the bucket owner can use a bucket policy to grant permission to
other users to read this configuration with the When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
When you use this API operation with an Object Lambda access point, provide the alias
of the Object Lambda access point in place of the bucket name. If the Object Lambda
access point alias in a request is not valid, the error code For more information about setting and reading the notification configuration on a bucket, see Setting Up Notification of Bucket Events. For more information about bucket policies, see Using Bucket Policies.
The following action is related to |
|
GetBucketNotificationResponse |
Returns information about the GetBucketNotification response and response metadata. |
|
GetBucketOwnershipControlsRequest |
Container for the parameters to the GetBucketOwnershipControls operation.
This operation is not supported by directory buckets.
Retrieves For information about Amazon S3 Object Ownership, see Using Object Ownership.
The following operations are related to |
|
GetBucketOwnershipControlsResponse |
Returns information about the GetBucketOwnershipControls response and response metadata. |
|
GetBucketPolicyRequest |
Container for the parameters to the GetBucketPolicy operation.
Returns the policy of a specified bucket.
Directory buckets - For directory buckets, you must make requests for this
API operation to the Regional endpoint. These endpoints support path-style requests
in the format
The following action is related to |
|
GetBucketPolicyResponse |
Get BucketName Policy Response |
|
GetBucketPolicyStatusRequest |
Container for the parameters to the GetBucketPolicyStatus operation.
This operation is not supported by directory buckets.
Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket
is public. In order to use this operation, you must have the For more information about when Amazon S3 considers a bucket public, see The Meaning of "Public".
The following operations are related to |
|
GetBucketPolicyStatusResponse |
This is the response object from the GetBucketPolicyStatus operation. |
|
GetBucketReplicationRequest |
Container for the parameters to the GetBucketReplicationConfiguration operation. Returns the replication configuration information set on the bucket. |
|
GetBucketReplicationResponse |
Returns information about the GetReplicationConfiguration response and response metadata. |
|
GetBucketRequestPaymentRequest |
Container for the parameters to the GetBucketRequestPayment operation.
This operation is not supported by directory buckets.
Returns the request payment configuration of a bucket. To use this version of the operation, you must be the bucket owner. For more information, see Requester Pays Buckets.
The following operations are related to |
|
GetBucketRequestPaymentResponse |
Returns information about the GetBucketRequestPayment response and response metadata. |
|
GetBucketTaggingRequest |
Container for the parameters to the GetBucketTagging operation.
This operation is not supported by directory buckets.
Returns the tag set associated with the bucket.
To use this operation, you must have permission to perform the
The following operations are related to |
|
GetBucketTaggingResponse |
Returns information about the GetBucketTagging response and response metadata. |
|
GetBucketVersioningRequest |
Container for the parameters to the GetBucketVersioning operation.
This operation is not supported by directory buckets.
Returns the versioning state of a bucket. To retrieve the versioning state of a bucket, you must be the bucket owner.
This implementation also returns the MFA Delete status of the versioning state. If
the MFA Delete status is
The following operations are related to |
|
GetBucketVersioningResponse |
Returns information about the GetBucketVersioning response and response metadata. |
|
GetBucketWebsiteRequest |
Container for the parameters to the GetBucketWebsite operation.
This operation is not supported by directory buckets.
Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see Hosting Websites on Amazon S3.
This GET action requires the
The following operations are related to |
|
GetBucketWebsiteResponse |
Returns information about the GetBucketWebsite response and response metadata. |
|
GetCORSConfigurationRequest |
Container for the parameters to the GetCORSConfiguration operation.
This operation is not supported by directory buckets.
Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the bucket.
To use this operation, you must have permission to perform the When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
When you use this API operation with an Object Lambda access point, provide the alias
of the Object Lambda access point in place of the bucket name. If the Object Lambda
access point alias in a request is not valid, the error code For more information about CORS, see Enabling Cross-Origin Resource Sharing.
The following operations are related to |
|
GetCORSConfigurationResponse |
Returns information about the GetBucketCors response and response metadata. |
|
GetLifecycleConfigurationRequest |
Container for the parameters to the GetLifecycleConfiguration operation.
This operation is not supported by directory buckets.
Bucket lifecycle configuration now supports specifying a lifecycle rule using an object
key name prefix, one or more object tags, object size, or any combination of these.
Accordingly, this section describes the latest API. The previous version of the API
supported filtering based only on an object key name prefix, which is supported for
backward compatibility. For the related API description, see GetBucketLifecycle.
Accordingly, this section describes the latest API. The response describes the new
filter element that you can use to specify a filter to select a subset of objects
to which the rule applies. If you are using a previous version of the lifecycle configuration,
it still works. For the earlier action,
Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.
To use this operation, you must have permission to perform the
The following operations are related to |
|
GetLifecycleConfigurationResponse |
Returns information about the GetLifecycleConfiguration response and response metadata. |
|
GetObjectAttributesParts |
A collection of parts associated with a multipart upload. |
|
GetObjectAttributesRequest |
Container for the parameters to the GetObjectAttributes operation. Retrieves all the metadata from an object without returning the object itself. This operation is useful if you're interested only in an object's metadata.
Directory buckets - For directory buckets, you must make requests for this
API operation to the Zonal endpoint. These endpoints support virtual-hosted-style
requests in the format
The following actions are related to |
|
GetObjectAttributesResponse |
This is the response object from the GetObjectAttributes operation. |
|
GetObjectLegalHoldRequest |
Container for the parameters to the GetObjectLegalHold operation.
This operation is not supported by directory buckets.
Gets an object's current legal hold status. For more information, see Locking Objects. This functionality is not supported for Amazon S3 on Outposts.
The following action is related to |
|
GetObjectLegalHoldResponse |
This is the response object from the GetObjectLegalHold operation. |
|
GetObjectLockConfigurationRequest |
Container for the parameters to the GetObjectLockConfiguration operation.
This operation is not supported by directory buckets.
Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.
The following action is related to |
|
GetObjectLockConfigurationResponse |
This is the response object from the GetObjectLockConfiguration operation. |
|
GetObjectMetadataRequest |
Container for the parameters to the GetObjectMetadata operation.
The
A Request headers are limited to 8 KB in size. For more information, see Common Request Headers. Directory buckets - For directory buckets, you must make requests for this
API operation to the Zonal endpoint. These endpoints support virtual-hosted-style
requests in the format
The following actions are related to |
|
GetObjectMetadataResponse |
Returns information about the HeadObject response and response metadata. |
|
GetObjectRequest |
Container for the parameters to the GetObject operation. Retrieves an object from Amazon S3.
In the General purpose buckets - Both the virtual-hosted-style requests and the path-style
requests are supported. For a virtual hosted-style request example, if you have the
object Directory buckets - Only virtual-hosted-style requests are supported. For
a virtual hosted-style request example, if you have the object
The following operations are related to |
|
GetObjectResponse |
Returns information about the GetObject response and response metadata. |
|
GetObjectRetentionRequest |
Container for the parameters to the GetObjectRetention operation.
This operation is not supported by directory buckets.
Retrieves an object's retention settings. For more information, see Locking Objects. This functionality is not supported for Amazon S3 on Outposts.
The following action is related to |
|
GetObjectRetentionResponse |
This is the response object from the GetObjectRetention operation. |
|
GetObjectTaggingRequest |
Container for the parameters to the GetObjectTagging operation.
This operation is not supported by directory buckets.
Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.
To use this operation, you must have permission to perform the By default, the bucket owner has this permission and can grant this permission to others. For information about the Amazon S3 object tagging feature, see Object Tagging.
The following actions are related to |
|
GetObjectTaggingResponse |
Returns information about the GetObjectTagging response and response metadata. |
|
GetObjectTorrentRequest |
Container for the parameters to the GetObjectTorrent operation.
This operation is not supported by directory buckets.
Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files. You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using server-side encryption with a customer-provided encryption key. To use GET, you must have READ access to the object. This functionality is not supported for Amazon S3 on Outposts.
The following action is related to |
|
GetObjectTorrentResponse |
Returns information about the GetObjectTorrent response and response metadata. |
|
GetPreSignedUrlRequest |
The parameters to create a pre-signed URL to a bucket or object. |
|
GetPreSignedUrlResponse |
The parameters for a pre-signed URL to a bucket or object as a string. |
|
GetPublicAccessBlockRequest |
Container for the parameters to the GetPublicAccessBlock operation.
This operation is not supported by directory buckets.
Retrieves the
When Amazon S3 evaluates the For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public".
The following operations are related to |
|
GetPublicAccessBlockResponse |
This is the response object from the GetPublicAccessBlock operation. |
|
HeadBucketRequest |
Container for the parameters to the HeadBucket operation.
You can use this operation to determine if a bucket exists and if you have permission
to access it. The action returns a
If the bucket does not exist or you do not have permission to access it, the Directory buckets - You must make requests for this API operation to the
Zonal endpoint. These endpoints support virtual-hosted-style requests in the format
|
|
HeadBucketResponse |
Returns information about the HeadBucket response metadata. The HeadBucket operation has a void result type. |
|
HeadersCollection |
This class contains the headers for an S3 object. |
|
InitiateMultipartUploadRequest |
Container for the parameters to the InitiateMultipartUpload operation.
This action initiates a multipart upload and returns an upload ID. This upload ID
is used to associate all of the parts in the specific multipart upload. You specify
this upload ID in each of your subsequent upload part requests (see UploadPart).
You also include this upload ID in the final request to either complete or abort the
multipart upload request. For more information about multipart uploads, see Multipart
Upload Overview in the Amazon S3 User Guide.
After you initiate a multipart upload and upload one or more parts, to stop being
charged for storing the uploaded parts, you must either complete or abort the multipart
upload. Amazon S3 frees up the space used to store the parts and stops charging you
for storing them only after you either complete or abort a multipart upload.
If you have configured a lifecycle rule to abort incomplete multipart uploads, the created multipart upload must be completed within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.
The following operations are related to |
|
InitiateMultipartUploadResponse |
Returns information about the InitiateMultipartUpload response and response metadata. |
|
Initiator |
Identifies who initiated the multipart upload. |
|
InputSerialization |
Describes the serialization format of the object. |
|
IntelligentTieringAndOperator |
A container for specifying S3 Intelligent-Tiering filters. The filters determine the subset of objects to which the rule applies. |
|
IntelligentTieringConfiguration |
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. |
|
IntelligentTieringFilter |
The |
|
IntelligentTieringFilterPredicate |
Filter Predicate abstract class for specific filter types to be derived from. |
|
IntelligentTieringNAryOperator |
Abstract class that can be used over logical filter predicates,i.e. AND/OR. |
|
IntelligentTieringPrefixPredicate |
An object key name prefix that identifies the subset of objects to which the configuration applies. |
|
IntelligentTieringTagPredicate |
All of these tags must exist in the object's tag set in order for the configuration to apply. |
|
InventoryConfiguration |
Specifies the inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory in the Amazon S3 API Reference. |
|
InventoryDestination |
Class for InventoryDestination |
|
InventoryEncryption |
InventoryEncryption class |
|
InventoryFilter |
Class for InventoryFilter |
|
InventoryFilterPredicate |
Filter Predicate abstract class for specific filter types to be derived from. |
|
InventoryPrefixPredicate |
Class for InventoryPrefixPredicate The prefix that an object must have to be included in the inventory results. |
|
InventoryS3BucketDestination |
The InventoryS3BucketDestination contains information where the inventory results will be saved in S3. |
|
InventorySchedule |
Class for InventorySchedule |
|
JSONInput |
Specifies JSON as object's input serialization format. |
|
JSONOutput |
Specifies JSON as request's output serialization format |
|
KeyVersion |
Specifies an object key and optional object version. |
|
LambdaFunctionConfiguration |
This class contains the configuration Amazon S3 uses to figure out what events you want to listen and send the event to an Amazon Lambda cloud function. |
|
LifecycleAndOperator |
The logical and operator for filtering objects for a Amazon.S3.Model.LifecycleRule |
|
LifecycleConfiguration |
Container for lifecycle rules. You can add as many as 1000 rules. For more information see, Managing your storage lifecycle in the Amazon S3 User Guide. |
|
LifecycleFilter |
Filter identifying one or more objects to which a Amazon.S3.Model.LifecycleRule applies. |
|
LifecycleFilterPredicate |
Base class for all the different predicates that can be used in a Amazon.S3.Model.LifecycleRule filter. |
|
LifecycleNAryOperator |
Base class for lifecycle operators. |
|
LifecycleObjectSizeGreaterThanPredicate |
A predicate that filters objects for a Amazon.S3.Model.LifecycleRule by comparing object size greater then specified value. |
|
LifecycleObjectSizeLessThanPredicate |
A predicate that filters objects for a Amazon.S3.Model.LifecycleRule by comparing object size less then specified value. |
|
LifecyclePrefixPredicate |
A predicate that filters objects for a Amazon.S3.Model.LifecycleRule by matching a particular prefix. |
|
LifecycleRule |
A lifecycle rule for individual objects in an Amazon S3 bucket. For more information see, Managing your storage lifecycle in the Amazon S3 User Guide. |
|
LifecycleRuleAbortIncompleteMultipartUpload |
Specifies the days since the initiation of an Incomplete Multipart Upload that Lifecycle will wait before permanently removing all parts of the upload. |
|
LifecycleRuleExpiration |
Container for the expiration for the lifecycle of the object. For more information see, Managing your storage lifecycle in the Amazon S3 User Guide. |
|
LifecycleRuleNoncurrentVersionExpiration |
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. |
|
LifecycleRuleNoncurrentVersionTransition |
LifecycleTransition defines when and how objects transition. |
|
LifecycleTagPredicate |
A predicate that filters objects for a Amazon.S3.Model.LifecycleRule by matching a particular Amazon.S3.Model.LifecycleTagPredicate.Tag key and value. |
|
LifecycleTransition |
LifecycleTransition defines when and how objects transition. |
|
ListBucketAnalyticsConfigurationsRequest |
Container for the parameters to the ListBucketAnalyticsConfigurations operation.
This operation is not supported by directory buckets.
Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.
This action supports list pagination and does not return more than 100 configurations
at a time. You should always check the
To use this operation, you must have permissions to perform the For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.
The following operations are related to |
|
ListBucketAnalyticsConfigurationsResponse |
Returns information about the ListBucketAnalyticsConfigurationsResponse response and response metadata. |
|
ListBucketIntelligentTieringConfigurationsRequest |
Container for the parameters to the ListBucketIntelligentTieringConfigurations operation.
This operation is not supported by directory buckets.
Lists the S3 Intelligent-Tiering configuration from the specified bucket. 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 performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities. The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to |
|
ListBucketIntelligentTieringConfigurationsResponse |
Response for the ListBucketIntelligentTieringConfigurations operation. |
|
ListBucketInventoryConfigurationsRequest |
Container for the parameters to the ListBucketInventoryConfigurations operation.
This operation is not supported by directory buckets.
Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.
This action supports list pagination and does not return more than 100 configurations
at a time. Always check the
To use this operation, you must have permissions to perform the For information about the Amazon S3 inventory feature, see Amazon S3 Inventory
The following operations are related to |
|
ListBucketInventoryConfigurationsResponse |
Returns information about the ListInventoryConfigurationsResponse response and response metadata. |
|
ListBucketMetricsConfigurationsRequest |
Container for the parameters to the ListBucketMetricsConfigurations operation.
This operation is not supported by directory buckets.
Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket.
This action supports list pagination and does not return more than 100 configurations
at a time. Always check the
To use this operation, you must have permissions to perform the For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to |
|
ListBucketMetricsConfigurationsResponse |
Returns information about the ListBucketMetricsConfiguration response and response metadata. |
|
ListBucketsRequest |
Container for the parameters to the ListBuckets operation.
This operation is not supported by directory buckets.
Returns a list of all buckets owned by the authenticated sender of the request. To
use this operation, you must have the For information about Amazon S3 buckets, see Creating, configuring, and working with Amazon S3 buckets. |
|
ListBucketsResponse |
Returns information about the ListBuckets response and response metadata. |
|
ListDirectoryBucketsRequest |
Container for the parameters to the ListDirectoryBuckets operation.
Returns a list of all Amazon S3 directory buckets owned by the authenticated sender
of the request. For more information about directory buckets, see Directory
buckets in the Amazon S3 User Guide.
Directory buckets - For directory buckets, you must make requests for this
API operation to the Regional endpoint. These endpoints support path-style requests
in the format
|
|
ListDirectoryBucketsResponse |
This is the response object from the ListDirectoryBuckets operation. |
|
ListMultipartUploadsRequest |
Container for the parameters to the ListMultipartUploads operation.
This operation lists in-progress multipart uploads in a bucket. An in-progress multipart
upload is a multipart upload that has been initiated by the Directory buckets - If multipart uploads in a directory bucket are in progress,
you can't delete the bucket until all the in-progress multipart uploads are aborted
or completed.
The Directory buckets - The For more information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide. Directory buckets - For directory buckets, you must make requests for this
API operation to the Zonal endpoint. These endpoints support virtual-hosted-style
requests in the format
The following operations are related to |
|
ListMultipartUploadsResponse |
Returns information about the ListMultipartUploads response and response metadata. |
|
ListObjectsRequest |
Container for the parameters to the ListObjects operation.
This operation is not supported by directory buckets.
Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately.
This action has been revised. We recommend that you use the newer version, ListObjectsV2,
when developing applications. For backward compatibility, Amazon S3 continues to support
The following operations are related to |
|
ListObjectsResponse |
Returns information about the ListObjects response and response metadata. |
|
ListObjectsV2Request |
Container for the parameters to the ListObjectsV2 operation.
Returns some or all (up to 1,000) of the objects in a bucket with each request. You
can use the request parameters as selection criteria to return a subset of the objects
in a bucket. A Directory buckets - For directory buckets, you must make requests for this
API operation to the Zonal endpoint. These endpoints support virtual-hosted-style
requests in the format
This section describes the latest revision of this action. We recommend that you use this revised API operation for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API operation, ListObjects.
The following operations are related to |
|
ListObjectsV2Response |
Returns information about the ListObjects response and response metadata. |
|
ListPartsRequest |
Container for the parameters to the ListParts operation. Lists the parts that have been uploaded for a specific multipart upload.
To use this operation, you must provide the
The For more information on multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide. Directory buckets - For directory buckets, you must make requests for this
API operation to the Zonal endpoint. These endpoints support virtual-hosted-style
requests in the format
The following operations are related to |
|
ListPartsResponse |
Returns information about the ListParts response and response metadata. |
|
ListVersionsRequest |
Container for the parameters to the ListVersions operation.
This operation is not supported by directory buckets.
Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions.
To use this operation, you must have permission to perform the
A To use this operation, you must have READ access to the bucket.
The following operations are related to |
|
ListVersionsResponse |
Returns information about the ListVersions response and response metadata. |
|
LocationInfo |
Specifies the location where the bucket will be created. For directory buckets, the location type is Availability Zone. For more information about directory buckets, see Directory buckets in the Amazon S3 User Guide. This functionality is only supported by directory buckets. |
|
MetadataCollection |
This class contains the meta data for an S3 object. |
|
MetadataEntry |
A metadata key-value pair to store with an object. |
|
Metrics |
A container specifying settings for configuring replication metrics and events. |
|
MetricsAccessPointArnPredicate |
Class for MetricsAccessPointArnPredicate The access point arn used when evaluating a metrics filter. |
|
MetricsAndOperator |
Class for MetricsAndOperatorPredicate 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 |
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 |
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. |
|
MetricsFilterPredicate |
Filter Predicate abstract class for specific filter types to be derived from. |
|
MetricsNAryOperator |
Abstract class that can be used over logical filter predicates,i.e. AND/OR. |
|
MetricsPrefixPredicate |
Class for MetricsPrefixPredicate The prefix used when evaluating a metrics filter. |
|
MetricsTagPredicate |
Class for MetricsTagPredicate The tag used when evaluating a metrics filter. |
|
MfaCodes |
This class contains the mfa codes used authentication |
|
MultipartUpload |
Container for elements related to a particular multipart upload. |
|
NoSuchAccesspointException | ||
NoSuchBucketException |
The specified bucket does not exist. |
|
NotificationConfiguration |
An abstract class for all the notification configurations associated with an Amazon S3 bucket. |
|
ObjectLockConfiguration |
The container element for Object Lock configuration parameters. |
|
ObjectLockLegalHold |
A Legal Hold configuration for an object. |
|
ObjectLockRetention |
A Retention configuration for an object. |
|
ObjectLockRule |
The container element for an Object Lock rule. |
|
ObjectPart |
Container for elements related to an individual part. |
|
OutputLocation |
Describes the location where the restore job's output is stored. |
|
OutputSerialization |
Describes how results of the Select job are serialized. |
|
Owner |
The owner of an S3 bucket. |
|
OwnershipControls |
The container element for a bucket's ownership controls |
|
OwnershipControlsRule |
The container element for an ownership control rule |
|
ParameterCollection |
This class contains custom querystring parameters for an S3 object, which can then be signed as part of a Pre-signed URL request |
|
ParquetInput |
Specifies Parquet as object's input serialization format. |
|
PartDetail |
A container for elements related to a particular part in a multipart operation. A response can contain zero or more Part elements. |
|
PartETag |
A container holding the part number, etag, and optional checksum used when completing a multipart upload. |
|
PartitionedPrefix |
Amazon S3 keys for log objects are partitioned in the following format:
PartitionedPrefix defaults to EventTime delivery when server access logs are delivered. |
|
PolicyStatus |
The container element for this bucket's public-policy status. |
|
Progress |
The Progress event details. |
|
ProgressEvent |
The Progress Event. |
|
PublicAccessBlockConfiguration |
The container element for all Public Access Block configuration options. You can enable the configuration options in any combination. Amazon S3 considers a bucket policy public unless at least one of the following conditions is true:
"Bad actions" are those that could expose the data inside a bucket to reads or writes
by the public. These actions are
The star notation for bad actions indicates that all matching operations are considered
bad actions. For example, because |
|
PutACLRequest |
Container for the parameters to the PutACL operation.
This operation is not supported by directory buckets.
Sets the permissions on an existing bucket using access control lists (ACL). For more
information, see Using
ACLs. To set the ACL of a bucket, you must have the You can use one of the following two ways to set a bucket's permissions:
You cannot specify access permission using both the body and the request headers. Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.
If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs
are disabled and no longer affect permissions. You must use policies to grant access
to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and
return the
The following operations are related to |
|
PutACLResponse |
Returns information about the PutObjectAcl response metadata. The PutAcl operation has a void result type. |
|
PutBucketAccelerateConfigurationRequest |
Container for the parameters to the PutBucketAccelerateConfiguration operation.
This operation is not supported by directory buckets.
Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3.
To use this operation, you must have permission to perform the The Transfer Acceleration state of a bucket can be set to one of the following two values:
The GetBucketAccelerateConfiguration action returns the transfer acceleration state of a bucket. After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase. The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods ("."). For more information about transfer acceleration, see Transfer Acceleration.
The following operations are related to |
|
PutBucketAccelerateConfigurationResponse |
The response for the PutBucketAccelerateConfiguration operation. Adds an object to a bucket. |
|
PutBucketAnalyticsConfigurationRequest |
Container for the parameters to the PutBucketAnalyticsConfiguration operation.
This operation is not supported by directory buckets.
Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket.
You can choose to have storage class analysis export analysis reports sent to a comma-separated
values (CSV) flat file. See the You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
To use this operation, you must have permissions to perform the
The following operations are related to |
|
PutBucketAnalyticsConfigurationResponse |
Returns information about the PutBucketAnalyticsConfigurationResponse response metadata. The PutBucketAnalyticsConfigurationResponse operation has a void result type. |
|
PutBucketConfiguration |
The configuration information for a bucket |
|
PutBucketEncryptionRequest |
Container for the parameters to the PutBucketEncryption operation.
This operation is not supported by directory buckets.
This action uses the By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). You can optionally configure default encryption for a bucket by using server-side encryption with Key Management Service (KMS) keys (SSE-KMS) or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you specify default encryption by using SSE-KMS, you can also configure Amazon S3 Bucket Keys. If you use PutBucketEncryption to set your default bucket encryption to SSE-KMS, you should verify that your KMS key ID is correct. Amazon S3 does not validate the KMS key ID provided in PutBucketEncryption requests. This action requires Amazon Web Services Signature Version 4. For more information, see Authenticating Requests (Amazon Web Services Signature Version 4).
To use this operation, you must have permission to perform the
The following operations are related to |
|
PutBucketIntelligentTieringConfigurationRequest |
Container for the parameters to the PutBucketIntelligentTieringConfiguration operation.
This operation is not supported by directory buckets.
Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to 1,000 S3 Intelligent-Tiering configurations per bucket. 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 performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities. The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically move objects stored in the S3 Intelligent-Tiering storage class to the Archive Access or Deep Archive Access tier.
|
|
PutBucketIntelligentTieringConfigurationResponse |
Returns information about the PutBucketIntelligentTieringConfiguration response metadata. The PutBucketIntelligentTieringConfiguration operation has a void result type. |
|
PutBucketInventoryConfigurationRequest |
Container for the parameters to the PutBucketInventoryConfiguration operation.
This operation is not supported by directory buckets.
This implementation of the Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination bucket. The destination bucket must be in the same Amazon Web Services Region as the source bucket. When you configure an inventory for a source bucket, you specify the destination bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory in the Amazon S3 User Guide. You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
The following operations are related to |
|
PutBucketInventoryConfigurationResponse |
Returns information about the PutInventoryConfigurationResponse response metadata. The PutInventoryConfigurationResponse operation has a void result type. |
|
PutBucketLoggingRequest |
Container for the parameters to the PutBucketLogging operation.
This operation is not supported by directory buckets.
Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner.
The bucket owner is automatically granted FULL_CONTROL to all logs. You use the
If the target bucket for log delivery uses the bucket owner enforced setting for S3
Object Ownership, you can't use the
To enable logging, you use For more information about server access logging, see Server Access Logging in the Amazon S3 User Guide. For more information about creating a bucket, see CreateBucket. For more information about returning the logging status of a bucket, see GetBucketLogging.
The following operations are related to |
|
PutBucketLoggingResponse |
Returns information about the PutBucketLogging response metadata. The EnableBucketLogging operation has a void result type. |
|
PutBucketMetricsConfigurationRequest |
Container for the parameters to the PutBucketMetricsConfiguration operation.
This operation is not supported by directory buckets.
Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per 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.
To use this operation, you must have permissions to perform the For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to
|
|
PutBucketMetricsConfigurationResponse |
Returns information about the PutBucketMetricsConfiguration response metadata. The PutBucketMetricsConfiguration operation has a void result type. |
|
PutBucketNotificationRequest |
Container for the parameters to the PutBucketNotification operation.
This operation is not supported by directory buckets.
Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications. Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.
By default, your bucket has no event notifications configured. That is, the notification
configuration will be an empty This action replaces the existing notification configuration with the configuration you include in the request body. After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events. You can disable notifications by adding the empty NotificationConfiguration element. For more information about the number of event notification configurations that you can create per bucket, see Amazon S3 service quotas in Amazon Web Services General Reference.
By default, only the bucket owner can configure notifications on a bucket. However,
bucket owners can use a bucket policy to grant permission to other users to set this
configuration with the required The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the configuration to your bucket.
If the configuration in the request body includes only one
The following action is related to |
|
PutBucketNotificationResponse |
Returns information about the PutBucketNotification response metadata. The PutBucketNotification operation has a void result type. |
|
PutBucketOwnershipControlsRequest |
Container for the parameters to the PutBucketOwnershipControls operation.
This operation is not supported by directory buckets.
Creates or modifies For information about Amazon S3 Object Ownership, see Using object ownership.
The following operations are related to |
|
PutBucketOwnershipControlsResponse |
Returns information about the PutBucketOwnershipControls response metadata. The PutBucketOwnershipControls operation has a void result type. |
|
PutBucketPolicyRequest |
Container for the parameters to the PutBucketPolicy operation.
Applies an Amazon S3 bucket policy to an Amazon S3 bucket.
Directory buckets - For directory buckets, you must make requests for this
API operation to the Regional endpoint. These endpoints support path-style requests
in the format
The following operations are related to |
|
PutBucketPolicyResponse |
Returns information about the PutBucketPolicy response metadata. The PutBucketPolicy operation has a void result type. |
|
PutBucketReplicationRequest |
Container for the parameters to the PutBucketReplication operation.
This operation is not supported by directory buckets.
Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 User Guide.
Specify the replication configuration in the request body. In the replication configuration,
you provide the name of the destination bucket or buckets where you want Amazon S3
to replicate objects, the IAM role that Amazon S3 can assume to replicate objects
on your behalf, and other relevant information. You can invoke this request for a
specific Amazon Web Services Region by using the A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset.
To specify a subset of the objects in the source bucket to apply a replication rule
to, add the Filter element as a child of the Rule element. You can filter objects
based on an object key prefix, one or more object tags, or both. When you add the
Filter element in the configuration, you must also add the following elements: 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. For information about enabling versioning on a bucket, see Using Versioning.
The following operations are related to |
|
PutBucketReplicationResponse |
Returns information about the PutBucketReplicationConfiguration response metadata. The PutBucketReplicationConfiguration operation has a void result type. |
|
PutBucketRequest |
Container for the parameters to the PutBucket operation.
This action creates an Amazon S3 bucket. To create an Amazon S3 on Outposts bucket,
see Creates a new S3 bucket. To create a bucket, you must set up Amazon S3 and have a valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner. There are two types of buckets: general purpose buckets and directory buckets. For more information about these bucket types, see Creating, configuring, and working with Amazon S3 buckets in the Amazon S3 User Guide.
The following operations are related to |
|
PutBucketRequestPaymentRequest |
Container for the parameters to the PutBucketRequestPayment operation.
This operation is not supported by directory buckets.
Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see Requester Pays Buckets.
The following operations are related to |
|
PutBucketRequestPaymentResponse |
Returns information about the PutBucketRequestPayment response metadata. The PutBucketRequestPayment operation has a void result type. |
|
PutBucketResponse |
Returns information about the PutBucket response and response metadata. |
|
PutBucketTaggingRequest |
Container for the parameters to the PutBucketTagging operation.
This operation is not supported by directory buckets.
Sets the tags for a bucket. Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost Allocation and Tagging and Using Cost Allocation in Amazon S3 Bucket Tags. When this operation sets the tags for a bucket, it will overwrite any current tags the bucket already has. You cannot use this operation to add tags to an existing list of tags.
To use this operation, you must have permissions to perform the
The following operations are related to |
|
PutBucketTaggingResponse |
Returns information about the PutBucketTagging response metadata. The PutBucketTagging operation has a void result type. |
|
PutBucketVersioningRequest |
Container for the parameters to the PutBucketVersioning operation.
This operation is not supported by directory buckets.
Sets the versioning state of an existing bucket. You can set the versioning state with one of the following values: Enabled�Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID. Suspended�Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null. If the versioning state has never been set on a bucket, it has no versioning state; a GetBucketVersioning request does not return a versioning state value.
In order to enable MFA Delete, you must be the bucket owner. If you are the bucket
owner and want to enable MFA Delete in the bucket versioning configuration, you must
include the If you have an object expiration lifecycle configuration in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning.
The following operations are related to |
|
PutBucketVersioningResponse |
Returns information about the PutBucketVersioning response metadata. The PutBucketVersioning operation has a void result type. |
|
PutBucketWebsiteRequest |
Container for the parameters to the PutBucketWebsite operation.
This operation is not supported by directory buckets.
Sets the configuration of the website that is specified in the
This PUT action requires the To redirect all website requests sent to the bucket's website endpoint, you add a website configuration with the following elements. Because all requests are sent to another website, you don't need to provide index document name for the bucket.
If you want granular control over redirects, you can use the following elements to add routing rules that describe conditions for redirecting requests and information about the redirect destination. In this case, the website configuration must provide an index document for the bucket, because some requests might not be redirected.
Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more than 50 routing rules, you can use object redirect. For more information, see Configuring an Object Redirect in the Amazon S3 User Guide. The maximum request length is limited to 128 KB. |
|
PutBucketWebsiteResponse |
Returns information about the PutBucketWebsite response metadata. The PutBucketWebsite operation has a void result type. |
|
PutCORSConfigurationRequest |
Container for the parameters to the PutCORSConfiguration operation.
This operation is not supported by directory buckets.
Sets the
To use this operation, you must be allowed to perform the
You set this configuration on a bucket so that the bucket can service cross-origin
requests. For example, you might want to enable a request whose origin is
To enable cross-origin resource sharing (CORS) on a bucket, you add the
When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against
a bucket, it evaluates the
For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.
The following operations are related to |
|
PutCORSConfigurationResponse |
Returns information about the PutCORSConfiguration response metadata. The PutCORSConfiguration operation has a void result type. |
|
PutLifecycleConfigurationRequest |
Container for the parameters to the PutLifecycleConfiguration operation.
This operation is not supported by directory buckets.
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. Keep in mind that this will overwrite an existing lifecycle configuration, so if you want to retain any configuration details, they must be included in the new lifecycle configuration. For information about lifecycle configuration, see Managing your storage lifecycle. Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, object size, or any combination of these. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle.
The following operations are related to |
|
PutLifecycleConfigurationResponse |
Returns information about the PutLifecycleConfiguration response metadata. The PutLifecycleConfiguration operation has a void result type. |
|
PutObjectLegalHoldRequest |
Container for the parameters to the PutObjectLegalHold operation.
This operation is not supported by directory buckets.
Applies a legal hold configuration to the specified object. For more information, see Locking Objects. This functionality is not supported for Amazon S3 on Outposts. |
|
PutObjectLegalHoldResponse |
This is the response object from the PutObjectLegalHold operation. |
|
PutObjectLockConfigurationRequest |
Container for the parameters to the PutObjectLockConfiguration operation.
This operation is not supported by directory buckets.
Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.
|
|
PutObjectLockConfigurationResponse |
This is the response object from the PutObjectLockConfiguration operation. |
|
PutObjectRequest |
Container for the parameters to the PutObject operation.
Adds an object to a bucket.
Amazon S3 never adds partial objects; if you receive a success response, Amazon S3
added the entire object to the bucket. You cannot use
If your bucket uses the bucket owner enforced setting for Object Ownership, ACLs are
disabled and no longer affect permissions. All objects written to the bucket by any
account will be owned by the bucket owner.
Directory buckets - For directory buckets, you must make requests for this
API operation to the Zonal endpoint. These endpoints support virtual-hosted-style
requests in the format Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. However, Amazon S3 provides features that can modify this behavior:
For more information about related Amazon S3 APIs, see the following: |
|
PutObjectResponse |
Returns information about the PutObject response and response metadata. |
|
PutObjectRetentionRequest |
Container for the parameters to the PutObjectRetention operation.
This operation is not supported by directory buckets.
Places an Object Retention configuration on an object. For more information, see Locking Objects.
Users or accounts require the This functionality is not supported for Amazon S3 on Outposts. |
|
PutObjectRetentionResponse |
This is the response object from the PutObjectRetention operation. |
|
PutObjectTaggingRequest |
Container for the parameters to the PutObjectTagging operation.
This operation is not supported by directory buckets.
Sets the supplied tag-set to an object that already exists in a bucket. A tag is a key-value pair. For more information, see Object Tagging. You can associate tags with an object by sending a PUT request against the tagging subresource that is associated with the object. You can retrieve tags by sending a GET request. For more information, see GetObjectTagging. For tagging-related restrictions related to characters and encodings, see Tag Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per object.
To use this operation, you must have permission to perform the
To put tags of any other version, use the
The following operations are related to |
|
PutObjectTaggingResponse |
Returns information about the PutObjectTagging response and response metadata. |
|
PutPublicAccessBlockRequest |
Container for the parameters to the PutPublicAccessBlock operation.
This operation is not supported by directory buckets.
Creates or modifies the
When Amazon S3 evaluates the For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public".
The following operations are related to |
|
PutPublicAccessBlockResponse |
This is the response object from the PutPublicAccessBlock operation. |
|
PutWithACLRequest |
Base class for put operations that can also put an ACL. |
|
QueueConfiguration |
This class contains the configuration Amazon S3 uses to figure out what events you want to listen and send the event to an Amazon SQS queue. The queue's policy must allow S3 to send messages to it. The utility method Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(string,string) can be used to help setup the queue policy. |
|
RecordsEvent |
The Records Event |
|
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 If you don't specify the |
|
ReplicationConfiguration |
This class defines the configuration for replication. |
|
ReplicationDestination |
Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC). |
|
ReplicationRule |
Rule that specifies the replication configuration. |
|
ReplicationRuleAndOperator | ||
ReplicationRuleFilter |
Filter that identifies subset of objects to which the replication rule applies.
A |
|
ReplicationTime |
A container specifying the time when all objects and operations on objects are replicated. Must be specified together with a |
|
ReplicationTimeValue |
A container specifying the time value. |
|
RequestPaymentConfiguration |
Request Payment Configuration |
|
ResponseHeaderOverrides |
Container for values of the response headers that will be set on a response from a GetObject request. These values override any headers that were set when the object was uploaded to S3. |
|
RestoreObjectRequest |
Container for the parameters to the RestoreObject operation.
This operation is not supported by directory buckets.
Restores an archived copy of an object back into Amazon S3 This functionality is not supported for Amazon S3 on Outposts. This action performs the following types of requests:
For more information about the
The following operations are related to |
|
RestoreObjectResponse |
Returns information about the RestoreObject response metadata. The RestoreObject operation has a void result type. |
|
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.
This functionality is not supported for directory buckets. Only the S3 Express One
Zone storage class is supported by directory buckets to store objects.
|
|
RoutingRule |
Routing Rule |
|
RoutingRuleCondition |
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. |
|
RoutingRuleRedirect |
Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can can specify a different error code to return. |
|
S3AccessControlList |
Represents an access control list (ACL) for S3. An AccessControlList is represented by an Owner, and a List of Grants, where each Grant is a Grantee and a Permission. |
|
S3Bucket |
In terms of implementation, a Bucket is a resource. An Amazon S3 bucket name is globally unique, and the namespace is shared by all Amazon Web Services accounts. |
|
S3BucketLoggingConfig |
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. |
|
S3BucketVersioningConfig |
Describes the versioning state of an Amazon S3 bucket. For more information, see PUT Bucket versioning in the Amazon S3 API Reference. |
|
S3Encryption |
Describes the server-side encryption that will be applied to the restore results. |
|
S3EventStreamException |
Modeled Exception that either comes over the stream from the service model, or wraps other exceptions for the purpose of raising events. If it is modelled, it will be a subclass. |
|
S3Grant |
Container for granting information. Buckets that use the bucket owner enforced setting for Object Ownership don't support target grants. For more information, see Permissions server access log delivery in the Amazon S3 User Guide. |
|
S3Grantee |
Grantee |
|
S3KeyFilter |
Filter criteria that allows for event notification filtering based on an S3 Object's key name. |
|
S3Location |
Describes an S3 location that will receive the results of the restore request. |
|
S3Object |
Represents an S3 Object. Contains all attributes that an S3 Object has. For more information about S3 Objects refer: http://docs.amazonwebservices.com/AmazonS3/latest/UsingObjects.html |
|
S3ObjectVersion |
Represents a version of an object in an S3 Bucket. An S3 object version is an S3 object that also has a version identifier, an indication of whether this is the latest version of the object and whether it's a DeleteMarker or not. |
|
S3PaginatorFactory |
Paginators for the S3 service |
|
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. |
|
SelectObjectContentEventStream |
A Stream of Events returned by the SelectObjectContent operation. Events can be retrieved from this stream by either
|
|
SelectObjectContentRequest |
Container for the parameters to the SelectObjectContent operation.
This operation is not supported by directory buckets.
This action filters 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 also specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses this format to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response. This functionality is not supported for Amazon S3 on Outposts. For more information about Amazon S3 Select, see Selecting Content from Objects and SELECT Command in the Amazon S3 User Guide.
The following operations are related to |
|
SelectObjectContentResponse |
Contains the response Payload for the SelectObjectContent request |
|
SelectParameters |
Describes the parameters for Select job types. |
|
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 |
ServerSideEncryptionConfiguration class |
|
ServerSideEncryptionRule |
Specifies the default server-side encryption configuration.
|
|
SessionCredentials |
The established temporary security credentials of the session.
Directory buckets - These session credentials are only supported for the authentication
and authorization of Zonal endpoint APIs on directory buckets.
|
|
SimplePrefix |
To use simple format for S3 keys for log objects.
|
|
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 |
SSEKMS class |
|
SseKmsEncryptedObjects |
A container for filter information for the selection of S3 objects encrypted with Amazon Web Services KMS. |
|
SSES3 |
SSES3 class |
|
Stats |
The Stats event details. |
|
StatsEvent |
The Stats Event. |
|
StorageClassAnalysis |
Class for StorageClassAnalysis |
|
StorageClassAnalysisDataExport |
Class for StorageClassAnalysisDataExport |
|
StreamResponse |
Base class for responses that return a stream. |
|
StreamSizeMismatchException |
The exception that is thrown when the size of a stream does not match it's expected size. |
|
Tag |
Tag is a key-value pair of metadata associated with an S3Object |
|
Tagging |
Structure that contains list of Tags |
|
TargetObjectKeyFormat |
Amazon S3 key format for log objects. Only one format, PartitionedPrefix or SimplePrefix, is allowed. |
|
Tiering |
The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. |
|
TopicConfiguration |
This class contains the configuration Amazon S3 uses to figure out what events you want to listen and send the event to an Amazon SNS topic. The topic's policy must allow S3 to publish messages to it. The utility method Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(string,string) can be used to help setup the topic policy. |
|
TransferProgressArgs |
Arguments containing event details for an in-flight transfer. |
|
UnknownEventStreamEvent |
This Event is returned if an event is retrieved from the event stream, but a generator function for the event is not defined. |
|
UploadPartRequest |
Container for the parameters to the UploadPart operation.
Uploads a part in a multipart upload.
In this operation, you provide new data as a part of an object in your request. However,
you have an option to specify your existing Amazon S3 object as a data source for
the part you are uploading. To upload a part from an existing object, you use the
UploadPartCopy
operation.
You must initiate a multipart upload (see CreateMultipartUpload) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier that you must include in your upload part request. Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten. For information about maximum and minimum part sizes and other multipart upload specifications, see Multipart upload limits in the Amazon S3 User Guide. After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage. For more information on multipart uploads, go to Multipart Upload Overview in the Amazon S3 User Guide . Directory buckets - For directory buckets, you must make requests for this
API operation to the Zonal endpoint. These endpoints support virtual-hosted-style
requests in the format
The following operations are related to |
|
UploadPartResponse |
Returns information about the UploadPart response and response metadata. |
|
WebsiteConfiguration |
Website Configuration |
|
WriteGetObjectResponseRequest |
Container for the parameters to the WriteGetObjectResponse operation.
This operation is not supported by directory buckets.
Passes transformed objects to a
This operation supports metadata that can be returned by GetObject,
in addition to
You can include any number of metadata headers. When including a metadata header,
it should be prefaced with x-amz-meta-my-custom-header: MyCustomValue. The primary use case for this is to forward GetObject
metadata.
Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to detect and redact personally identifiable information (PII) and decompress S3 objects. These Lambda functions are available in the Amazon Web Services Serverless Application Repository, and can be selected through the Amazon Web Services Management Console when you create your Object Lambda access point. Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically detects personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket. Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically redacts personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket. Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped to decompress objects stored in S3 in one of six compressed file formats including bzip2, gzip, snappy, zlib, zstandard and ZIP. For information on how to view and use these functions, see Using Amazon Web Services built Lambda functions in the Amazon S3 User Guide. |
|
WriteGetObjectResponseResponse |
Response for WriteGetObjectResponse operation |
|
WriteObjectProgressArgs |
Encapsulates the information needed to provide download progress for the Write Object Event. |
Name | Description | |
---|---|---|
IListBucketsPaginator |
Paginator for the ListBuckets operation |
|
IListMultipartUploadsPaginator |
Paginator for the ListMultipartUploads operation |
|
IListObjectsPaginator |
Paginator for the ListObjects operation |
|
IListObjectsV2Paginator |
Paginator for the ListObjectsV2 operation |
|
IListPartsPaginator |
Paginator for the ListParts operation |
|
IListVersionsPaginator |
Paginator for the ListVersions operation |
|
IS3Event |
Common Contract for S3 Events. |
|
IS3PaginatorFactory |
Paginators for the S3 service |
|
ISelectObjectContentEventStream |
The contract for the SelectObjectContentEventStream. |