Class: Aws::S3::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::S3::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-s3/client.rb
Overview
An API client for S3. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::S3::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#abort_multipart_upload(params = {}) ⇒ Types::AbortMultipartUploadOutput
This action aborts a multipart upload.
-
#complete_multipart_upload(params = {}) ⇒ Types::CompleteMultipartUploadOutput
Completes a multipart upload by assembling previously uploaded parts.
-
#copy_object(params = {}) ⇒ Types::CopyObjectOutput
Creates a copy of an object that is already stored in Amazon S3.
-
#create_bucket(params = {}) ⇒ Types::CreateBucketOutput
Creates a new S3 bucket.
-
#create_multipart_upload(params = {}) ⇒ Types::CreateMultipartUploadOutput
This action initiates a multipart upload and returns an upload ID.
-
#delete_bucket(params = {}) ⇒ Struct
Deletes the S3 bucket.
-
#delete_bucket_analytics_configuration(params = {}) ⇒ Struct
Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).
-
#delete_bucket_cors(params = {}) ⇒ Struct
Deletes the ‘cors` configuration information set for the bucket.
-
#delete_bucket_encryption(params = {}) ⇒ Struct
This implementation of the DELETE action removes default encryption from the bucket.
-
#delete_bucket_intelligent_tiering_configuration(params = {}) ⇒ Struct
Deletes the S3 Intelligent-Tiering configuration from the specified bucket.
-
#delete_bucket_inventory_configuration(params = {}) ⇒ Struct
Deletes an inventory configuration (identified by the inventory ID) from the bucket.
-
#delete_bucket_lifecycle(params = {}) ⇒ Struct
Deletes the lifecycle configuration from the specified bucket.
-
#delete_bucket_metrics_configuration(params = {}) ⇒ Struct
Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket.
-
#delete_bucket_ownership_controls(params = {}) ⇒ Struct
Removes ‘OwnershipControls` for an Amazon S3 bucket.
-
#delete_bucket_policy(params = {}) ⇒ Struct
This implementation of the DELETE action uses the policy subresource to delete the policy of a specified bucket.
-
#delete_bucket_replication(params = {}) ⇒ Struct
Deletes the replication configuration from the bucket.
-
#delete_bucket_tagging(params = {}) ⇒ Struct
Deletes the tags from the bucket.
-
#delete_bucket_website(params = {}) ⇒ Struct
This action removes the website configuration for a bucket.
-
#delete_object(params = {}) ⇒ Types::DeleteObjectOutput
Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object.
-
#delete_object_tagging(params = {}) ⇒ Types::DeleteObjectTaggingOutput
Removes the entire tag set from the specified object.
-
#delete_objects(params = {}) ⇒ Types::DeleteObjectsOutput
This action enables you to delete multiple objects from a bucket using a single HTTP request.
-
#delete_public_access_block(params = {}) ⇒ Struct
Removes the ‘PublicAccessBlock` configuration for an Amazon S3 bucket.
-
#get_bucket_accelerate_configuration(params = {}) ⇒ Types::GetBucketAccelerateConfigurationOutput
This implementation of the GET action uses the ‘accelerate` subresource to return the Transfer Acceleration state of a bucket, which is either `Enabled` or `Suspended`.
-
#get_bucket_acl(params = {}) ⇒ Types::GetBucketAclOutput
This implementation of the ‘GET` action uses the `acl` subresource to return the access control list (ACL) of a bucket.
-
#get_bucket_analytics_configuration(params = {}) ⇒ Types::GetBucketAnalyticsConfigurationOutput
This implementation of the GET action returns an analytics configuration (identified by the analytics configuration ID) from the bucket.
-
#get_bucket_cors(params = {}) ⇒ Types::GetBucketCorsOutput
Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the bucket.
-
#get_bucket_encryption(params = {}) ⇒ Types::GetBucketEncryptionOutput
Returns the default encryption configuration for an Amazon S3 bucket.
-
#get_bucket_intelligent_tiering_configuration(params = {}) ⇒ Types::GetBucketIntelligentTieringConfigurationOutput
Gets the S3 Intelligent-Tiering configuration from the specified bucket.
-
#get_bucket_inventory_configuration(params = {}) ⇒ Types::GetBucketInventoryConfigurationOutput
Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.
-
#get_bucket_lifecycle(params = {}) ⇒ Types::GetBucketLifecycleOutput
For an updated version of this API, see [GetBucketLifecycleConfiguration].
-
#get_bucket_lifecycle_configuration(params = {}) ⇒ Types::GetBucketLifecycleConfigurationOutput
<note markdown=“1”> Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both.
-
#get_bucket_location(params = {}) ⇒ Types::GetBucketLocationOutput
Returns the Region the bucket resides in.
-
#get_bucket_logging(params = {}) ⇒ Types::GetBucketLoggingOutput
Returns the logging status of a bucket and the permissions users have to view and modify that status.
-
#get_bucket_metrics_configuration(params = {}) ⇒ Types::GetBucketMetricsConfigurationOutput
Gets a metrics configuration (specified by the metrics configuration ID) from the bucket.
-
#get_bucket_notification(params = {}) ⇒ Types::NotificationConfigurationDeprecated
No longer used, see [GetBucketNotificationConfiguration].
-
#get_bucket_notification_configuration(params = {}) ⇒ Types::NotificationConfiguration
Returns the notification configuration of a bucket.
-
#get_bucket_ownership_controls(params = {}) ⇒ Types::GetBucketOwnershipControlsOutput
Retrieves ‘OwnershipControls` for an Amazon S3 bucket.
-
#get_bucket_policy(params = {}) ⇒ Types::GetBucketPolicyOutput
Returns the policy of a specified bucket.
-
#get_bucket_policy_status(params = {}) ⇒ Types::GetBucketPolicyStatusOutput
Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.
-
#get_bucket_replication(params = {}) ⇒ Types::GetBucketReplicationOutput
Returns the replication configuration of a bucket.
-
#get_bucket_request_payment(params = {}) ⇒ Types::GetBucketRequestPaymentOutput
Returns the request payment configuration of a bucket.
-
#get_bucket_tagging(params = {}) ⇒ Types::GetBucketTaggingOutput
Returns the tag set associated with the bucket.
-
#get_bucket_versioning(params = {}) ⇒ Types::GetBucketVersioningOutput
Returns the versioning state of a bucket.
-
#get_bucket_website(params = {}) ⇒ Types::GetBucketWebsiteOutput
Returns the website configuration for a bucket.
-
#get_object(params = {}) ⇒ Types::GetObjectOutput
Retrieves objects from Amazon S3.
-
#get_object_acl(params = {}) ⇒ Types::GetObjectAclOutput
Returns the access control list (ACL) of an object.
-
#get_object_attributes(params = {}) ⇒ Types::GetObjectAttributesOutput
Retrieves all the metadata from an object without returning the object itself.
-
#get_object_legal_hold(params = {}) ⇒ Types::GetObjectLegalHoldOutput
Gets an object’s current legal hold status.
-
#get_object_lock_configuration(params = {}) ⇒ Types::GetObjectLockConfigurationOutput
Gets the Object Lock configuration for a bucket.
-
#get_object_retention(params = {}) ⇒ Types::GetObjectRetentionOutput
Retrieves an object’s retention settings.
-
#get_object_tagging(params = {}) ⇒ Types::GetObjectTaggingOutput
Returns the tag-set of an object.
-
#get_object_torrent(params = {}) ⇒ Types::GetObjectTorrentOutput
Returns torrent files from a bucket.
-
#get_public_access_block(params = {}) ⇒ Types::GetPublicAccessBlockOutput
Retrieves the ‘PublicAccessBlock` configuration for an Amazon S3 bucket.
-
#head_bucket(params = {}) ⇒ Struct
This action is useful to determine if a bucket exists and you have permission to access it.
-
#head_object(params = {}) ⇒ Types::HeadObjectOutput
The HEAD action retrieves metadata from an object without returning the object itself.
-
#list_bucket_analytics_configurations(params = {}) ⇒ Types::ListBucketAnalyticsConfigurationsOutput
Lists the analytics configurations for the bucket.
-
#list_bucket_intelligent_tiering_configurations(params = {}) ⇒ Types::ListBucketIntelligentTieringConfigurationsOutput
Lists the S3 Intelligent-Tiering configuration from the specified bucket.
-
#list_bucket_inventory_configurations(params = {}) ⇒ Types::ListBucketInventoryConfigurationsOutput
Returns a list of inventory configurations for the bucket.
-
#list_bucket_metrics_configurations(params = {}) ⇒ Types::ListBucketMetricsConfigurationsOutput
Lists the metrics configurations for the bucket.
-
#list_buckets(params = {}) ⇒ Types::ListBucketsOutput
Returns a list of all buckets owned by the authenticated sender of the request.
-
#list_multipart_uploads(params = {}) ⇒ Types::ListMultipartUploadsOutput
This action lists in-progress multipart uploads.
-
#list_object_versions(params = {}) ⇒ Types::ListObjectVersionsOutput
Returns metadata about all versions of the objects in a bucket.
-
#list_objects(params = {}) ⇒ Types::ListObjectsOutput
Returns some or all (up to 1,000) of the objects in a bucket.
-
#list_objects_v2(params = {}) ⇒ Types::ListObjectsV2Output
Returns some or all (up to 1,000) of the objects in a bucket with each request.
-
#list_parts(params = {}) ⇒ Types::ListPartsOutput
Lists the parts that have been uploaded for a specific multipart upload.
-
#put_bucket_accelerate_configuration(params = {}) ⇒ Struct
Sets the accelerate configuration of an existing bucket.
-
#put_bucket_acl(params = {}) ⇒ Struct
Sets the permissions on an existing bucket using access control lists (ACL).
-
#put_bucket_analytics_configuration(params = {}) ⇒ Struct
Sets an analytics configuration for the bucket (specified by the analytics configuration ID).
-
#put_bucket_cors(params = {}) ⇒ Struct
Sets the ‘cors` configuration for your bucket.
-
#put_bucket_encryption(params = {}) ⇒ Struct
This action uses the ‘encryption` subresource to configure default encryption and Amazon S3 Bucket Key for an existing bucket.
-
#put_bucket_intelligent_tiering_configuration(params = {}) ⇒ Struct
Puts a S3 Intelligent-Tiering configuration to the specified bucket.
-
#put_bucket_inventory_configuration(params = {}) ⇒ Struct
This implementation of the ‘PUT` action adds an inventory configuration (identified by the inventory ID) to the bucket.
-
#put_bucket_lifecycle(params = {}) ⇒ Struct
For an updated version of this API, see [PutBucketLifecycleConfiguration].
-
#put_bucket_lifecycle_configuration(params = {}) ⇒ Struct
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration.
-
#put_bucket_logging(params = {}) ⇒ Struct
Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters.
-
#put_bucket_metrics_configuration(params = {}) ⇒ Struct
Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.
-
#put_bucket_notification(params = {}) ⇒ Struct
No longer used, see the [PutBucketNotificationConfiguration] operation.
-
#put_bucket_notification_configuration(params = {}) ⇒ Struct
Enables notifications of specified events for a bucket.
-
#put_bucket_ownership_controls(params = {}) ⇒ Struct
Creates or modifies ‘OwnershipControls` for an Amazon S3 bucket.
-
#put_bucket_policy(params = {}) ⇒ Struct
Applies an Amazon S3 bucket policy to an Amazon S3 bucket.
-
#put_bucket_replication(params = {}) ⇒ Struct
Creates a replication configuration or replaces an existing one.
-
#put_bucket_request_payment(params = {}) ⇒ Struct
Sets the request payment configuration for a bucket.
-
#put_bucket_tagging(params = {}) ⇒ Struct
Sets the tags for a bucket.
-
#put_bucket_versioning(params = {}) ⇒ Struct
Sets the versioning state of an existing bucket.
-
#put_bucket_website(params = {}) ⇒ Struct
Sets the configuration of the website that is specified in the ‘website` subresource.
-
#put_object(params = {}) ⇒ Types::PutObjectOutput
Adds an object to a bucket.
-
#put_object_acl(params = {}) ⇒ Types::PutObjectAclOutput
Uses the ‘acl` subresource to set the access control list (ACL) permissions for a new or existing object in an S3 bucket.
-
#put_object_legal_hold(params = {}) ⇒ Types::PutObjectLegalHoldOutput
Applies a legal hold configuration to the specified object.
-
#put_object_lock_configuration(params = {}) ⇒ Types::PutObjectLockConfigurationOutput
Places an Object Lock configuration on the specified bucket.
-
#put_object_retention(params = {}) ⇒ Types::PutObjectRetentionOutput
Places an Object Retention configuration on an object.
-
#put_object_tagging(params = {}) ⇒ Types::PutObjectTaggingOutput
Sets the supplied tag-set to an object that already exists in a bucket.
-
#put_public_access_block(params = {}) ⇒ Struct
Creates or modifies the ‘PublicAccessBlock` configuration for an Amazon S3 bucket.
-
#restore_object(params = {}) ⇒ Types::RestoreObjectOutput
Restores an archived copy of an object back into Amazon S3.
-
#select_object_content(params = {}) ⇒ Types::SelectObjectContentOutput
This action filters the contents of an Amazon S3 object based on a simple structured query language (SQL) statement.
-
#upload_part(params = {}) ⇒ Types::UploadPartOutput
Uploads a part in a multipart upload.
-
#upload_part_copy(params = {}) ⇒ Types::UploadPartCopyOutput
Uploads a part by copying data from an existing object as data source.
-
#write_get_object_response(params = {}) ⇒ Struct
Passes transformed objects to a ‘GetObject` operation when using Object Lambda access points.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
451 452 453 |
# File 'lib/aws-sdk-s3/client.rb', line 451 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
15489 15490 15491 |
# File 'lib/aws-sdk-s3/client.rb', line 15489 def identifier @identifier end |
Class Method Details
Instance Method Details
#abort_multipart_upload(params = {}) ⇒ Types::AbortMultipartUploadOutput
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 ‘AbortMultipartUpload`:
- CreateMultipartUpload][3
- UploadPart][4
- CompleteMultipartUpload][5
- ListParts][1
- ListMultipartUploads][6
[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
577 578 579 580 |
# File 'lib/aws-sdk-s3/client.rb', line 577 def abort_multipart_upload(params = {}, = {}) req = build_request(:abort_multipart_upload, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
15348 15349 15350 15351 15352 15353 15354 15355 15356 15357 15358 15359 |
# File 'lib/aws-sdk-s3/client.rb', line 15348 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-s3' context[:gem_version] = '1.117.1' Seahorse::Client::Request.new(handlers, context) end |
#complete_multipart_upload(params = {}) ⇒ Types::CompleteMultipartUploadOutput
Completes a multipart upload by assembling previously uploaded parts.
You first initiate the multipart upload and then upload all parts using the [UploadPart] operation. After successfully uploading all relevant parts of an upload, you call this action to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the Complete Multipart Upload request, you must provide the parts list. You must ensure that the parts list is complete. This action concatenates the parts that you provide in the list. For each part in the list, you must provide the part number and the ‘ETag` value, returned after that part was uploaded.
Processing of a Complete Multipart Upload request could take several minutes to complete. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. Because a request could fail after the initial 200 OK response has been sent, it is important that you check the response body to determine whether the request succeeded.
Note that if ‘CompleteMultipartUpload` fails, applications should be prepared to retry the failed requests. For more information, see [Amazon S3 Error Best Practices].
You cannot use ‘Content-Type: application/x-www-form-urlencoded` with Complete Multipart Upload requests. Also, if you do not provide a `Content-Type` header, `CompleteMultipartUpload` returns a 200 OK response.
For more information about multipart uploads, see [Uploading Objects Using Multipart Upload].
For information about permissions required to use the multipart upload API, see [Multipart Upload and Permissions].
‘CompleteMultipartUpload` has the following special errors:
-
Error code: ‘EntityTooSmall`
-
Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part.
-
400 Bad Request
-
-
Error code: ‘InvalidPart`
-
Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part’s entity tag.
-
400 Bad Request
-
-
Error code: ‘InvalidPartOrder`
-
Description: The list of parts was not in ascending order. The parts list must be specified in order by part number.
-
400 Bad Request
-
-
Error code: ‘NoSuchUpload`
-
Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.
-
404 Not Found
-
The following operations are related to ‘CompleteMultipartUpload`:
- CreateMultipartUpload][5
- UploadPart][1
- AbortMultipartUpload][6
- ListParts][7
- ListMultipartUploads][8
[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html [4]: docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html [8]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
897 898 899 900 |
# File 'lib/aws-sdk-s3/client.rb', line 897 def complete_multipart_upload(params = {}, = {}) req = build_request(:complete_multipart_upload, params) req.send_request() end |
#copy_object(params = {}) ⇒ Types::CopyObjectOutput
Creates a copy of an object that is already stored in Amazon S3.
<note markdown=“1”> 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].
</note>
All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see [REST Authentication]. 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.
A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy action starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the ‘200 OK` response. This means that a `200 OK` response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately.
If the copy is successful, you receive a response with information about the copied object.
<note markdown=“1”> If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body.
</note>
The copy request charge is based on the storage class and Region that you specify for the destination object. For pricing information, see [Amazon S3 pricing].
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 400 ‘Bad Request` error. For more information, see [Transfer Acceleration].
Metadata
When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see [Using ACLs].
To specify whether you want the object metadata copied from the source object or replaced with metadata provided in the request, you can optionally add the ‘x-amz-metadata-directive` header. When you grant permissions, you can use the `s3:x-amz-metadata-directive` condition key to enforce certain metadata behavior when objects are uploaded. For more information, see [Specifying Conditions in a Policy] in the *Amazon S3 User Guide*. For a complete list of Amazon S3-specific condition keys, see [Actions, Resources, and Condition Keys for Amazon S3].
**x-amz-copy-source-if Headers**
To only copy an object under certain conditions, such as whether the ‘Etag` matches or whether the object was modified before or after a specified date, use the following request parameters:
-
‘x-amz-copy-source-if-match`
-
‘x-amz-copy-source-if-none-match`
-
‘x-amz-copy-source-if-unmodified-since`
-
‘x-amz-copy-source-if-modified-since`
If both the ‘x-amz-copy-source-if-match` and `x-amz-copy-source-if-unmodified-since` headers are present in the request and evaluate as follows, Amazon S3 returns `200 OK` and copies the data:
-
‘x-amz-copy-source-if-match` condition evaluates to true
-
‘x-amz-copy-source-if-unmodified-since` condition evaluates to false
If both the ‘x-amz-copy-source-if-none-match` and `x-amz-copy-source-if-modified-since` headers are present in the request and evaluate as follows, Amazon S3 returns the `412 Precondition Failed` response code:
-
‘x-amz-copy-source-if-none-match` condition evaluates to false
-
‘x-amz-copy-source-if-modified-since` condition evaluates to true
<note markdown=“1”> All headers with the ‘x-amz-` prefix, including `x-amz-copy-source`, must be signed.
</note>
**Server-side encryption**
When you perform a CopyObject operation, you can optionally use the appropriate encryption-related headers to encrypt the object using server-side encryption with Amazon Web Services managed encryption keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. For more information about server-side encryption, see [Using Server-Side Encryption].
If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more information, see [Amazon S3 Bucket Keys] in the *Amazon S3 User Guide*.
**Access Control List (ACL)-Specific Request Headers**
When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see [Access Control List (ACL) Overview] and [Managing ACLs Using the REST API].
If the bucket that you’re copying objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don’t specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the ‘bucket-owner-full-control` canned ACL or an equivalent form of this ACL expressed in the XML format.
For more information, see [ Controlling ownership of objects and disabling ACLs] in the *Amazon S3 User Guide*.
<note markdown=“1”> If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account will be owned by the bucket owner.
</note>
Checksums
When copying an object, if it has a checksum, that checksum will be copied to the new object by default. When you copy the object over, you may optionally specify a different checksum algorithm to use with the ‘x-amz-checksum-algorithm` header.
**Storage Class Options**
You can use the ‘CopyObject` action to change the storage class of an object that is already stored in Amazon S3 using the `StorageClass` parameter. For more information, see [Storage Classes] in the *Amazon S3 User Guide*.
Versioning
By default, ‘x-amz-copy-source` identifies the current version of an object to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use the `versionId` subresource.
If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the ‘x-amz-version-id` response header in the response.
If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null.
If the source object’s storage class is GLACIER, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see [RestoreObject].
The following operations are related to ‘CopyObject`:
- PutObject][15
- GetObject][16
For more information, see [Copying Objects].
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html [3]: aws.amazon.com/s3/pricing/ [4]: docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html [5]: docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html [6]: docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html [7]: docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html [8]: docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html [9]: docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html [10]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html [11]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html [12]: docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html [13]: docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html [14]: docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html [15]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html [16]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html [17]: docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html
1479 1480 1481 1482 |
# File 'lib/aws-sdk-s3/client.rb', line 1479 def copy_object(params = {}, = {}) req = build_request(:copy_object, params) req.send_request() end |
#create_bucket(params = {}) ⇒ Types::CreateBucketOutput
Creates a new S3 bucket. To create a bucket, you must register with 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.
Not every string is an acceptable bucket name. For information about bucket naming restrictions, see [Bucket naming rules].
If you want to create an Amazon S3 on Outposts bucket, see [Create Bucket].
By default, the bucket is created in the US East (N. Virginia) Region. You can optionally specify a Region in the request body. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) Region. For more information, see [Accessing a bucket].
<note markdown=“1”> If you send your create bucket request to the ‘s3.amazonaws.com` endpoint, the request goes to the us-east-1 Region. Accordingly, the signature calculations in Signature Version 4 must use us-east-1 as the Region, even if the location constraint in the request specifies another Region where the bucket is to be created. If you create a bucket in a Region other than US East (N. Virginia), your application must be able to handle 307 redirect. For more information, see [Virtual hosting of buckets].
</note>
**Access control lists (ACLs)**
When creating a bucket using this operation, you can optionally configure the bucket ACL to specify the accounts or groups that should be granted specific permissions on the bucket.
If your CreateBucket request sets bucket owner enforced for S3 Object Ownership and specifies a bucket ACL that provides access to an external Amazon Web Services account, your request fails with a ‘400` error and returns the `InvalidBucketAclWithObjectOwnership` error code. For more information, see [Controlling object ownership] in the *Amazon S3 User Guide*.
There are two ways to grant the appropriate permissions using the request headers.
-
Specify a canned ACL using the ‘x-amz-acl` request header. Amazon S3 supports a set of predefined ACLs, known as *canned ACLs*. Each canned ACL has a predefined set of grantees and permissions. For more information, see [Canned ACL].
-
Specify access permissions explicitly using the ‘x-amz-grant-read`, `x-amz-grant-write`, `x-amz-grant-read-acp`, `x-amz-grant-write-acp`, and `x-amz-grant-full-control` headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For more information, see [Access control list (ACL) overview].
You specify each grantee as a type=value pair, where the type is one of the following:
-
‘id` – if the value specified is the canonical user ID of an Amazon Web Services account
-
‘uri` – if you are granting permissions to a predefined group
-
‘emailAddress` – if the value specified is the email address of an Amazon Web Services account
<note markdown=“1”> Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
* US East (N. Virginia)
-
US West (N. California)
-
US West (Oregon)
-
Asia Pacific (Singapore)
-
Asia Pacific (Sydney)
-
Asia Pacific (Tokyo)
-
Europe (Ireland)
-
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints,
see [Regions and Endpoints] in the Amazon Web Services General Reference.
</note>
-
For example, the following ‘x-amz-grant-read` header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
‘x-amz-grant-read: id=“11112222333”, id=“444455556666” `
-
<note markdown=“1”> You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
</note>
Permissions
In addition to ‘s3:CreateBucket`, the following permissions are required when your CreateBucket includes specific headers:
-
ACLs - If your ‘CreateBucket` request specifies ACL permissions and the ACL is public-read, public-read-write, authenticated-read, or if you specify access permissions explicitly through any other ACL, both `s3:CreateBucket` and `s3:PutBucketAcl` permissions are needed. If the ACL the `CreateBucket` request is private or doesn’t specify any ACLs, only ‘s3:CreateBucket` permission is needed.
-
**Object Lock** - If ‘ObjectLockEnabledForBucket` is set to true in your `CreateBucket` request, `s3:PutBucketObjectLockConfiguration` and `s3:PutBucketVersioning` permissions are required.
-
**S3 Object Ownership** - If your CreateBucket request includes the the ‘x-amz-object-ownership` header, `s3:PutBucketOwnershipControls` permission is required.
The following operations are related to ‘CreateBucket`:
- PutObject][9
- DeleteBucket][10
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro [4]: docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html [5]: docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html [6]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL [7]: docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html [8]: docs.aws.amazon.com/general/latest/gr/rande.html#s3_region [9]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html [10]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html
1736 1737 1738 1739 |
# File 'lib/aws-sdk-s3/client.rb', line 1736 def create_bucket(params = {}, = {}) req = build_request(:create_bucket, params) req.send_request() end |
#create_multipart_upload(params = {}) ⇒ Types::CreateMultipartUploadOutput
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].
If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete 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 Policy].
For information about the permissions required to use the multipart upload API, see [Multipart Upload and Permissions].
For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see [Authenticating Requests (Amazon Web Services Signature Version 4)].
<note markdown=“1”> 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 stop charging you for storing them only after you either complete or abort a multipart upload.
</note>
You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use Amazon Web Services KMS keys or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in [UploadPart] and
- UploadPartCopy][6
-
requests must match the headers you used in the
request to initiate the upload by using ‘CreateMultipartUpload`.
To perform a multipart upload with encryption using an Amazon Web Services KMS key, the requester must have permission to the ‘kms:Decrypt` and `kms:GenerateDataKey*` actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see [Multipart upload API and permissions] in the *Amazon S3 User Guide*.
If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role.
For more information, see [Protecting Data Using Server-Side Encryption].
Access Permissions
: When copying an object, you can optionally specify the accounts or
groups that should be granted specific permissions on the new
object. There are two ways to grant the permissions using the
request headers:
* Specify a canned ACL with the `x-amz-acl` request header. For more
information, see [Canned ACL][9].
* Specify access permissions explicitly with the `x-amz-grant-read`,
`x-amz-grant-read-acp`, `x-amz-grant-write-acp`, and
`x-amz-grant-full-control` headers. These parameters map to the
set of permissions that Amazon S3 supports in an ACL. For more
information, see [Access Control List (ACL) Overview][10].
You can use either a canned ACL or specify access permissions
explicitly. You cannot do both.
Server-Side- Encryption-Specific Request Headers
: You can optionally tell Amazon S3 to encrypt data at rest using
server-side encryption. Server-side encryption is for data
encryption at rest. Amazon S3 encrypts your data as it writes it to
disks in its data centers and decrypts it when you access it. The
option you use depends on whether you want to use Amazon Web
Services managed encryption keys or provide your own encryption key.
* Use encryption keys managed by Amazon S3 or customer managed key
stored in Amazon Web Services Key Management Service (Amazon Web
Services KMS) – If you want Amazon Web Services to manage the keys
used to encrypt data, specify the following headers in the
request.
* `x-amz-server-side-encryption`
* `x-amz-server-side-encryption-aws-kms-key-id`
* `x-amz-server-side-encryption-context`
<note markdown="1"> If you specify `x-amz-server-side-encryption:aws:kms`, but don't
provide `x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3
uses the Amazon Web Services managed key in Amazon Web Services
KMS to protect the data.
</note>
All GET and PUT requests for an object protected by Amazon Web
Services KMS fail if you don't make them with SSL or by using
SigV4.
For more information about server-side encryption with KMS key
(SSE-KMS), see [Protecting Data Using Server-Side Encryption with
KMS keys][11].
* Use customer-provided encryption keys – If you want to manage your
own encryption keys, provide all the following headers in the
request.
* `x-amz-server-side-encryption-customer-algorithm`
* `x-amz-server-side-encryption-customer-key`
* `x-amz-server-side-encryption-customer-key-MD5`
For more information about server-side encryption with KMS keys
(SSE-KMS), see [Protecting Data Using Server-Side Encryption with
KMS keys][11].
Access-Control-List (ACL)-Specific Request Headers
: You also can use the following access control–related headers with
this operation. By default, all objects are private. Only the owner
has full access control. When adding a new object, you can grant
permissions to individual Amazon Web Services accounts or to
predefined groups defined by Amazon S3. These permissions are then
added to the access control list (ACL) on the object. For more
information, see [Using ACLs][12]. With this operation, you can
grant access permissions using one of the following two methods:
* Specify a canned ACL (`x-amz-acl`) — Amazon S3 supports a set of
predefined ACLs, known as *canned ACLs*. Each canned ACL has a
predefined set of grantees and permissions. For more information,
see [Canned ACL][9].
* Specify access permissions explicitly — To explicitly grant access
permissions to specific Amazon Web Services accounts or groups,
use the following headers. Each header maps to specific
permissions that Amazon S3 supports in an ACL. For more
information, see [Access Control List (ACL) Overview][10]. In the
header, you specify a list of grantees who get the specific
permission. To grant permissions explicitly, use:
* `x-amz-grant-read`
* `x-amz-grant-write`
* `x-amz-grant-read-acp`
* `x-amz-grant-write-acp`
* `x-amz-grant-full-control`
You specify each grantee as a type=value pair, where the type is
one of the following:
* `id` – if the value specified is the canonical user ID of an
Amazon Web Services account
* `uri` – if you are granting permissions to a predefined group
* `emailAddress` – if the value specified is the email address of
an Amazon Web Services account
<note markdown="1"> Using email addresses to specify a grantee is only supported in
the following Amazon Web Services Regions:
* US East (N. Virginia)
* US West (N. California)
* US West (Oregon)
* Asia Pacific (Singapore)
* Asia Pacific (Sydney)
* Asia Pacific (Tokyo)
* Europe (Ireland)
* South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints,
see [Regions and Endpoints][13] in the Amazon Web Services
General Reference.
</note>
For example, the following `x-amz-grant-read` header grants the
Amazon Web Services accounts identified by account IDs permissions
to read object data and its metadata:
`x-amz-grant-read: id="11112222333", id="444455556666" `
The following operations are related to ‘CreateMultipartUpload`:
- UploadPart][1
- CompleteMultipartUpload][14
- AbortMultipartUpload][15
- ListParts][16
- ListMultipartUploads][17
[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config [4]: docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html [7]: docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions [8]: docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html [9]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL [10]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html [11]: docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html [12]: docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html [13]: docs.aws.amazon.com/general/latest/gr/rande.html#s3_region [14]: docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html [15]: docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html [16]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html [17]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
2251 2252 2253 2254 |
# File 'lib/aws-sdk-s3/client.rb', line 2251 def create_multipart_upload(params = {}, = {}) req = build_request(:create_multipart_upload, params) req.send_request() end |
#delete_bucket(params = {}) ⇒ Struct
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.
**Related Resources**
- CreateBucket][1
- DeleteObject][2
[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html
2301 2302 2303 2304 |
# File 'lib/aws-sdk-s3/client.rb', line 2301 def delete_bucket(params = {}, = {}) req = build_request(:delete_bucket, params) req.send_request() end |
#delete_bucket_analytics_configuration(params = {}) ⇒ Struct
Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).
To use this operation, you must have permissions to perform the ‘s3:PutAnalyticsConfiguration` action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to Your Amazon S3 Resources].
For information about the Amazon S3 analytics feature, see [Amazon S3 Analytics – Storage Class Analysis].
The following operations are related to ‘DeleteBucketAnalyticsConfiguration`:
- GetBucketAnalyticsConfiguration][4
- ListBucketAnalyticsConfigurations][5
- PutBucketAnalyticsConfiguration][6
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html
2363 2364 2365 2366 |
# File 'lib/aws-sdk-s3/client.rb', line 2363 def delete_bucket_analytics_configuration(params = {}, = {}) req = build_request(:delete_bucket_analytics_configuration, params) req.send_request() end |
#delete_bucket_cors(params = {}) ⇒ Struct
Deletes the ‘cors` configuration information set for the bucket.
To use this operation, you must have permission to perform the ‘s3:PutBucketCORS` action. The bucket owner has this permission by default and can grant this permission to others.
For information about ‘cors`, see [Enabling Cross-Origin Resource Sharing] in the *Amazon S3 User Guide*.
**Related Resources:**
- PutBucketCors][2
- RESTOPTIONSobject][3
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/cors.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html
2419 2420 2421 2422 |
# File 'lib/aws-sdk-s3/client.rb', line 2419 def delete_bucket_cors(params = {}, = {}) req = build_request(:delete_bucket_cors, params) req.send_request() end |
#delete_bucket_encryption(params = {}) ⇒ Struct
This implementation of the DELETE action removes default encryption from the bucket. For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Bucket Encryption] in the *Amazon S3 User Guide*.
To use this operation, you must have permissions to perform the ‘s3:PutEncryptionConfiguration` action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to your Amazon S3 Resources] in the *Amazon S3 User Guide*.
**Related Resources**
- PutBucketEncryption][4
- GetBucketEncryption][5
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html
2473 2474 2475 2476 |
# File 'lib/aws-sdk-s3/client.rb', line 2473 def delete_bucket_encryption(params = {}, = {}) req = build_request(:delete_bucket_encryption, params) req.send_request() end |
#delete_bucket_intelligent_tiering_configuration(params = {}) ⇒ Struct
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 ‘DeleteBucketIntelligentTieringConfiguration` include:
- GetBucketIntelligentTieringConfiguration][2
- PutBucketIntelligentTieringConfiguration][3
- ListBucketIntelligentTieringConfigurations][4
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html
2536 2537 2538 2539 |
# File 'lib/aws-sdk-s3/client.rb', line 2536 def delete_bucket_intelligent_tiering_configuration(params = {}, = {}) req = build_request(:delete_bucket_intelligent_tiering_configuration, params) req.send_request() end |
#delete_bucket_inventory_configuration(params = {}) ⇒ Struct
Deletes an inventory configuration (identified by the inventory ID) from the bucket.
To use this operation, you must have permissions to perform the ‘s3:PutInventoryConfiguration` action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to Your Amazon S3 Resources].
For information about the Amazon S3 inventory feature, see [Amazon S3 Inventory].
Operations related to ‘DeleteBucketInventoryConfiguration` include:
- GetBucketInventoryConfiguration][4
- PutBucketInventoryConfiguration][5
- ListBucketInventoryConfigurations][6
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html
2597 2598 2599 2600 |
# File 'lib/aws-sdk-s3/client.rb', line 2597 def delete_bucket_inventory_configuration(params = {}, = {}) req = build_request(:delete_bucket_inventory_configuration, params) req.send_request() end |
#delete_bucket_lifecycle(params = {}) ⇒ Struct
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 ‘s3:PutLifecycleConfiguration` action. By default, the bucket owner has this permission and the bucket owner can grant this permission to others.
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:
- PutBucketLifecycleConfiguration][2
- GetBucketLifecycleConfiguration][3
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html
2661 2662 2663 2664 |
# File 'lib/aws-sdk-s3/client.rb', line 2661 def delete_bucket_lifecycle(params = {}, = {}) req = build_request(:delete_bucket_lifecycle, params) req.send_request() end |
#delete_bucket_metrics_configuration(params = {}) ⇒ Struct
Deletes a metrics configuration for the Amazon CloudWatch request metrics (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 ‘s3:PutMetricsConfiguration` action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to Your Amazon S3 Resources].
For information about CloudWatch request metrics for Amazon S3, see [Monitoring Metrics with Amazon CloudWatch].
The following operations are related to ‘DeleteBucketMetricsConfiguration`:
- GetBucketMetricsConfiguration][4
- PutBucketMetricsConfiguration][5
- ListBucketMetricsConfigurations][6
- Monitoring Metrics with Amazon CloudWatch][3
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html
2725 2726 2727 2728 |
# File 'lib/aws-sdk-s3/client.rb', line 2725 def delete_bucket_metrics_configuration(params = {}, = {}) req = build_request(:delete_bucket_metrics_configuration, params) req.send_request() end |
#delete_bucket_ownership_controls(params = {}) ⇒ Struct
Removes ‘OwnershipControls` for an Amazon S3 bucket. To use this operation, you must have the `s3:PutBucketOwnershipControls` permission. For more information about Amazon S3 permissions, see [Specifying Permissions in a Policy].
For information about Amazon S3 Object Ownership, see [Using Object Ownership].
The following operations are related to ‘DeleteBucketOwnershipControls`:
-
GetBucketOwnershipControls
-
PutBucketOwnershipControls
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html
2771 2772 2773 2774 |
# File 'lib/aws-sdk-s3/client.rb', line 2771 def delete_bucket_ownership_controls(params = {}, = {}) req = build_request(:delete_bucket_ownership_controls, params) req.send_request() end |
#delete_bucket_policy(params = {}) ⇒ Struct
This implementation of the DELETE action uses the policy subresource to delete the policy of a specified bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the ‘DeleteBucketPolicy` permissions on the specified bucket and belong to the bucket owner’s account to use this operation.
If you don’t have ‘DeleteBucketPolicy` permissions, Amazon S3 returns a `403 Access Denied` error. If you have the correct permissions, but you’re not using an identity that belongs to the bucket owner’s account, Amazon S3 returns a ‘405 Method Not Allowed` error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see [Using Bucket Policies and UserPolicies].
The following operations are related to ‘DeleteBucketPolicy`
- CreateBucket][2
- DeleteObject][3
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html
2838 2839 2840 2841 |
# File 'lib/aws-sdk-s3/client.rb', line 2838 def delete_bucket_policy(params = {}, = {}) req = build_request(:delete_bucket_policy, params) req.send_request() end |
#delete_bucket_replication(params = {}) ⇒ Struct
Deletes the replication configuration from the bucket.
To use this operation, you must have permissions to perform the ‘s3:PutReplicationConfiguration` action. The bucket owner has these permissions by default and can grant it to others. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to Your Amazon S3 Resources].
<note markdown=“1”> It can take a while for the deletion of a replication configuration to fully propagate.
</note>
For information about replication configuration, see [Replication] in the *Amazon S3 User Guide*.
The following operations are related to ‘DeleteBucketReplication`:
- PutBucketReplication][4
- GetBucketReplication][5
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/replication.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html
2904 2905 2906 2907 |
# File 'lib/aws-sdk-s3/client.rb', line 2904 def delete_bucket_replication(params = {}, = {}) req = build_request(:delete_bucket_replication, params) req.send_request() end |
#delete_bucket_tagging(params = {}) ⇒ Struct
Deletes the tags from the bucket.
To use this operation, you must have permission to perform the ‘s3:PutBucketTagging` action. By default, the bucket owner has this permission and can grant this permission to others.
The following operations are related to ‘DeleteBucketTagging`:
- GetBucketTagging][1
- PutBucketTagging][2
[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html
2956 2957 2958 2959 |
# File 'lib/aws-sdk-s3/client.rb', line 2956 def delete_bucket_tagging(params = {}, = {}) req = build_request(:delete_bucket_tagging, params) req.send_request() end |
#delete_bucket_website(params = {}) ⇒ Struct
This action removes the website configuration for a bucket. Amazon S3 returns a ‘200 OK` response upon successfully deleting a website configuration on the specified bucket. You will get a `200 OK` response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a `404` response if the bucket specified in the request does not exist.
This DELETE action requires the ‘S3:DeleteBucketWebsite` permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them the `S3:DeleteBucketWebsite` permission.
For more information about hosting websites, see [Hosting Websites on Amazon S3].
The following operations are related to ‘DeleteBucketWebsite`:
- GetBucketWebsite][2
- PutBucketWebsite][3
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketWebsite.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html
3020 3021 3022 3023 |
# File 'lib/aws-sdk-s3/client.rb', line 3020 def delete_bucket_website(params = {}, = {}) req = build_request(:delete_bucket_website, params) req.send_request() end |
#delete_object(params = {}) ⇒ Types::DeleteObjectOutput
Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn’t a null version, Amazon S3 does not remove any objects but will still respond that the command was successful.
To remove a specific version, you must be the bucket owner and you must use the version Id subresource. Using this subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3 sets the response header, ‘x-amz-delete-marker`, to true.
If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, you must include the ‘x-amz-mfa` request header in the DELETE `versionId` request. Requests that include `x-amz-mfa` must use HTTPS.
For more information about MFA Delete, see [Using MFA Delete]. To see sample requests that use versioning, see [Sample Request].
You can delete objects by explicitly calling DELETE Object or configure its lifecycle ([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 ‘s3:DeleteObject`, `s3:DeleteObjectVersion`, and `s3:PutLifeCycleConfiguration` actions.
The following action is related to ‘DeleteObject`:
- PutObject][4
^
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
3173 3174 3175 3176 |
# File 'lib/aws-sdk-s3/client.rb', line 3173 def delete_object(params = {}, = {}) req = build_request(:delete_object, params) req.send_request() end |
#delete_object_tagging(params = {}) ⇒ Types::DeleteObjectTaggingOutput
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 ‘s3:DeleteObjectTagging` action.
To delete tags of a specific object version, add the ‘versionId` query parameter in the request. You will need permission for the `s3:DeleteObjectVersionTagging` action.
The following operations are related to ‘DeleteBucketMetricsConfiguration`:
- PutObjectTagging][2
- GetObjectTagging][3
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html
3291 3292 3293 3294 |
# File 'lib/aws-sdk-s3/client.rb', line 3291 def delete_object_tagging(params = {}, = {}) req = build_request(:delete_object_tagging, params) req.send_request() end |
#delete_objects(params = {}) ⇒ Types::DeleteObjectsOutput
This action 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 action provides a suitable alternative to sending individual delete requests, reducing per-request overhead.
The request contains 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 action 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 action supports two modes for the response: verbose and quiet. By default, the action 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 action encountered an error. For a successful deletion, the action 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].
Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in transit.
The following operations are related to ‘DeleteObjects`:
- CreateMultipartUpload][2
- UploadPart][3
- CompleteMultipartUpload][4
- ListParts][5
- AbortMultipartUpload][6
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
3540 3541 3542 3543 |
# File 'lib/aws-sdk-s3/client.rb', line 3540 def delete_objects(params = {}, = {}) req = build_request(:delete_objects, params) req.send_request() end |
#delete_public_access_block(params = {}) ⇒ Struct
Removes the ‘PublicAccessBlock` configuration for an Amazon S3 bucket. To use this operation, you must have the `s3:PutBucketPublicAccessBlock` permission. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to Your Amazon S3 Resources].
The following operations are related to ‘DeletePublicAccessBlock`:
- Using Amazon S3 Block Public Access][3
- GetPublicAccessBlock][4
- PutPublicAccessBlock][5
- GetBucketPolicyStatus][6
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html
3593 3594 3595 3596 |
# File 'lib/aws-sdk-s3/client.rb', line 3593 def delete_public_access_block(params = {}, = {}) req = build_request(:delete_public_access_block, params) req.send_request() end |
#get_bucket_accelerate_configuration(params = {}) ⇒ Types::GetBucketAccelerateConfigurationOutput
This implementation of the GET action uses the ‘accelerate` subresource to return the Transfer Acceleration state of a bucket, which is either `Enabled` or `Suspended`. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to and from Amazon S3.
To use this operation, you must have permission to perform the ‘s3:GetAccelerateConfiguration` action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to your Amazon S3 Resources] in the *Amazon S3 User Guide*.
You set the Transfer Acceleration state of an existing bucket to ‘Enabled` or `Suspended` by using the
- PutBucketAccelerateConfiguration][3
-
operation.
A GET ‘accelerate` request does not return a state value for a bucket that has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state has never been set on the bucket.
For more information about transfer acceleration, see [Transfer Acceleration] in the Amazon S3 User Guide.
**Related Resources**
- PutBucketAccelerateConfiguration][3
^
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html [4]: docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
3664 3665 3666 3667 |
# File 'lib/aws-sdk-s3/client.rb', line 3664 def get_bucket_accelerate_configuration(params = {}, = {}) req = build_request(:get_bucket_accelerate_configuration, params) req.send_request() end |
#get_bucket_acl(params = {}) ⇒ Types::GetBucketAclOutput
This implementation of the ‘GET` action uses the `acl` subresource to return the access control list (ACL) of a bucket. To use `GET` to return the ACL of the bucket, you must have `READ_ACP` access to the bucket. If `READ_ACP` permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header.
<note markdown=“1”> If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the ‘bucket-owner-full-control` ACL with the owner being the account that created the bucket. For more information, see [ Controlling object ownership and disabling ACLs] in the *Amazon S3 User Guide*.
</note>
**Related Resources**
- ListObjects][2
^
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html
3731 3732 3733 3734 |
# File 'lib/aws-sdk-s3/client.rb', line 3731 def get_bucket_acl(params = {}, = {}) req = build_request(:get_bucket_acl, params) req.send_request() end |
#get_bucket_analytics_configuration(params = {}) ⇒ Types::GetBucketAnalyticsConfigurationOutput
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 ‘s3:GetAnalyticsConfiguration` action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see [ Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to Your Amazon S3 Resources] in the *Amazon S3 User Guide*.
For information about Amazon S3 analytics feature, see [Amazon S3 Analytics – Storage Class Analysis] in the *Amazon S3 User Guide*.
**Related Resources**
- DeleteBucketAnalyticsConfiguration][4
- ListBucketAnalyticsConfigurations][5
- PutBucketAnalyticsConfiguration][6
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html
3812 3813 3814 3815 |
# File 'lib/aws-sdk-s3/client.rb', line 3812 def get_bucket_analytics_configuration(params = {}, = {}) req = build_request(:get_bucket_analytics_configuration, params) req.send_request() end |
#get_bucket_cors(params = {}) ⇒ Types::GetBucketCorsOutput
Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the bucket.
To use this operation, you must have permission to perform the ‘s3:GetBucketCORS` action. By default, the bucket owner has this permission and can grant it to others.
For more information about CORS, see [ Enabling Cross-Origin Resource Sharing].
The following operations are related to ‘GetBucketCors`:
- PutBucketCors][2
- DeleteBucketCors][3
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/cors.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html
3903 3904 3905 3906 |
# File 'lib/aws-sdk-s3/client.rb', line 3903 def get_bucket_cors(params = {}, = {}) req = build_request(:get_bucket_cors, params) req.send_request() end |
#get_bucket_encryption(params = {}) ⇒ Types::GetBucketEncryptionOutput
Returns the default encryption configuration for an Amazon S3 bucket. If the bucket does not have a default encryption configuration, GetBucketEncryption returns ‘ServerSideEncryptionConfigurationNotFoundError`.
For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Bucket Encryption].
To use this operation, you must have permission to perform the ‘s3:GetEncryptionConfiguration` action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to Your Amazon S3 Resources].
The following operations are related to ‘GetBucketEncryption`:
- PutBucketEncryption][4
- DeleteBucketEncryption][5
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html
3968 3969 3970 3971 |
# File 'lib/aws-sdk-s3/client.rb', line 3968 def get_bucket_encryption(params = {}, = {}) req = build_request(:get_bucket_encryption, params) req.send_request() end |
#get_bucket_intelligent_tiering_configuration(params = {}) ⇒ Types::GetBucketIntelligentTieringConfigurationOutput
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 ‘GetBucketIntelligentTieringConfiguration` include:
- DeleteBucketIntelligentTieringConfiguration][2
- PutBucketIntelligentTieringConfiguration][3
- ListBucketIntelligentTieringConfigurations][4
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html
4048 4049 4050 4051 |
# File 'lib/aws-sdk-s3/client.rb', line 4048 def get_bucket_intelligent_tiering_configuration(params = {}, = {}) req = build_request(:get_bucket_intelligent_tiering_configuration, params) req.send_request() end |
#get_bucket_inventory_configuration(params = {}) ⇒ Types::GetBucketInventoryConfigurationOutput
Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.
To use this operation, you must have permissions to perform the ‘s3:GetInventoryConfiguration` action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to Your Amazon S3 Resources].
For information about the Amazon S3 inventory feature, see [Amazon S3 Inventory].
The following operations are related to ‘GetBucketInventoryConfiguration`:
- DeleteBucketInventoryConfiguration][4
- ListBucketInventoryConfigurations][5
- PutBucketInventoryConfiguration][6
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html
4127 4128 4129 4130 |
# File 'lib/aws-sdk-s3/client.rb', line 4127 def get_bucket_inventory_configuration(params = {}, = {}) req = build_request(:get_bucket_inventory_configuration, params) req.send_request() end |
#get_bucket_lifecycle(params = {}) ⇒ Types::GetBucketLifecycleOutput
For an updated version of this API, see [GetBucketLifecycleConfiguration]. If you configured a bucket lifecycle using the ‘filter` element, you should see the updated version of this topic. This topic is provided for backward compatibility.
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 ‘s3:GetLifecycleConfiguration` action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to Your Amazon S3 Resources].
‘GetBucketLifecycle` has the following special error:
-
Error code: ‘NoSuchLifecycleConfiguration`
-
Description: The lifecycle configuration does not exist.
-
HTTP Status Code: 404 Not Found
-
SOAP Fault Code Prefix: Client
-
The following operations are related to ‘GetBucketLifecycle`:
- GetBucketLifecycleConfiguration][1
- PutBucketLifecycle][5
- DeleteBucketLifecycle][6
[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html
4241 4242 4243 4244 |
# File 'lib/aws-sdk-s3/client.rb', line 4241 def get_bucket_lifecycle(params = {}, = {}) req = build_request(:get_bucket_lifecycle, params) req.send_request() end |
#get_bucket_lifecycle_configuration(params = {}) ⇒ Types::GetBucketLifecycleConfigurationOutput
<note markdown=“1”> Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. 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, see [GetBucketLifecycle].
</note>
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 ‘s3:GetLifecycleConfiguration` action. The bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to Your Amazon S3 Resources].
‘GetBucketLifecycleConfiguration` has the following special error:
-
Error code: ‘NoSuchLifecycleConfiguration`
-
Description: The lifecycle configuration does not exist.
-
HTTP Status Code: 404 Not Found
-
SOAP Fault Code Prefix: Client
-
The following operations are related to ‘GetBucketLifecycleConfiguration`:
- GetBucketLifecycle][1
- PutBucketLifecycle][5
- DeleteBucketLifecycle][6
[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html
4377 4378 4379 4380 |
# File 'lib/aws-sdk-s3/client.rb', line 4377 def get_bucket_lifecycle_configuration(params = {}, = {}) req = build_request(:get_bucket_lifecycle_configuration, params) req.send_request() end |
#get_bucket_location(params = {}) ⇒ Types::GetBucketLocationOutput
Returns the Region the bucket resides in. You set the bucket’s Region using the ‘LocationConstraint` request parameter in a `CreateBucket` request. For more information, see [CreateBucket].
To use this implementation of the operation, you must be the bucket owner.
To use this API against an access point, provide the alias of the access point in place of the bucket name.
The following operations are related to ‘GetBucketLocation`:
- GetObject][2
- CreateBucket][1
[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
4444 4445 4446 4447 |
# File 'lib/aws-sdk-s3/client.rb', line 4444 def get_bucket_location(params = {}, = {}) req = build_request(:get_bucket_location, params) req.send_request() end |
#get_bucket_logging(params = {}) ⇒ Types::GetBucketLoggingOutput
Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.
The following operations are related to ‘GetBucketLogging`:
- CreateBucket][1
- PutBucketLogging][2
[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLogging.html
4499 4500 4501 4502 |
# File 'lib/aws-sdk-s3/client.rb', line 4499 def get_bucket_logging(params = {}, = {}) req = build_request(:get_bucket_logging, params) req.send_request() end |
#get_bucket_metrics_configuration(params = {}) ⇒ Types::GetBucketMetricsConfigurationOutput
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 ‘s3:GetMetricsConfiguration` action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to Your Amazon S3 Resources].
For information about CloudWatch request metrics for Amazon S3, see [Monitoring Metrics with Amazon CloudWatch].
The following operations are related to ‘GetBucketMetricsConfiguration`:
- PutBucketMetricsConfiguration][4
- DeleteBucketMetricsConfiguration][5
- ListBucketMetricsConfigurations][6
- Monitoring Metrics with Amazon CloudWatch][3
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html
4579 4580 4581 4582 |
# File 'lib/aws-sdk-s3/client.rb', line 4579 def get_bucket_metrics_configuration(params = {}, = {}) req = build_request(:get_bucket_metrics_configuration, params) req.send_request() end |
#get_bucket_notification(params = {}) ⇒ Types::NotificationConfigurationDeprecated
4692 4693 4694 4695 |
# File 'lib/aws-sdk-s3/client.rb', line 4692 def get_bucket_notification(params = {}, = {}) req = build_request(:get_bucket_notification, params) req.send_request() end |
#get_bucket_notification_configuration(params = {}) ⇒ Types::NotificationConfiguration
Returns the notification configuration of a bucket.
If notifications are not enabled on the bucket, the action returns an empty ‘NotificationConfiguration` element.
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 ‘s3:GetBucketNotification` permission.
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 ‘GetBucketNotification`:
- PutBucketNotification][3
^
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotification.html
4778 4779 4780 4781 |
# File 'lib/aws-sdk-s3/client.rb', line 4778 def get_bucket_notification_configuration(params = {}, = {}) req = build_request(:get_bucket_notification_configuration, params) req.send_request() end |
#get_bucket_ownership_controls(params = {}) ⇒ Types::GetBucketOwnershipControlsOutput
Retrieves ‘OwnershipControls` for an Amazon S3 bucket. To use this operation, you must have the `s3:GetBucketOwnershipControls` permission. For more information about Amazon S3 permissions, see [Specifying permissions in a policy].
For information about Amazon S3 Object Ownership, see [Using Object Ownership].
The following operations are related to ‘GetBucketOwnershipControls`:
-
PutBucketOwnershipControls
-
DeleteBucketOwnershipControls
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html
4831 4832 4833 4834 |
# File 'lib/aws-sdk-s3/client.rb', line 4831 def get_bucket_ownership_controls(params = {}, = {}) req = build_request(:get_bucket_ownership_controls, params) req.send_request() end |
#get_bucket_policy(params = {}) ⇒ Types::GetBucketPolicyOutput
Returns the policy of a specified bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the ‘GetBucketPolicy` permissions on the specified bucket and belong to the bucket owner’s account in order to use this operation.
If you don’t have ‘GetBucketPolicy` permissions, Amazon S3 returns a `403 Access Denied` error. If you have the correct permissions, but you’re not using an identity that belongs to the bucket owner’s account, Amazon S3 returns a ‘405 Method Not Allowed` error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see [Using Bucket Policies and User Policies].
The following action is related to ‘GetBucketPolicy`:
- GetObject][2
^
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
4907 4908 4909 4910 |
# File 'lib/aws-sdk-s3/client.rb', line 4907 def get_bucket_policy(params = {}, = {}, &block) req = build_request(:get_bucket_policy, params) req.send_request(, &block) end |
#get_bucket_policy_status(params = {}) ⇒ Types::GetBucketPolicyStatusOutput
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 ‘s3:GetBucketPolicyStatus` permission. For more information about Amazon S3 permissions, see [Specifying Permissions in a Policy].
For more information about when Amazon S3 considers a bucket public, see [The Meaning of “Public”].
The following operations are related to ‘GetBucketPolicyStatus`:
- Using Amazon S3 Block Public Access][3
- GetPublicAccessBlock][4
- PutPublicAccessBlock][5
- DeletePublicAccessBlock][6
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status [3]: docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html
4968 4969 4970 4971 |
# File 'lib/aws-sdk-s3/client.rb', line 4968 def get_bucket_policy_status(params = {}, = {}) req = build_request(:get_bucket_policy_status, params) req.send_request() end |
#get_bucket_replication(params = {}) ⇒ Types::GetBucketReplicationOutput
Returns the replication configuration of a bucket.
<note markdown=“1”> It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result.
</note>
For information about replication configuration, see [Replication] in the *Amazon S3 User Guide*.
This action requires permissions for the ‘s3:GetReplicationConfiguration` action. For more information about permissions, see [Using Bucket Policies and User Policies].
If you include the ‘Filter` element in a replication configuration, you must also include the `DeleteMarkerReplication` and `Priority` elements. The response also returns those elements.
For information about ‘GetBucketReplication` errors, see [List of replication-related error codes]
The following operations are related to ‘GetBucketReplication`:
- PutBucketReplication][4
- DeleteBucketReplication][5
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/replication.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html
5087 5088 5089 5090 |
# File 'lib/aws-sdk-s3/client.rb', line 5087 def get_bucket_replication(params = {}, = {}) req = build_request(:get_bucket_replication, params) req.send_request() end |
#get_bucket_request_payment(params = {}) ⇒ Types::GetBucketRequestPaymentOutput
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 ‘GetBucketRequestPayment`:
- ListObjects][2
^
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html
5149 5150 5151 5152 |
# File 'lib/aws-sdk-s3/client.rb', line 5149 def get_bucket_request_payment(params = {}, = {}) req = build_request(:get_bucket_request_payment, params) req.send_request() end |
#get_bucket_tagging(params = {}) ⇒ Types::GetBucketTaggingOutput
Returns the tag set associated with the bucket.
To use this operation, you must have permission to perform the ‘s3:GetBucketTagging` action. By default, the bucket owner has this permission and can grant this permission to others.
‘GetBucketTagging` has the following special error:
-
Error code: ‘NoSuchTagSet`
-
Description: There is no tag set associated with the bucket.
^
-
The following operations are related to ‘GetBucketTagging`:
- PutBucketTagging][1
- DeleteBucketTagging][2
[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html
5231 5232 5233 5234 |
# File 'lib/aws-sdk-s3/client.rb', line 5231 def get_bucket_tagging(params = {}, = {}) req = build_request(:get_bucket_tagging, params) req.send_request() end |
#get_bucket_versioning(params = {}) ⇒ Types::GetBucketVersioningOutput
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 ‘enabled`, the bucket owner must use an authentication device to change the versioning state of the bucket.
The following operations are related to ‘GetBucketVersioning`:
- GetObject][1
- PutObject][2
- DeleteObject][3
[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html
5304 5305 5306 5307 |
# File 'lib/aws-sdk-s3/client.rb', line 5304 def get_bucket_versioning(params = {}, = {}) req = build_request(:get_bucket_versioning, params) req.send_request() end |
#get_bucket_website(params = {}) ⇒ Types::GetBucketWebsiteOutput
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 ‘S3:GetBucketWebsite` permission. By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them the `S3:GetBucketWebsite` permission.
The following operations are related to ‘DeleteBucketWebsite`:
- DeleteBucketWebsite][2
- PutBucketWebsite][3
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketWebsite.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html
5392 5393 5394 5395 |
# File 'lib/aws-sdk-s3/client.rb', line 5392 def get_bucket_website(params = {}, = {}) req = build_request(:get_bucket_website, params) req.send_request() end |
#get_object(params = {}) ⇒ Types::GetObjectOutput
Retrieves objects from Amazon S3. To use ‘GET`, you must have `READ` access to the object. If you grant `READ` access to the anonymous user, you can return the object without using an authorization header.
An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object ‘sample.jpg`, you can name it `photos/2006/February/sample.jpg`.
To get an object from such a logical hierarchy, specify the full key name for the object in the ‘GET` operation. For a virtual hosted-style request example, if you have the object `photos/2006/February/sample.jpg`, specify the resource as `/photos/2006/February/sample.jpg`. For a path-style request example, if you have the object `photos/2006/February/sample.jpg` in the bucket named `examplebucket`, specify the resource as `/examplebucket/photos/2006/February/sample.jpg`. For more information about request types, see [HTTP Host Header Bucket Specification].
For more information about returning the ACL of an object, see [GetObjectAcl].
If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a copy using [RestoreObject]. Otherwise, this action returns an ‘InvalidObjectStateError` error. For information about restoring archived objects, see [Restoring Archived Objects].
Encryption request headers, like ‘x-amz-server-side-encryption`, should not be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:
-
x-amz-server-side-encryption-customer-algorithm
-
x-amz-server-side-encryption-customer-key
-
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see [Server-Side Encryption (Using Customer-Provided Encryption Keys)].
Assuming you have the relevant permission to read object tags, the response also returns the ‘x-amz-tagging-count` header that provides the count of number of tags associated with the object. You can use
- GetObjectTagging][6
-
to retrieve the tag set associated with an
object.
Permissions
You need the relevant read object (or version) permission for this operation. For more information, see [Specifying Permissions in a Policy]. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the ‘s3:ListBucket` permission.
-
If you have the ‘s3:ListBucket` permission on the bucket, Amazon S3 will return an HTTP status code 404 (“no such key”) error.
-
If you don’t have the ‘s3:ListBucket` permission, Amazon S3 will return an HTTP status code 403 (“access denied”) error.
Versioning
By default, the GET action returns the current version of an object. To return a different version, use the ‘versionId` subresource.
<note markdown=“1”> * If you supply a ‘versionId`, you need the `s3:GetObjectVersion`
permission to access a specific version of an object. If you request
a specific version, you do not need to have the `s3:GetObject`
permission.
-
If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes ‘x-amz-delete-marker: true` in the response.
</note>
For more information about versioning, see [PutBucketVersioning].
**Overriding Response Header Values**
There are times when you want to override certain response header values in a GET response. For example, you might override the ‘Content-Disposition` response header value in your GET request.
You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are ‘Content-Type`, `Content-Language`, `Expires`, `Cache-Control`, `Content-Disposition`, and `Content-Encoding`. To override these header values in the GET response, you use the following request parameters.
<note markdown=“1”> You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request.
</note>
-
‘response-content-type`
-
‘response-content-language`
-
‘response-expires`
-
‘response-cache-control`
-
‘response-content-disposition`
-
‘response-content-encoding`
**Additional Considerations about Request Headers**
If both of the ‘If-Match` and `If-Unmodified-Since` headers are present in the request as follows: `If-Match` condition evaluates to `true`, and; `If-Unmodified-Since` condition evaluates to `false`; then, S3 returns 200 OK and the data requested.
If both of the ‘If-None-Match` and `If-Modified-Since` headers are present in the request as follows:` If-None-Match` condition evaluates to `false`, and; `If-Modified-Since` condition evaluates to `true`; then, S3 returns 304 Not Modified response code.
For more information about conditional requests, see [RFC 7232].
The following operations are related to ‘GetObject`:
- ListBuckets][10
- GetObjectAcl][2
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html [4]: docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html [5]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html [7]: docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html [8]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html [9]: tools.ietf.org/html/rfc7232 [10]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html
5867 5868 5869 5870 |
# File 'lib/aws-sdk-s3/client.rb', line 5867 def get_object(params = {}, = {}, &block) req = build_request(:get_object, params) req.send_request(, &block) end |
#get_object_acl(params = {}) ⇒ Types::GetObjectAclOutput
Returns the access control list (ACL) of an object. To use this operation, you must have ‘s3:GetObjectAcl` permissions or `READ_ACP` access to the object. For more information, see [Mapping of ACL permissions and access policy permissions] in the *Amazon S3 User Guide*
This action is not supported by Amazon S3 on Outposts.
Versioning
By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.
<note markdown=“1”> If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the ‘bucket-owner-full-control` ACL with the owner being the account that created the bucket. For more information, see [ Controlling object ownership and disabling ACLs] in the *Amazon S3 User Guide*.
</note>
The following operations are related to ‘GetObjectAcl`:
- GetObject][3
- GetObjectAttributes][4
- DeleteObject][5
- PutObject][6
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#acl-access-policy-permission-mapping [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
6036 6037 6038 6039 |
# File 'lib/aws-sdk-s3/client.rb', line 6036 def get_object_acl(params = {}, = {}) req = build_request(:get_object_acl, params) req.send_request() end |
#get_object_attributes(params = {}) ⇒ Types::GetObjectAttributesOutput
Retrieves all the metadata from an object without returning the object itself. This action is useful if you’re interested only in an object’s metadata. To use ‘GetObjectAttributes`, you must have READ access to the object.
‘GetObjectAttributes` combines the functionality of `GetObjectAcl`, `GetObjectLegalHold`, `GetObjectLockConfiguration`, `GetObjectRetention`, `GetObjectTagging`, `HeadObject`, and `ListParts`. All of the data returned with each of those individual calls can be returned with a single call to `GetObjectAttributes`.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:
-
‘x-amz-server-side-encryption-customer-algorithm`
-
‘x-amz-server-side-encryption-customer-key`
-
‘x-amz-server-side-encryption-customer-key-MD5`
For more information about SSE-C, see [Server-Side Encryption (Using Customer-Provided Encryption Keys)] in the *Amazon S3 User Guide*.
<note markdown=“1”> * Encryption request headers, such as ‘x-amz-server-side-encryption`,
should not be sent for GET requests if your object uses server-side
encryption with Amazon Web Services KMS keys stored in Amazon Web
Services Key Management Service (SSE-KMS) or server-side encryption
with Amazon S3 managed encryption keys (SSE-S3). If your object does
use these types of keys, you'll get an HTTP `400 Bad Request`
error.
-
The last modified property in this case is the creation date of the object.
</note>
Consider the following when using request headers:
-
If both of the ‘If-Match` and `If-Unmodified-Since` headers are present in the request as follows, then Amazon S3 returns the HTTP status code `200 OK` and the data requested:
-
‘If-Match` condition evaluates to `true`.
-
‘If-Unmodified-Since` condition evaluates to `false`.
-
-
If both of the ‘If-None-Match` and `If-Modified-Since` headers are present in the request as follows, then Amazon S3 returns the HTTP status code `304 Not Modified`:
-
‘If-None-Match` condition evaluates to `false`.
-
‘If-Modified-Since` condition evaluates to `true`.
-
For more information about conditional requests, see [RFC 7232].
Permissions
The permissions that you need to use this operation depend on whether the bucket is versioned. If the bucket is versioned, you need both the ‘s3:GetObjectVersion` and `s3:GetObjectVersionAttributes` permissions for this operation. If the bucket is not versioned, you need the `s3:GetObject` and `s3:GetObjectAttributes` permissions. For more information, see [Specifying Permissions in a Policy] in the *Amazon S3 User Guide*. If the object that you request does not exist, the error Amazon S3 returns depends on whether you also have the `s3:ListBucket` permission.
-
If you have the ‘s3:ListBucket` permission on the bucket, Amazon S3 returns an HTTP status code `404 Not Found` (“no such key”) error.
-
If you don’t have the ‘s3:ListBucket` permission, Amazon S3 returns an HTTP status code `403 Forbidden` (“access denied”) error.
The following actions are related to ‘GetObjectAttributes`:
- GetObject][4
- GetObjectAcl][5
- GetObjectLegalHold][6
- GetObjectLockConfiguration][7
- GetObjectRetention][8
- GetObjectTagging][9
- HeadObject][10
- ListParts][11
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html [2]: tools.ietf.org/html/rfc7232 [3]: docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLegalHold.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLockConfiguration.html [8]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectRetention.html [9]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html [10]: docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html [11]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
6282 6283 6284 6285 |
# File 'lib/aws-sdk-s3/client.rb', line 6282 def get_object_attributes(params = {}, = {}) req = build_request(:get_object_attributes, params) req.send_request() end |
#get_object_legal_hold(params = {}) ⇒ Types::GetObjectLegalHoldOutput
Gets an object’s current legal hold status. For more information, see [Locking Objects].
This action is not supported by Amazon S3 on Outposts.
The following action is related to ‘GetObjectLegalHold`:
- GetObjectAttributes][2
^
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html
6365 6366 6367 6368 |
# File 'lib/aws-sdk-s3/client.rb', line 6365 def get_object_legal_hold(params = {}, = {}) req = build_request(:get_object_legal_hold, params) req.send_request() end |
#get_object_lock_configuration(params = {}) ⇒ Types::GetObjectLockConfigurationOutput
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 ‘GetObjectLockConfiguration`:
- GetObjectAttributes][2
^
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html
6428 6429 6430 6431 |
# File 'lib/aws-sdk-s3/client.rb', line 6428 def get_object_lock_configuration(params = {}, = {}) req = build_request(:get_object_lock_configuration, params) req.send_request() end |
#get_object_retention(params = {}) ⇒ Types::GetObjectRetentionOutput
Retrieves an object’s retention settings. For more information, see [Locking Objects].
This action is not supported by Amazon S3 on Outposts.
The following action is related to ‘GetObjectRetention`:
- GetObjectAttributes][2
^
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html
6512 6513 6514 6515 |
# File 'lib/aws-sdk-s3/client.rb', line 6512 def get_object_retention(params = {}, = {}) req = build_request(:get_object_retention, params) req.send_request() end |
#get_object_tagging(params = {}) ⇒ Types::GetObjectTaggingOutput
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 ‘s3:GetObjectTagging` action. By default, the GET action returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the `s3:GetObjectVersionTagging` action.
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 ‘GetObjectTagging`:
- DeleteObjectTagging][2
- GetObjectAttributes][3
- PutObjectTagging][4
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html
6668 6669 6670 6671 |
# File 'lib/aws-sdk-s3/client.rb', line 6668 def get_object_tagging(params = {}, = {}) req = build_request(:get_object_tagging, params) req.send_request() end |
#get_object_torrent(params = {}) ⇒ Types::GetObjectTorrentOutput
Returns torrent files from a bucket. BitTorrent can save you bandwidth when you’re distributing large files. For more information about BitTorrent, see [Using BitTorrent with Amazon S3].
<note markdown=“1”> 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.
</note>
To use GET, you must have READ access to the object.
This action is not supported by Amazon S3 on Outposts.
The following action is related to ‘GetObjectTorrent`:
- GetObject][2
^
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/S3Torrent.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
6761 6762 6763 6764 |
# File 'lib/aws-sdk-s3/client.rb', line 6761 def get_object_torrent(params = {}, = {}, &block) req = build_request(:get_object_torrent, params) req.send_request(, &block) end |
#get_public_access_block(params = {}) ⇒ Types::GetPublicAccessBlockOutput
Retrieves the ‘PublicAccessBlock` configuration for an Amazon S3 bucket. To use this operation, you must have the `s3:GetBucketPublicAccessBlock` permission. For more information about Amazon S3 permissions, see [Specifying Permissions in a Policy].
When Amazon S3 evaluates the ‘PublicAccessBlock` configuration for a bucket or an object, it checks the `PublicAccessBlock` configuration for both the bucket (or the bucket that contains the object) and the bucket owner’s account. If the ‘PublicAccessBlock` settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.
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 ‘GetPublicAccessBlock`:
- Using Amazon S3 Block Public Access][3
- PutPublicAccessBlock][4
- GetPublicAccessBlock][5
- DeletePublicAccessBlock][6
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status [3]: docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html
6832 6833 6834 6835 |
# File 'lib/aws-sdk-s3/client.rb', line 6832 def get_public_access_block(params = {}, = {}) req = build_request(:get_public_access_block, params) req.send_request() end |
#head_bucket(params = {}) ⇒ Struct
This action is useful to determine if a bucket exists and you have permission to access it. The action returns a ‘200 OK` if the bucket exists and you have permission to access it.
If the bucket does not exist or you do not have permission to access it, the ‘HEAD` request returns a generic `404 Not Found` or `403 Forbidden` code. A message body is not included, so you cannot determine the exception beyond these error codes.
To use this operation, you must have permissions to perform the ‘s3:ListBucket` action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to Your Amazon S3 Resources].
To use this API against an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using the Amazon Web Services SDKs, you provide the ARN in place of the bucket name. For more information see, [Using access points].
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
The following waiters are defined for this operation (see #wait_until for detailed usage):
* bucket_exists
* bucket_not_exists
6925 6926 6927 6928 |
# File 'lib/aws-sdk-s3/client.rb', line 6925 def head_bucket(params = {}, = {}) req = build_request(:head_bucket, params) req.send_request() end |
#head_object(params = {}) ⇒ Types::HeadObjectOutput
The HEAD action retrieves metadata from an object without returning the object itself. This action is useful if you’re only interested in an object’s metadata. To use HEAD, you must have READ access to the object.
A ‘HEAD` request has the same options as a `GET` action on an object. The response is identical to the `GET` response except that there is no response body. Because of this, if the `HEAD` request generates an error, it returns a generic `404 Not Found` or `403 Forbidden` code. It is not possible to retrieve the exact exception beyond these error codes.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:
-
x-amz-server-side-encryption-customer-algorithm
-
x-amz-server-side-encryption-customer-key
-
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see [Server-Side Encryption (Using Customer-Provided Encryption Keys)].
<note markdown=“1”> * Encryption request headers, like ‘x-amz-server-side-encryption`,
should not be sent for GET requests if your object uses server-side
encryption with KMS keys (SSE-KMS) or server-side encryption with
Amazon S3–managed encryption keys (SSE-S3). If your object does use
these types of keys, you’ll get an HTTP 400 BadRequest error.
-
The last modified property in this case is the creation date of the object.
</note>
Request headers are limited to 8 KB in size. For more information, see [Common Request Headers].
Consider the following when using request headers:
-
Consideration 1 – If both of the ‘If-Match` and `If-Unmodified-Since` headers are present in the request as follows:
-
‘If-Match` condition evaluates to `true`, and;
-
‘If-Unmodified-Since` condition evaluates to `false`;
Then Amazon S3 returns ‘200 OK` and the data requested.
-
-
Consideration 2 – If both of the ‘If-None-Match` and `If-Modified-Since` headers are present in the request as follows:
-
‘If-None-Match` condition evaluates to `false`, and;
-
‘If-Modified-Since` condition evaluates to `true`;
Then Amazon S3 returns the ‘304 Not Modified` response code.
-
For more information about conditional requests, see [RFC 7232].
Permissions
You need the relevant read object (or version) permission for this operation. For more information, see [Specifying Permissions in a Policy]. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.
-
If you have the ‘s3:ListBucket` permission on the bucket, Amazon S3 returns an HTTP status code 404 (“no such key”) error.
-
If you don’t have the ‘s3:ListBucket` permission, Amazon S3 returns an HTTP status code 403 (“access denied”) error.
The following actions are related to ‘HeadObject`:
- GetObject][5
- GetObjectAttributes][6
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html [3]: tools.ietf.org/html/rfc7232 [4]: docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html
The following waiters are defined for this operation (see #wait_until for detailed usage):
* object_exists
* object_not_exists
7247 7248 7249 7250 |
# File 'lib/aws-sdk-s3/client.rb', line 7247 def head_object(params = {}, = {}) req = build_request(:head_object, params) req.send_request() end |
#list_bucket_analytics_configurations(params = {}) ⇒ Types::ListBucketAnalyticsConfigurationsOutput
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 ‘IsTruncated` element in the response. If there are no more configurations to list, `IsTruncated` is set to false. If there are more configurations to list, `IsTruncated` is set to true, and there will be a value in `NextContinuationToken`. You use the `NextContinuationToken` value to continue the pagination of the list by passing the value in continuation-token in the request to `GET` the next page.
To use this operation, you must have permissions to perform the ‘s3:GetAnalyticsConfiguration` action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to Your Amazon S3 Resources].
For information about Amazon S3 analytics feature, see [Amazon S3 Analytics – Storage Class Analysis].
The following operations are related to ‘ListBucketAnalyticsConfigurations`:
- GetBucketAnalyticsConfiguration][4
- DeleteBucketAnalyticsConfiguration][5
- PutBucketAnalyticsConfiguration][6
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html
7344 7345 7346 7347 |
# File 'lib/aws-sdk-s3/client.rb', line 7344 def list_bucket_analytics_configurations(params = {}, = {}) req = build_request(:list_bucket_analytics_configurations, params) req.send_request() end |
#list_bucket_intelligent_tiering_configurations(params = {}) ⇒ Types::ListBucketIntelligentTieringConfigurationsOutput
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 ‘ListBucketIntelligentTieringConfigurations` include:
- DeleteBucketIntelligentTieringConfiguration][2
- PutBucketIntelligentTieringConfiguration][3
- GetBucketIntelligentTieringConfiguration][4
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html
7432 7433 7434 7435 |
# File 'lib/aws-sdk-s3/client.rb', line 7432 def list_bucket_intelligent_tiering_configurations(params = {}, = {}) req = build_request(:list_bucket_intelligent_tiering_configurations, params) req.send_request() end |
#list_bucket_inventory_configurations(params = {}) ⇒ Types::ListBucketInventoryConfigurationsOutput
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 ‘IsTruncated` element in the response. If there are no more configurations to list, `IsTruncated` is set to false. If there are more configurations to list, `IsTruncated` is set to true, and there is a value in `NextContinuationToken`. You use the `NextContinuationToken` value to continue the pagination of the list by passing the value in continuation-token in the request to `GET` the next page.
To use this operation, you must have permissions to perform the ‘s3:GetInventoryConfiguration` action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to Your Amazon S3 Resources].
For information about the Amazon S3 inventory feature, see [Amazon S3 Inventory]
The following operations are related to ‘ListBucketInventoryConfigurations`:
- GetBucketInventoryConfiguration][4
- DeleteBucketInventoryConfiguration][5
- PutBucketInventoryConfiguration][6
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html
7530 7531 7532 7533 |
# File 'lib/aws-sdk-s3/client.rb', line 7530 def list_bucket_inventory_configurations(params = {}, = {}) req = build_request(:list_bucket_inventory_configurations, params) req.send_request() end |
#list_bucket_metrics_configurations(params = {}) ⇒ Types::ListBucketMetricsConfigurationsOutput
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 ‘IsTruncated` element in the response. If there are no more configurations to list, `IsTruncated` is set to false. If there are more configurations to list, `IsTruncated` is set to true, and there is a value in `NextContinuationToken`. You use the `NextContinuationToken` value to continue the pagination of the list by passing the value in `continuation-token` in the request to `GET` the next page.
To use this operation, you must have permissions to perform the ‘s3:GetMetricsConfiguration` action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to Your Amazon S3 Resources].
For more information about metrics configurations and CloudWatch request metrics, see [Monitoring Metrics with Amazon CloudWatch].
The following operations are related to ‘ListBucketMetricsConfigurations`:
- PutBucketMetricsConfiguration][4
- GetBucketMetricsConfiguration][5
- DeleteBucketMetricsConfiguration][6
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html
7628 7629 7630 7631 |
# File 'lib/aws-sdk-s3/client.rb', line 7628 def list_bucket_metrics_configurations(params = {}, = {}) req = build_request(:list_bucket_metrics_configurations, params) req.send_request() end |
#list_buckets(params = {}) ⇒ Types::ListBucketsOutput
Returns a list of all buckets owned by the authenticated sender of the request. To use this operation, you must have the ‘s3:ListAllMyBuckets` permission.
7686 7687 7688 7689 |
# File 'lib/aws-sdk-s3/client.rb', line 7686 def list_buckets(params = {}, = {}) req = build_request(:list_buckets, params) req.send_request() end |
#list_multipart_uploads(params = {}) ⇒ Types::ListMultipartUploadsOutput
This action lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.
This action returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum number of uploads a response can include, which is also the default value. You can further limit the number of uploads in a response by specifying the ‘max-uploads` parameter in the response. If additional multipart uploads satisfy the list criteria, the response will contain an `IsTruncated` element with the value true. To list the additional multipart uploads, use the `key-marker` and `upload-id-marker` request parameters.
In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time.
For more information on multipart uploads, see [Uploading Objects Using Multipart Upload].
For information on permissions required to use the multipart upload API, see [Multipart Upload and Permissions].
The following operations are related to ‘ListMultipartUploads`:
- CreateMultipartUpload][3
- UploadPart][4
- CompleteMultipartUpload][5
- ListParts][6
- AbortMultipartUpload][7
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7974 7975 7976 7977 |
# File 'lib/aws-sdk-s3/client.rb', line 7974 def list_multipart_uploads(params = {}, = {}) req = build_request(:list_multipart_uploads, params) req.send_request() end |
#list_object_versions(params = {}) ⇒ Types::ListObjectVersionsOutput
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 permissions to perform the ‘s3:ListBucketVersions` action. Be aware of the name difference.
<note markdown=“1”> A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.
</note>
To use this operation, you must have READ access to the bucket.
This action is not supported by Amazon S3 on Outposts.
The following operations are related to ‘ListObjectVersions`:
- ListObjectsV2][1
- GetObject][2
- PutObject][3
- DeleteObject][4
[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8172 8173 8174 8175 |
# File 'lib/aws-sdk-s3/client.rb', line 8172 def list_object_versions(params = {}, = {}) req = build_request(:list_object_versions, params) req.send_request() end |
#list_objects(params = {}) ⇒ Types::ListObjectsOutput
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 ‘ListObjects`.
The following operations are related to ‘ListObjects`:
- ListObjectsV2][1
- GetObject][2
- PutObject][3
- CreateBucket][4
- ListBuckets][5
[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8360 8361 8362 8363 |
# File 'lib/aws-sdk-s3/client.rb', line 8360 def list_objects(params = {}, = {}) req = build_request(:list_objects, params) req.send_request() end |
#list_objects_v2(params = {}) ⇒ Types::ListObjectsV2Output
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 ‘200 OK` response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. Objects are returned sorted in an ascending order of the respective key names in the list. For more information about listing objects, see
- Listing object keys programmatically][1
-
To use this operation, you must have READ access to the bucket.
To use this action in an Identity and Access Management (IAM) policy, you must have permissions to perform the ‘s3:ListBucket` action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see
- Permissions Related to Bucket Subresource Operations][2
-
and
[Managing Access Permissions to Your Amazon S3 Resources].
This section describes the latest revision of this action. We recommend that you use this revised API for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API, [ListObjects].
To get a list of your buckets, see [ListBuckets].
The following operations are related to ‘ListObjectsV2`:
- GetObject][6
- PutObject][7
- CreateBucket][8
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html [8]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8571 8572 8573 8574 |
# File 'lib/aws-sdk-s3/client.rb', line 8571 def list_objects_v2(params = {}, = {}) req = build_request(:list_objects_v2, params) req.send_request() end |
#list_parts(params = {}) ⇒ Types::ListPartsOutput
Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see [CreateMultipartUpload]). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the ‘max-parts` request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an `IsTruncated` field with the value of true, and a `NextPartNumberMarker` element. In subsequent `ListParts` requests you can include the part-number-marker query string parameter and set its value to the `NextPartNumberMarker` field value from the previous response.
If the upload was created using a checksum algorithm, you will need to have permission to the ‘kms:Decrypt` action for the request to succeed.
For more information on multipart uploads, see [Uploading Objects Using Multipart Upload].
For information on permissions required to use the multipart upload API, see [Multipart Upload and Permissions].
The following operations are related to ‘ListParts`:
- CreateMultipartUpload][1
- UploadPart][4
- CompleteMultipartUpload][5
- AbortMultipartUpload][6
- GetObjectAttributes][7
- ListMultipartUploads][8
[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html [8]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8814 8815 8816 8817 |
# File 'lib/aws-sdk-s3/client.rb', line 8814 def list_parts(params = {}, = {}) req = build_request(:list_parts, params) req.send_request() end |
#put_bucket_accelerate_configuration(params = {}) ⇒ Struct
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 ‘s3:PutAccelerateConfiguration` action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to Your Amazon S3 Resources].
The Transfer Acceleration state of a bucket can be set to one of the following two values:
-
Enabled – Enables accelerated data transfers to the bucket.
-
Suspended – Disables accelerated data transfers to the bucket.
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 ‘PutBucketAccelerateConfiguration`:
- GetBucketAccelerateConfiguration][3
- CreateBucket][5
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html [4]: docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
8909 8910 8911 8912 |
# File 'lib/aws-sdk-s3/client.rb', line 8909 def put_bucket_accelerate_configuration(params = {}, = {}) req = build_request(:put_bucket_accelerate_configuration, params) req.send_request() end |
#put_bucket_acl(params = {}) ⇒ Struct
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 ‘WRITE_ACP` permission.
You can use one of the following two ways to set a bucket’s permissions:
-
Specify the ACL in the request body
-
Specify permissions using request headers
<note markdown=“1”> You cannot specify access permission using both the body and the request headers.
</note>
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 ‘AccessControlListNotSupported` error code. Requests to read ACLs are still supported. For more information, see [Controlling object ownership] in the *Amazon S3 User Guide*.
**Access Permissions**
You can set access permissions using one of the following methods:
-
Specify a canned ACL with the ‘x-amz-acl` request header. Amazon S3 supports a set of predefined ACLs, known as *canned ACLs*. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of `x-amz-acl`. If you use this header, you cannot use other access control-specific headers in your request. For more information, see [Canned ACL].
-
Specify access permissions explicitly with the ‘x-amz-grant-read`, `x-amz-grant-read-acp`, `x-amz-grant-write-acp`, and `x-amz-grant-full-control` headers. When using these headers, you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use the `x-amz-acl` header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see [Access Control List (ACL) Overview].
You specify each grantee as a type=value pair, where the type is one of the following:
-
‘id` – if the value specified is the canonical user ID of an Amazon Web Services account
-
‘uri` – if you are granting permissions to a predefined group
-
‘emailAddress` – if the value specified is the email address of an Amazon Web Services account
<note markdown=“1”> Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
* US East (N. Virginia)
-
US West (N. California)
-
US West (Oregon)
-
Asia Pacific (Singapore)
-
Asia Pacific (Sydney)
-
Asia Pacific (Tokyo)
-
Europe (Ireland)
-
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints,
see [Regions and Endpoints] in the Amazon Web Services General Reference.
</note>
-
For example, the following ‘x-amz-grant-write` header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two Amazon Web Services accounts identified by their email addresses.
‘x-amz-grant-write: uri=“acs.amazonaws.com/groups/s3/LogDelivery”, id=“111122223333”, id=“555566667777” `
-
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
**Grantee Values**
You can specify the person (grantee) to whom you’re assigning access rights (using request elements) in the following ways:
-
By the person’s ID:
‘<Grantee xmlns:xsi=“www.w3.org/2001/XMLSchema-instance” xsi:type=“CanonicalUser”><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>`
DisplayName is optional and ignored in the request
-
By URI:
‘<Grantee xmlns:xsi=“www.w3.org/2001/XMLSchema-instance” xsi:type=“Group”><URI><>acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>`
-
By Email address:
‘<Grantee xmlns:xsi=“www.w3.org/2001/XMLSchema-instance” xsi:type=“AmazonCustomerByEmail”><EmailAddress><>[email protected]<></EmailAddress>lt;/Grantee>`
The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
<note markdown=“1”> Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
* US East (N. Virginia)
-
US West (N. California)
-
US West (Oregon)
-
Asia Pacific (Singapore)
-
Asia Pacific (Sydney)
-
Asia Pacific (Tokyo)
-
Europe (Ireland)
-
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see
- Regions and Endpoints][5
-
in the Amazon Web Services General
Reference.
</note>
-
**Related Resources**
- CreateBucket][6
- DeleteBucket][7
- GetObjectAcl][8
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL [4]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html [5]: docs.aws.amazon.com/general/latest/gr/rande.html#s3_region [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html [8]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html
9197 9198 9199 9200 |
# File 'lib/aws-sdk-s3/client.rb', line 9197 def put_bucket_acl(params = {}, = {}) req = build_request(:put_bucket_acl, params) req.send_request() end |
#put_bucket_analytics_configuration(params = {}) ⇒ Struct
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 ‘DataExport` request element. Reports are updated daily and are based on the object filters that you configure. When selecting data export, you specify a destination bucket and an optional destination prefix where the file is written. You can export the data to a destination bucket in a different account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT analytics configuration to. For more information, see [Amazon S3 Analytics – Storage Class Analysis].
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 ‘s3:PutAnalyticsConfiguration` action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to Your Amazon S3 Resources].
**Special Errors**
-
*HTTP Error: HTTP 400 Bad Request*
-
*Code: InvalidArgument*
-
*Cause: Invalid argument.*
-
-
*HTTP Error: HTTP 400 Bad Request*
-
*Code: TooManyConfigurations*
-
*Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.*
-
-
*HTTP Error: HTTP 403 Forbidden*
-
*Code: AccessDenied*
-
*Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket.*
-
**Related Resources**
- GetBucketAnalyticsConfiguration][5
- DeleteBucketAnalyticsConfiguration][6
- ListBucketAnalyticsConfigurations][7
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9 [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html
9330 9331 9332 9333 |
# File 'lib/aws-sdk-s3/client.rb', line 9330 def put_bucket_analytics_configuration(params = {}, = {}) req = build_request(:put_bucket_analytics_configuration, params) req.send_request() end |
#put_bucket_cors(params = {}) ⇒ Struct
Sets the ‘cors` configuration for your bucket. If the configuration exists, Amazon S3 replaces it.
To use this operation, you must be allowed to perform the ‘s3:PutBucketCORS` action. By default, the bucket owner has this permission and can grant it to others.
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 ‘www.example.com` to access your Amazon S3 bucket at `my.example.bucket.com` by using the browser’s ‘XMLHttpRequest` capability.
To enable cross-origin resource sharing (CORS) on a bucket, you add the ‘cors` subresource to the bucket. The `cors` subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size.
When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the ‘cors` configuration on the bucket and uses the first `CORSRule` rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met:
-
The request’s ‘Origin` header must match `AllowedOrigin` elements.
-
The request method (for example, GET, PUT, HEAD, and so on) or the ‘Access-Control-Request-Method` header in case of a pre-flight `OPTIONS` request must be one of the `AllowedMethod` elements.
-
Every header specified in the ‘Access-Control-Request-Headers` request header of a pre-flight request must match an `AllowedHeader` element.
For more information about CORS, go to [Enabling Cross-Origin Resource Sharing] in the *Amazon S3 User Guide*.
**Related Resources**
- GetBucketCors][2
- DeleteBucketCors][3
- RESTOPTIONSobject][4
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/cors.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketCors.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html
9505 9506 9507 9508 |
# File 'lib/aws-sdk-s3/client.rb', line 9505 def put_bucket_cors(params = {}, = {}) req = build_request(:put_bucket_cors, params) req.send_request() end |
#put_bucket_encryption(params = {}) ⇒ Struct
This action uses the ‘encryption` subresource to configure default encryption and Amazon S3 Bucket Key for an existing bucket.
Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS). If you specify default encryption using SSE-KMS, you can also configure Amazon S3 Bucket Key. When the default encryption is SSE-KMS, if you upload an object to the bucket and do not specify the KMS key to use for encryption, Amazon S3 uses the default Amazon Web Services managed KMS key for your account. For information about default encryption, see [Amazon S3 default bucket encryption] in the *Amazon S3 User Guide*. For more information about S3 Bucket Keys, see [Amazon S3 Bucket Keys] in the *Amazon S3 User Guide*.
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 permissions to perform the ‘s3:PutEncryptionConfiguration` action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to Your Amazon S3 Resources] in the Amazon S3 User Guide.
**Related Resources**
- GetBucketEncryption][6
- DeleteBucketEncryption][7
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [5]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html
9621 9622 9623 9624 |
# File 'lib/aws-sdk-s3/client.rb', line 9621 def put_bucket_encryption(params = {}, = {}) req = build_request(:put_bucket_encryption, params) req.send_request() end |
#put_bucket_intelligent_tiering_configuration(params = {}) ⇒ Struct
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 ‘PutBucketIntelligentTieringConfiguration` include:
- DeleteBucketIntelligentTieringConfiguration][2
- GetBucketIntelligentTieringConfiguration][3
- ListBucketIntelligentTieringConfigurations][4
<note markdown=“1”> 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.
</note>
**Special Errors**
-
**HTTP 400 Bad Request Error**
-
Code: InvalidArgument
-
Cause: Invalid Argument
-
-
**HTTP 400 Bad Request Error**
-
Code: TooManyConfigurations
-
Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
-
-
**HTTP 403 Forbidden Error**
-
Code: AccessDenied
-
Cause: You are not the owner of the specified bucket, or you do not have the ‘s3:PutIntelligentTieringConfiguration` bucket permission to set the configuration on the bucket.
-
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html
9743 9744 9745 9746 |
# File 'lib/aws-sdk-s3/client.rb', line 9743 def put_bucket_intelligent_tiering_configuration(params = {}, = {}) req = build_request(:put_bucket_intelligent_tiering_configuration, params) req.send_request() end |
#put_bucket_inventory_configuration(params = {}) ⇒ Struct
This implementation of the ‘PUT` action adds an inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket.
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][1
-
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].
To use this operation, you must have permissions to perform the ‘s3:PutInventoryConfiguration` action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to Your Amazon S3 Resources] in the Amazon S3 User Guide.
**Special Errors**
-
**HTTP 400 Bad Request Error**
-
Code: InvalidArgument
-
Cause: Invalid Argument
-
-
**HTTP 400 Bad Request Error**
-
Code: TooManyConfigurations
-
Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
-
-
**HTTP 403 Forbidden Error**
-
Code: AccessDenied
-
Cause: You are not the owner of the specified bucket, or you do not have the ‘s3:PutInventoryConfiguration` bucket permission to set the configuration on the bucket.
-
**Related Resources**
- GetBucketInventoryConfiguration][5
- DeleteBucketInventoryConfiguration][6
- ListBucketInventoryConfigurations][7
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9 [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html
9875 9876 9877 9878 |
# File 'lib/aws-sdk-s3/client.rb', line 9875 def put_bucket_inventory_configuration(params = {}, = {}) req = build_request(:put_bucket_inventory_configuration, params) req.send_request() end |
#put_bucket_lifecycle(params = {}) ⇒ Struct
For an updated version of this API, see [PutBucketLifecycleConfiguration]. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API.
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see [Object Lifecycle Management] in the *Amazon S3 User Guide*.
By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the Amazon Web Services account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the ‘s3:PutLifecycleConfiguration` permission.
You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:
-
‘s3:DeleteObject`
-
‘s3:DeleteObjectVersion`
-
‘s3:PutLifecycleConfiguration`
For more information about permissions, see [Managing Access Permissions to your Amazon S3 Resources] in the *Amazon S3 User Guide*.
For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see [Examples of Lifecycle Configuration].
**Related Resources**
-
[GetBucketLifecycle](Deprecated)
- GetBucketLifecycleConfiguration][6
- RestoreObject][7
-
By default, a resource owner—in this case, a bucket owner, which is the Amazon Web Services account that created the bucket—can perform any of the operations. A resource owner can also grant others permission to perform the operation. For more information, see the following topics in the Amazon S3 User Guide:
- Specifying Permissions in a Policy][8
- Managing Access Permissions to your Amazon S3 Resources][3
[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [4]: docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#lifecycle-configuration-examples [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html [8]: docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
10022 10023 10024 10025 |
# File 'lib/aws-sdk-s3/client.rb', line 10022 def put_bucket_lifecycle(params = {}, = {}) req = build_request(:put_bucket_lifecycle, params) req.send_request() end |
#put_bucket_lifecycle_configuration(params = {}) ⇒ Struct
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].
<note markdown=“1”> Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. 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].
</note>
Rules
You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle configuration can have up to 1,000 rules. This limit is not adjustable. Each rule consists of the following:
-
Filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both.
-
Status whether the rule is in effect.
-
One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.
For more information, see [Object Lifecycle Management] and [Lifecycle Configuration Elements].
Permissions
By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the ‘s3:PutLifecycleConfiguration` permission.
You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:
-
‘s3:DeleteObject`
-
‘s3:DeleteObjectVersion`
-
‘s3:PutLifecycleConfiguration`
For more information about permissions, see [Managing Access Permissions to Your Amazon S3 Resources].
The following are related to ‘PutBucketLifecycleConfiguration`:
- Examples of Lifecycle Configuration][6
- GetBucketLifecycleConfiguration][7
- DeleteBucketLifecycle][8
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html [4]: docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html [5]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [6]: docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-configuration-examples.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html [8]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html
10237 10238 10239 10240 |
# File 'lib/aws-sdk-s3/client.rb', line 10237 def put_bucket_lifecycle_configuration(params = {}, = {}) req = build_request(:put_bucket_lifecycle_configuration, params) req.send_request() end |
#put_bucket_logging(params = {}) ⇒ Struct
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 ‘Grantee` request element to grant access to other people. The `Permissions` request element specifies the kind of access the grantee has to the logs.
If the target bucket for log delivery uses the bucket owner enforced setting for S3 Object Ownership, you can’t use the ‘Grantee` request element to grant access to others. Permissions can only be granted using policies. For more information, see [Permissions for server access log delivery] in the *Amazon S3 User Guide*.
**Grantee Values**
You can specify the person (grantee) to whom you’re assigning access rights (using request elements) in the following ways:
-
By the person’s ID:
‘<Grantee xmlns:xsi=“www.w3.org/2001/XMLSchema-instance” xsi:type=“CanonicalUser”><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>`
DisplayName is optional and ignored in the request.
-
By Email address:
‘ <Grantee xmlns:xsi=“www.w3.org/2001/XMLSchema-instance” xsi:type=“AmazonCustomerByEmail”><EmailAddress><>[email protected]<></EmailAddress></Grantee>`
The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
-
By URI:
‘<Grantee xmlns:xsi=“www.w3.org/2001/XMLSchema-instance” xsi:type=“Group”><URI><>acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>`
To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you use an empty BucketLoggingStatus request element:
‘<BucketLoggingStatus xmlns=“doc.s3.amazonaws.com/2006-03-01” />`
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 ‘PutBucketLogging`:
- PutObject][5
- DeleteBucket][6
- CreateBucket][3
- GetBucketLogging][4
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/ServerLogs.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html
10409 10410 10411 10412 |
# File 'lib/aws-sdk-s3/client.rb', line 10409 def put_bucket_logging(params = {}, = {}) req = build_request(:put_bucket_logging, params) req.send_request() end |
#put_bucket_metrics_configuration(params = {}) ⇒ Struct
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 ‘s3:PutMetricsConfiguration` action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to Your Amazon S3 Resources].
For information about CloudWatch request metrics for Amazon S3, see [Monitoring Metrics with Amazon CloudWatch].
The following operations are related to ‘PutBucketMetricsConfiguration`:
- DeleteBucketMetricsConfiguration][4
- GetBucketMetricsConfiguration][5
- ListBucketMetricsConfigurations][6
‘GetBucketLifecycle` has the following special error:
-
Error code: ‘TooManyConfigurations`
-
Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
-
HTTP Status Code: HTTP 400 Bad Request
-
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html
10507 10508 10509 10510 |
# File 'lib/aws-sdk-s3/client.rb', line 10507 def put_bucket_metrics_configuration(params = {}, = {}) req = build_request(:put_bucket_metrics_configuration, params) req.send_request() end |
#put_bucket_notification(params = {}) ⇒ Struct
No longer used, see the [PutBucketNotificationConfiguration] operation.
[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotificationConfiguration.html
10589 10590 10591 10592 |
# File 'lib/aws-sdk-s3/client.rb', line 10589 def put_bucket_notification(params = {}, = {}) req = build_request(:put_bucket_notification, params) req.send_request() end |
#put_bucket_notification_configuration(params = {}) ⇒ Struct
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 ‘NotificationConfiguration`.
‘<NotificationConfiguration>`
‘</NotificationConfiguration>`
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 ‘s3:PutBucketNotification` permission.
<note markdown=“1”> 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.
</note>
Responses
If the configuration in the request body includes only one ‘TopicConfiguration` specifying only the `s3:ReducedRedundancyLostObject` event type, the response will also include the `x-amz-sns-test-message-id` header containing the message ID of the test notification sent to the topic.
The following action is related to ‘PutBucketNotificationConfiguration`:
- GetBucketNotificationConfiguration][3
^
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html [2]: docs.aws.amazon.com/general/latest/gr/s3.html#limits_s3 [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html
10771 10772 10773 10774 |
# File 'lib/aws-sdk-s3/client.rb', line 10771 def put_bucket_notification_configuration(params = {}, = {}) req = build_request(:put_bucket_notification_configuration, params) req.send_request() end |
#put_bucket_ownership_controls(params = {}) ⇒ Struct
Creates or modifies ‘OwnershipControls` for an Amazon S3 bucket. To use this operation, you must have the `s3:PutBucketOwnershipControls` permission. For more information about Amazon S3 permissions, see [Specifying permissions in a policy].
For information about Amazon S3 Object Ownership, see [Using object ownership].
The following operations are related to ‘PutBucketOwnershipControls`:
-
GetBucketOwnershipControls
-
DeleteBucketOwnershipControls
[1]: docs.aws.amazon.com/AmazonS3/latest/user-guide/using-with-s3-actions.html [2]: docs.aws.amazon.com/AmazonS3/latest/user-guide/about-object-ownership.html
10836 10837 10838 10839 |
# File 'lib/aws-sdk-s3/client.rb', line 10836 def put_bucket_ownership_controls(params = {}, = {}) req = build_request(:put_bucket_ownership_controls, params) req.send_request() end |
#put_bucket_policy(params = {}) ⇒ Struct
Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the ‘PutBucketPolicy` permissions on the specified bucket and belong to the bucket owner’s account in order to use this operation.
If you don’t have ‘PutBucketPolicy` permissions, Amazon S3 returns a `403 Access Denied` error. If you have the correct permissions, but you’re not using an identity that belongs to the bucket owner’s account, Amazon S3 returns a ‘405 Method Not Allowed` error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.
For more information, see [Bucket policy examples].
The following operations are related to ‘PutBucketPolicy`:
- CreateBucket][2
- DeleteBucket][3
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html
10936 10937 10938 10939 |
# File 'lib/aws-sdk-s3/client.rb', line 10936 def put_bucket_policy(params = {}, = {}) req = build_request(:put_bucket_policy, params) req.send_request() end |
#put_bucket_replication(params = {}) ⇒ Struct
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.
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: ‘DeleteMarkerReplication`, `Status`, and `Priority`.
<note markdown=“1”> 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].
</note>
For information about enabling versioning on a bucket, see [Using Versioning].
**Handling Replication of Encrypted Objects**
By default, Amazon S3 doesn’t replicate objects that are stored at rest using server-side encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following: ‘SourceSelectionCriteria`, `SseKmsEncryptedObjects`, `Status`, `EncryptionConfiguration`, and `ReplicaKmsKeyID`. For information about replication configuration, see [Replicating Objects Created with SSE Using KMS keys].
For information on ‘PutBucketReplication` errors, see [List of replication-related error codes]
Permissions
To create a ‘PutBucketReplication` request, you must have `s3:PutReplicationConfiguration` permissions for the bucket.
By default, a resource owner, in this case the Amazon Web Services account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see [Specifying Permissions in a Policy] and [Managing Access Permissions to Your Amazon S3 Resources].
<note markdown=“1”> To perform this operation, the user or role performing the action must have the [iam:PassRole] permission.
</note>
The following operations are related to ‘PutBucketReplication`:
- GetBucketReplication][9
- DeleteBucketReplication][10
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/replication.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations [3]: docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html [4]: docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList [6]: docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html [7]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [8]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html [9]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html [10]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html
11167 11168 11169 11170 |
# File 'lib/aws-sdk-s3/client.rb', line 11167 def put_bucket_replication(params = {}, = {}) req = build_request(:put_bucket_replication, params) req.send_request() end |
#put_bucket_request_payment(params = {}) ⇒ Struct
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 ‘PutBucketRequestPayment`:
- CreateBucket][2
- GetBucketRequestPayment][3
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketRequestPayment.html
11260 11261 11262 11263 |
# File 'lib/aws-sdk-s3/client.rb', line 11260 def put_bucket_request_payment(params = {}, = {}) req = build_request(:put_bucket_request_payment, params) req.send_request() end |
#put_bucket_tagging(params = {}) ⇒ Struct
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].
<note markdown=“1”> 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.
</note>
To use this operation, you must have permissions to perform the ‘s3:PutBucketTagging` action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to Your Amazon S3 Resources].
‘PutBucketTagging` has the following special errors:
-
Error code: ‘InvalidTagError`
-
Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see [User-Defined Tag Restrictions] and [Amazon Web Services-Generated Cost Allocation Tag Restrictions].
^
-
-
Error code: ‘MalformedXMLError`
-
Description: The XML provided does not match the schema.
^
-
-
Error code: ‘OperationAbortedError `
-
Description: A conflicting conditional action is currently in progress against this resource. Please try again.
^
-
-
Error code: ‘InternalError`
-
Description: The service was unable to apply the provided tag to the bucket.
^
-
The following operations are related to ‘PutBucketTagging`:
- GetBucketTagging][7
- DeleteBucketTagging][8
[1]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [5]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html [6]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html [8]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html
11424 11425 11426 11427 |
# File 'lib/aws-sdk-s3/client.rb', line 11424 def put_bucket_tagging(params = {}, = {}) req = build_request(:put_bucket_tagging, params) req.send_request() end |
#put_bucket_versioning(params = {}) ⇒ Struct
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 ‘x-amz-mfa request` header and the `Status` and the `MfaDelete` request elements in a request to set the versioning state of the bucket.
If you have an object expiration lifecycle policy 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 policy 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].
**Related Resources**
- CreateBucket][3
- DeleteBucket][4
- GetBucketVersioning][1
[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-and-other-bucket-config [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html
11551 11552 11553 11554 |
# File 'lib/aws-sdk-s3/client.rb', line 11551 def put_bucket_versioning(params = {}, = {}) req = build_request(:put_bucket_versioning, params) req.send_request() end |
#put_bucket_website(params = {}) ⇒ Struct
Sets the configuration of the website that is specified in the ‘website` subresource. To configure a bucket as a website, you can add this subresource on the bucket with website configuration information such as the file name of the index document and any redirect rules. For more information, see [Hosting Websites on Amazon S3].
This PUT action requires the ‘S3:PutBucketWebsite` permission. By default, only the bucket owner can configure the website attached to a bucket; however, bucket owners can allow other users to set the website configuration by writing a bucket policy that grants them the `S3:PutBucketWebsite` permission.
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.
-
‘WebsiteConfiguration`
-
‘RedirectAllRequestsTo`
-
‘HostName`
-
‘Protocol`
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.
-
‘WebsiteConfiguration`
-
‘IndexDocument`
-
‘Suffix`
-
‘ErrorDocument`
-
‘Key`
-
‘RoutingRules`
-
‘RoutingRule`
-
‘Condition`
-
‘HttpErrorCodeReturnedEquals`
-
‘KeyPrefixEquals`
-
‘Redirect`
-
‘Protocol`
-
‘HostName`
-
‘ReplaceKeyPrefixWith`
-
‘ReplaceKeyWith`
-
‘HttpRedirectCode`
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*.
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html
11729 11730 11731 11732 |
# File 'lib/aws-sdk-s3/client.rb', line 11729 def put_bucket_website(params = {}, = {}) req = build_request(:put_bucket_website, params) req.send_request() end |
#put_object(params = {}) ⇒ Types::PutObjectOutput
Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.
Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket.
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. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead.
To ensure that data is not corrupted traversing the network, use the ‘Content-MD5` header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.
<note markdown=“1”> * To successfully complete the ‘PutObject` request, you must have the
`s3:PutObject` in your IAM permissions.
-
To successfully change the objects acl of your ‘PutObject` request, you must have the `s3:PutObjectAcl` in your IAM permissions.
-
The ‘Content-MD5` header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see [Amazon S3 Object Lock Overview] in the *Amazon S3 User Guide*.
</note>
**Server-side Encryption**
You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. You have the option to provide your own encryption key or use Amazon Web Services managed encryption keys (SSE-S3 or SSE-KMS). For more information, see [Using Server-Side Encryption].
If you request server-side encryption using Amazon Web Services Key Management Service (SSE-KMS), you can enable an S3 Bucket Key at the object-level. For more information, see [Amazon S3 Bucket Keys] in the *Amazon S3 User Guide*.
**Access Control List (ACL)-Specific Request Headers**
You can use headers to grant ACL- based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see [Access Control List (ACL) Overview] and [Managing ACLs Using the REST API].
If the bucket that you’re uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don’t specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the ‘bucket-owner-full-control` canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a `400` error with the error code `AccessControlListNotSupported`.
For more information, see [ Controlling ownership of objects and disabling ACLs] in the *Amazon S3 User Guide*.
<note markdown=“1”> If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account will be owned by the bucket owner.
</note>
**Storage Class Options**
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see [Storage Classes] in the *Amazon S3 User Guide*.
Versioning
If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects.
For more information about versioning, see [Adding Objects to Versioning Enabled Buckets]. For information about returning the versioning state of a bucket, see [GetBucketVersioning].
**Related Resources**
- CopyObject][10
- DeleteObject][11
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html [4]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html [5]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html [6]: docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html [7]: docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html [8]: docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html [9]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html [10]: docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html [11]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html
12384 12385 12386 12387 |
# File 'lib/aws-sdk-s3/client.rb', line 12384 def put_object(params = {}, = {}) req = build_request(:put_object, params) req.send_request() end |
#put_object_acl(params = {}) ⇒ Types::PutObjectAclOutput
Uses the ‘acl` subresource to set the access control list (ACL) permissions for a new or existing object in an S3 bucket. You must have `WRITE_ACP` permission to set the ACL of an object. For more information, see [What permissions can I grant?] in the *Amazon S3 User Guide*.
This action is not supported by Amazon S3 on Outposts.
Depending on your application needs, you can choose to set the ACL on an object 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, you can continue to use that approach. For more information, see [Access Control List (ACL) Overview] in the *Amazon S3 User Guide*.
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 ‘AccessControlListNotSupported` error code. Requests to read ACLs are still supported. For more information, see [Controlling object ownership] in the *Amazon S3 User Guide*.
**Access Permissions**
You can set access permissions using one of the following methods:
-
Specify a canned ACL with the ‘x-amz-acl` request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of `x-amz-ac`l. If you use this header, you cannot use other access control-specific headers in your request. For more information, see [Canned ACL].
-
Specify access permissions explicitly with the ‘x-amz-grant-read`, `x-amz-grant-read-acp`, `x-amz-grant-write-acp`, and `x-amz-grant-full-control` headers. When using these headers, you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use `x-amz-acl` header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see [Access Control List (ACL) Overview].
You specify each grantee as a type=value pair, where the type is one of the following:
-
‘id` – if the value specified is the canonical user ID of an Amazon Web Services account
-
‘uri` – if you are granting permissions to a predefined group
-
‘emailAddress` – if the value specified is the email address of an Amazon Web Services account
<note markdown=“1”> Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
* US East (N. Virginia)
-
US West (N. California)
-
US West (Oregon)
-
Asia Pacific (Singapore)
-
Asia Pacific (Sydney)
-
Asia Pacific (Tokyo)
-
Europe (Ireland)
-
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints,
see [Regions and Endpoints] in the Amazon Web Services General Reference.
</note>
-
For example, the following ‘x-amz-grant-read` header grants list objects permission to the two Amazon Web Services accounts identified by their email addresses.
‘x-amz-grant-read: emailAddress=“[email protected]”, emailAddress=“[email protected]” `
-
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
**Grantee Values**
You can specify the person (grantee) to whom you’re assigning access rights (using request elements) in the following ways:
-
By the person’s ID:
‘<Grantee xmlns:xsi=“www.w3.org/2001/XMLSchema-instance” xsi:type=“CanonicalUser”><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>`
DisplayName is optional and ignored in the request.
-
By URI:
‘<Grantee xmlns:xsi=“www.w3.org/2001/XMLSchema-instance” xsi:type=“Group”><URI><>acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>`
-
By Email address:
‘<Grantee xmlns:xsi=“www.w3.org/2001/XMLSchema-instance” xsi:type=“AmazonCustomerByEmail”><EmailAddress><>[email protected]<></EmailAddress>lt;/Grantee>`
The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
<note markdown=“1”> Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
* US East (N. Virginia)
-
US West (N. California)
-
US West (Oregon)
-
Asia Pacific (Singapore)
-
Asia Pacific (Sydney)
-
Asia Pacific (Tokyo)
-
Europe (Ireland)
-
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see
- Regions and Endpoints][5
-
in the Amazon Web Services General
Reference.
</note>
-
Versioning
The ACL of an object is set at the object version level. By default, PUT sets the ACL of the current version of an object. To set the ACL of a different version, use the ‘versionId` subresource.
**Related Resources**
- CopyObject][6
- GetObject][7
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#permissions [2]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html [4]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL [5]: docs.aws.amazon.com/general/latest/gr/rande.html#s3_region [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
12748 12749 12750 12751 |
# File 'lib/aws-sdk-s3/client.rb', line 12748 def put_object_acl(params = {}, = {}) req = build_request(:put_object_acl, params) req.send_request() end |
#put_object_legal_hold(params = {}) ⇒ Types::PutObjectLegalHoldOutput
Applies a legal hold configuration to the specified object. For more information, see [Locking Objects].
This action is not supported by Amazon S3 on Outposts.
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
12854 12855 12856 12857 |
# File 'lib/aws-sdk-s3/client.rb', line 12854 def put_object_legal_hold(params = {}, = {}) req = build_request(:put_object_legal_hold, params) req.send_request() end |
#put_object_lock_configuration(params = {}) ⇒ Types::PutObjectLockConfigurationOutput
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].
<note markdown=“1”> * The ‘DefaultRetention` settings require both a mode and a period.
-
The ‘DefaultRetention` period can be either `Days` or `Years` but you must select one. You cannot specify `Days` and `Years` at the same time.
-
You can only enable Object Lock for new buckets. If you want to turn on Object Lock for an existing bucket, contact Amazon Web Services Support.
</note>
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
12963 12964 12965 12966 |
# File 'lib/aws-sdk-s3/client.rb', line 12963 def put_object_lock_configuration(params = {}, = {}) req = build_request(:put_object_lock_configuration, params) req.send_request() end |
#put_object_retention(params = {}) ⇒ Types::PutObjectRetentionOutput
Places an Object Retention configuration on an object. For more information, see [Locking Objects]. Users or accounts require the ‘s3:PutObjectRetention` permission in order to place an Object Retention configuration on objects. Bypassing a Governance Retention configuration requires the `s3:BypassGovernanceRetention` permission.
This action is not supported by Amazon S3 on Outposts.
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
13079 13080 13081 13082 |
# File 'lib/aws-sdk-s3/client.rb', line 13079 def put_object_retention(params = {}, = {}) req = build_request(:put_object_retention, params) req.send_request() end |
#put_object_tagging(params = {}) ⇒ Types::PutObjectTaggingOutput
Sets the supplied tag-set to an object that already exists in a bucket.
A tag is a key-value pair. 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 ‘s3:PutObjectTagging` action. By default, the bucket owner has this permission and can grant this permission to others.
To put tags of any other version, use the ‘versionId` query parameter. You also need permission for the `s3:PutObjectVersionTagging` action.
For information about the Amazon S3 object tagging feature, see [Object Tagging].
**Special Errors**
-
Code: InvalidTagError
-
*Cause: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see [Object Tagging].*
-
-
Code: MalformedXMLError
-
*Cause: The XML provided does not match the schema.*
-
-
Code: OperationAbortedError
-
*Cause: A conflicting conditional action is currently in progress against this resource. Please try again.*
-
-
*Code: InternalError*
-
*Cause: The service was unable to apply the provided tag to the object.*
-
**Related Resources**
- GetObjectTagging][1
- DeleteObjectTagging][4
[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html [2]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html
13273 13274 13275 13276 |
# File 'lib/aws-sdk-s3/client.rb', line 13273 def put_object_tagging(params = {}, = {}) req = build_request(:put_object_tagging, params) req.send_request() end |
#put_public_access_block(params = {}) ⇒ Struct
Creates or modifies the ‘PublicAccessBlock` configuration for an Amazon S3 bucket. To use this operation, you must have the `s3:PutBucketPublicAccessBlock` permission. For more information about Amazon S3 permissions, see [Specifying Permissions in a Policy].
When Amazon S3 evaluates the ‘PublicAccessBlock` configuration for a bucket or an object, it checks the `PublicAccessBlock` configuration for both the bucket (or the bucket that contains the object) and the bucket owner’s account. If the ‘PublicAccessBlock` configurations are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.
For more information about when Amazon S3 considers a bucket or an object public, see [The Meaning of “Public”].
**Related Resources**
- GetPublicAccessBlock][3
- DeletePublicAccessBlock][4
- GetBucketPolicyStatus][5
- Using Amazon S3 Block Public Access][6
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html [6]: docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html
13377 13378 13379 13380 |
# File 'lib/aws-sdk-s3/client.rb', line 13377 def put_public_access_block(params = {}, = {}) req = build_request(:put_public_access_block, params) req.send_request() end |
#restore_object(params = {}) ⇒ Types::RestoreObjectOutput
Restores an archived copy of an object back into Amazon S3
This action is not supported by Amazon S3 on Outposts.
This action performs the following types of requests:
-
‘select` - Perform a select query on an archived object
-
‘restore an archive` - Restore an archived object
To use this operation, you must have permissions to perform the ‘s3:RestoreObject` action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] and [Managing Access Permissions to Your Amazon S3 Resources] in the *Amazon S3 User Guide*.
**Querying Archives with Select Requests**
You use a select type of request to perform SQL queries on archived objects. The archived objects that are being queried by the select request must be formatted as uncompressed comma-separated values (CSV) files. You can run queries and custom analytics on your archived data without having to restore your data to a hotter Amazon S3 tier. For an overview about select requests, see [Querying Archived Objects] in the *Amazon S3 User Guide*.
When making a select request, do the following:
-
Define an output location for the select query’s output. This must be an Amazon S3 bucket in the same Amazon Web Services Region as the bucket that contains the archive object that is being queried. The Amazon Web Services account that initiates the job must have permissions to write to the S3 bucket. You can specify the storage class and encryption for the output objects stored in the bucket. For more information about output, see [Querying Archived Objects] in the *Amazon S3 User Guide*.
For more information about the ‘S3` structure in the request body, see the following:
- PutObject][4
- Managing Access with ACLs][5
-
in the *Amazon S3 User Guide*
- Protecting Data Using Server-Side Encryption][6
-
in the *Amazon
S3 User Guide*
-
Define the SQL expression for the ‘SELECT` type of restoration for your query in the request body’s ‘SelectParameters` structure. You can use expressions like the following examples.
-
The following expression returns all records from the specified object.
‘SELECT * FROM Object`
-
Assuming that you are not using any headers for data stored in the object, you can specify columns with positional headers.
‘SELECT s._1, s._2 FROM Object s WHERE s._3 > 100`
-
If you have headers and you set the ‘fileHeaderInfo` in the `CSV` structure in the request body to `USE`, you can specify headers in the query. (If you set the `fileHeaderInfo` field to `IGNORE`, the first row is skipped for the query.) You cannot mix ordinal positions with header column names.
‘SELECT s.Id, s.FirstName, s.SSN FROM S3Object s`
-
For more information about using SQL with S3 Glacier Select restore, see [SQL Reference for Amazon S3 Select and S3 Glacier Select] in the *Amazon S3 User Guide*.
When making a select request, you can also do the following:
-
To expedite your queries, specify the ‘Expedited` tier. For more information about tiers, see “Restoring Archives,” later in this topic.
-
Specify details about the data serialization format of both the input object that is being queried and the serialization of the CSV-encoded query results.
The following are additional important facts about the select feature:
-
The output results are new Amazon S3 objects. Unlike archive retrievals, they are stored until explicitly deleted-manually or through a lifecycle policy.
-
You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn’t deduplicate requests, so avoid issuing duplicate requests.
-
Amazon S3 accepts a select request even if the object has already been restored. A select request doesn’t return error response ‘409`.
**Restoring objects**
Objects that you archive to the S3 Glacier or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers are not accessible in real time. For objects in Archive Access or Deep Archive Access tiers you must first initiate a restore request, and then wait until the object is moved into the Frequent Access tier. For objects in S3 Glacier or S3 Glacier Deep Archive storage classes you must first initiate a restore request, and then wait until a temporary copy of the object is available. To access an archived object, you must restore the object for the duration (number of days) that you specify.
To restore a specific object version, you can provide a version ID. If you don’t provide a version ID, Amazon S3 restores the current version.
When restoring an archived object (or using a select request), you can specify one of the following data access tier options in the ‘Tier` element of the request body:
-
‘Expedited` - Expedited retrievals allow you to quickly access your data stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests for a subset of archives are required. For all but the largest archived objects (250 MB+), data accessed using Expedited retrievals is typically made available within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for Expedited retrievals is available when you need it. Expedited retrievals and provisioned capacity are not available for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier.
-
‘Standard` - Standard retrievals allow you to access any of your archived objects within several hours. This is the default option for retrieval requests that do not specify the retrieval option. Standard retrievals typically finish within 3–5 hours for objects stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in S3 Intelligent-Tiering.
-
‘Bulk` - Bulk retrievals are the lowest-cost retrieval option in S3 Glacier, enabling you to retrieve large amounts, even petabytes, of data inexpensively. Bulk retrievals typically finish within 5–12 hours for objects stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Bulk retrievals are free for objects stored in S3 Intelligent-Tiering.
For more information about archive retrieval options and provisioned capacity for ‘Expedited` data access, see [Restoring Archived Objects] in the *Amazon S3 User Guide*.
You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. For more information, see [ Upgrading the speed of an in-progress restore] in the *Amazon S3 User Guide*.
To get the status of object restoration, you can send a ‘HEAD` request. Operations return the `x-amz-restore` header, which provides information about the restoration status, in the response. You can use Amazon S3 event notifications to notify you when a restore is initiated or completed. For more information, see [Configuring Amazon S3 Event Notifications] in the *Amazon S3 User Guide*.
After restoring an archived object, you can update the restoration period by reissuing the request with a new period. Amazon S3 updates the restoration period relative to the current time and charges only for the request-there are no data transfer charges. You cannot update the restoration period when Amazon S3 is actively processing your current restore request for the object.
If your bucket has a lifecycle configuration with a rule that includes an expiration action, the object expiration overrides the life span that you specify in a restore request. For example, if you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information about lifecycle configuration, see
- PutBucketLifecycleConfiguration][11
-
and [Object Lifecycle
Management] in *Amazon S3 User Guide*.
Responses
A successful action returns either the ‘200 OK` or `202 Accepted` status code.
-
If the object is not previously restored, then Amazon S3 returns ‘202 Accepted` in the response.
-
If the object is previously restored, Amazon S3 returns ‘200 OK` in the response.
**Special Errors**
-
*Code: RestoreAlreadyInProgress*
-
*Cause: Object restore is already in progress. (This error does not apply to SELECT type requests.)*
-
*HTTP Status Code: 409 Conflict*
-
*SOAP Fault Code Prefix: Client*
-
-
*Code: GlacierExpeditedRetrievalNotAvailable*
-
*Cause: expedited retrievals are currently not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to S3 Standard or Bulk retrievals.)*
-
*HTTP Status Code: 503*
-
*SOAP Fault Code Prefix: N/A*
-
**Related Resources**
- PutBucketLifecycleConfiguration][11
- GetBucketNotificationConfiguration][13
- SQL Reference for Amazon S3 Select and S3 Glacier Select ][7
-
in
the *Amazon S3 User Guide*
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html [5]: docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html [6]: docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html [7]: docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html [8]: docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html [9]: docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html [10]: docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html [11]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html [12]: docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html [13]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html
13812 13813 13814 13815 |
# File 'lib/aws-sdk-s3/client.rb', line 13812 def restore_object(params = {}, = {}) req = build_request(:restore_object, params) req.send_request() end |
#select_object_content(params = {}) ⇒ Types::SelectObjectContentOutput
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 action is not supported by 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*.
For more information about using SQL with Amazon S3 Select, see [ SQL Reference for Amazon S3 Select and S3 Glacier Select] in the *Amazon S3 User Guide*.
Permissions
You must have ‘s3:GetObject` permission for this operation. Amazon S3 Select does not support anonymous access. For more information about permissions, see [Specifying Permissions in a Policy] in the *Amazon S3 User Guide*.
*Object Data Formats*
You can use Amazon S3 Select to query objects that have the following format properties:
-
*CSV, JSON, and Parquet* - Objects must be in CSV, JSON, or Parquet format.
-
UTF-8 - UTF-8 is the only encoding type Amazon S3 Select supports.
-
*GZIP or BZIP2* - CSV and JSON files can be compressed using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression for Parquet objects.
-
*Server-side encryption* - Amazon S3 Select supports querying objects that are protected with server-side encryption.
For objects that are encrypted with customer-provided encryption keys (SSE-C), you must use HTTPS, and you must use the headers that are documented in the [GetObject]. For more information about SSE-C, see [Server-Side Encryption (Using Customer-Provided Encryption Keys)] in the *Amazon S3 User Guide*.
For objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3) and Amazon Web Services KMS keys (SSE-KMS), server-side encryption is handled transparently, so you don’t need to specify anything. For more information about server-side encryption, including SSE-S3 and SSE-KMS, see [Protecting Data Using Server-Side Encryption] in the *Amazon S3 User Guide*.
**Working with the Response Body**
Given the response size is unknown, Amazon S3 Select streams the response as a series of messages and includes a ‘Transfer-Encoding` header with `chunked` as its value in the response. For more information, see [Appendix: SelectObjectContent Response].
**GetObject Support**
The ‘SelectObjectContent` action does not support the following `GetObject` functionality. For more information, see [GetObject].
-
‘Range`: Although you can specify a scan range for an Amazon S3 Select request (see [SelectObjectContentRequest - ScanRange] in the request parameters), you cannot specify the range of bytes of an object to return.
-
GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot specify the GLACIER, DEEP_ARCHIVE, or ‘REDUCED_REDUNDANCY` storage classes. For more information, about storage classes see
- Storage Classes][10
-
in the *Amazon S3 User Guide*.
**Special Errors**
For a list of special errors for this operation, see [List of SELECT Object Content Error Codes]
**Related Resources**
- GetObject][5
- GetBucketLifecycleConfiguration][12
- PutBucketLifecycleConfiguration][13
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/selecting-content-from-objects.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-glacier-select-sql-reference-select.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html [4]: docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html [5]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html [6]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html [7]: docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html [8]: docs.aws.amazon.com/AmazonS3/latest/API/RESTSelectObjectAppendix.html [9]: docs.aws.amazon.com/AmazonS3/latest/API/API_SelectObjectContent.html#AmazonS3-SelectObjectContent-request-ScanRange [10]: docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#storage-class-intro [11]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#SelectObjectContentErrorCodeList [12]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html [13]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html
14211 14212 14213 14214 14215 14216 14217 14218 14219 14220 14221 14222 14223 14224 14225 14226 14227 14228 14229 14230 14231 14232 |
# File 'lib/aws-sdk-s3/client.rb', line 14211 def select_object_content(params = {}, = {}, &block) params = params.dup event_stream_handler = case handler = params.delete(:event_stream_handler) when EventStreams::SelectObjectContentEventStream then handler when Proc then EventStreams::SelectObjectContentEventStream.new.tap(&handler) when nil then EventStreams::SelectObjectContentEventStream.new else msg = "expected :event_stream_handler to be a block or "\ "instance of Aws::S3::EventStreams::SelectObjectContentEventStream"\ ", got `#{handler.inspect}` instead" raise ArgumentError, msg end yield(event_stream_handler) if block_given? req = build_request(:select_object_content, params) req.context[:event_stream_handler] = event_stream_handler req.handlers.add(Aws::Binary::DecodeHandler, priority: 95) req.send_request(, &block) end |
#upload_part(params = {}) ⇒ Types::UploadPartOutput
Uploads a part in a multipart upload.
<note markdown=“1”> In this operation, you provide part data 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.
</note>
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*.
To ensure that data is not corrupted when traversing the network, specify the ‘Content-MD5` header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error.
If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the ‘x-amz-content-sha256` header as a checksum instead of `Content-MD5`. For more information see [Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version 4)].
Note: 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 .
For information on the permissions required to use the multipart upload API, go to [Multipart Upload and Permissions] in the *Amazon S3 User Guide*.
You can optionally request server-side encryption where Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it for you when you access it. You have the option of providing your own encryption key, or you can use the Amazon Web Services managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in the request must match the headers you used in the request to initiate the upload by using [CreateMultipartUpload]. For more information, go to [Using Server-Side Encryption] in the *Amazon S3 User Guide*.
Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are using a customer-provided encryption key, you don’t need to specify the encryption parameters in each UploadPart request. Instead, you only need to specify the server-side encryption parameters in the initial Initiate Multipart request. For more information, see [CreateMultipartUpload].
If you requested server-side encryption using a customer-provided encryption key in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following headers.
-
x-amz-server-side-encryption-customer-algorithm
-
x-amz-server-side-encryption-customer-key
-
x-amz-server-side-encryption-customer-key-MD5
**Special Errors**
-
*Code: NoSuchUpload*
-
*Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.*
-
HTTP Status Code: 404 Not Found
-
*SOAP Fault Code Prefix: Client*
-
**Related Resources**
- CreateMultipartUpload][2
- CompleteMultipartUpload][8
- AbortMultipartUpload][9
- ListParts][10
- ListMultipartUploads][11
[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html [5]: docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html [6]: docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html [7]: docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html [8]: docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html [9]: docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html [10]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html [11]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
14566 14567 14568 14569 |
# File 'lib/aws-sdk-s3/client.rb', line 14566 def upload_part(params = {}, = {}) req = build_request(:upload_part, params) req.send_request() end |
#upload_part_copy(params = {}) ⇒ Types::UploadPartCopyOutput
Uploads a part by copying data from an existing object as data source. You specify the data source by adding the request header ‘x-amz-copy-source` in your request and a byte range by adding the request header `x-amz-copy-source-range` in your request.
For information about maximum and minimum part sizes and other multipart upload specifications, see [Multipart upload limits] in the *Amazon S3 User Guide*.
<note markdown=“1”> Instead of using an existing object as part data, you might use the
- UploadPart][2
-
action and provide data in your request.
</note>
You must initiate a multipart upload before you can upload any part. In response to your initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in your upload part request.
For more information about using the ‘UploadPartCopy` operation, see the following:
-
For conceptual information about multipart uploads, see [Uploading Objects Using Multipart Upload] in the *Amazon S3 User Guide*.
-
For information about permissions required to use the multipart upload API, see [Multipart Upload and Permissions] 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*.
-
For information about using server-side encryption with customer-provided encryption keys with the ‘UploadPartCopy` operation, see [CopyObject] and [UploadPart].
Note the following additional considerations about the request headers ‘x-amz-copy-source-if-match`, `x-amz-copy-source-if-none-match`, `x-amz-copy-source-if-unmodified-since`, and `x-amz-copy-source-if-modified-since`:
-
**Consideration 1** - If both of the ‘x-amz-copy-source-if-match` and `x-amz-copy-source-if-unmodified-since` headers are present in the request as follows:
‘x-amz-copy-source-if-match` condition evaluates to `true`, and;
‘x-amz-copy-source-if-unmodified-since` condition evaluates to `false`;
Amazon S3 returns ‘200 OK` and copies the data.
-
**Consideration 2** - If both of the ‘x-amz-copy-source-if-none-match` and `x-amz-copy-source-if-modified-since` headers are present in the request as follows:
‘x-amz-copy-source-if-none-match` condition evaluates to `false`, and;
‘x-amz-copy-source-if-modified-since` condition evaluates to `true`;
Amazon S3 returns ‘412 Precondition Failed` response code.
Versioning
If your bucket has versioning enabled, you could have multiple versions of the same object. By default, ‘x-amz-copy-source` identifies the current version of the object to copy. If the current version is a delete marker and you don’t specify a versionId in the ‘x-amz-copy-source`, Amazon S3 returns a 404 error, because the object does not exist. If you specify versionId in the `x-amz-copy-source` and the versionId is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify a delete marker as a version for the `x-amz-copy-source`.
You can optionally specify a specific version of the source object to copy by adding the ‘versionId` subresource as shown in the following example:
‘x-amz-copy-source: /bucket/object?versionId=version id`
**Special Errors**
-
*Code: NoSuchUpload*
-
*Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.*
-
*HTTP Status Code: 404 Not Found*
-
-
*Code: InvalidRequest*
-
*Cause: The specified copy source is not supported as a byte-range copy source.*
-
*HTTP Status Code: 400 Bad Request*
-
**Related Resources**
- CreateMultipartUpload][7
- UploadPart][2
- CompleteMultipartUpload][8
- AbortMultipartUpload][9
- ListParts][10
- ListMultipartUploads][11
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html [4]: docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html [5]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectOperations.html [6]: docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html [7]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html [8]: docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html [9]: docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html [10]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html [11]: docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
14955 14956 14957 14958 |
# File 'lib/aws-sdk-s3/client.rb', line 14955 def upload_part_copy(params = {}, = {}) req = build_request(:upload_part_copy, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
## Basic Usage
A waiter will call an API operation until:
-
It is successful
-
It enters a terminal state
-
It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
## Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
## Callbacks
You can be notified before each polling attempt and before each delay. If you throw ‘:success` or `:failure` from these callbacks, it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
## Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
## Valid Waiters
The following table lists the valid waiter names, the operations they call, and the default ‘:delay` and `:max_attempts` values.
| waiter_name | params | :delay | :max_attempts | | —————– | ——————– | ——– | ————- | | bucket_exists | #head_bucket | 5 | 20 | | bucket_not_exists | #head_bucket | 5 | 20 | | object_exists | #head_object | 5 | 20 | | object_not_exists | #head_object | 5 | 20 |
15452 15453 15454 15455 15456 |
# File 'lib/aws-sdk-s3/client.rb', line 15452 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
15460 15461 15462 |
# File 'lib/aws-sdk-s3/client.rb', line 15460 def waiter_names waiters.keys end |
#write_get_object_response(params = {}) ⇒ Struct
Passes transformed objects to a ‘GetObject` operation when using Object Lambda access points. For information about Object Lambda access points, see [Transforming objects with Object Lambda access points] in the *Amazon S3 User Guide*.
This operation supports metadata that can be returned by [GetObject], in addition to ‘RequestRoute`, `RequestToken`, `StatusCode`, `ErrorCode`, and `ErrorMessage`. The `GetObject` response metadata is supported so that the `WriteGetObjectResponse` caller, typically an Lambda function, can provide the same metadata when it internally invokes `GetObject`. When `WriteGetObjectResponse` is called by a customer-owned Lambda function, the metadata returned to the end user `GetObject` call might differ from what Amazon S3 would normally return.
You can include any number of metadata headers. When including a metadata header, it should be prefaced with ‘x-amz-meta`. For example, `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*.
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/olap-examples.html
15339 15340 15341 15342 |
# File 'lib/aws-sdk-s3/client.rb', line 15339 def write_get_object_response(params = {}, = {}) req = build_request(:write_get_object_response, params) req.send_request() end |